Public Member Functions
	SoftwareArguments ()
int	parseArgs (const int argc, const char *argv[])
	SoftwareArguments ()
int	parseArgs (const int argc, const char *argv[])
	SoftwareArguments ()
	SoftwareArguments ()
	SoftwareArguments ()
int	parseArgs (const int argc, const char *argv[])

Public Attributes
bool	m_useDisplay
bool	m_useUserInteraction
unsigned int	m_nbStepsWarmUp
unsigned int	m_N
double	m_maxDistanceForLikelihood
double	m_ampliMaxX
double	m_ampliMaxY
double	m_ampliMaxTheta
long	m_seedPF
int	m_nbThreads
unsigned int	m_nbSteps
double	m_dt
double	m_sigmaRange
double	m_sigmaElevAngle
double	m_stdevAircraftVelocity
double	m_radar_X
double	m_radar_Y
double	m_gt_X_init
double	m_gt_Y_init
double	m_gt_vX_init
double	m_gt_vY_init
double	m_ampliMaxVx
double	m_ampliMaxVy
std::string	m_img
int	m_gaussianKernelSize
float	m_gaussianStdev
float	m_lowerThresh
float	m_upperThresh
float	m_lowerThreshRatio
float	m_upperThreshRatio
vpImageFilter::vpCannyFilteringAndGradientType	m_filteringType
bool	m_saveImages
bool	m_useMask
int	m_nbThread
bool	m_gradientOutsideClass
bool	m_useVpImageFilterCanny
bool	m_saveEdgeList
int	m_apertureSize
vpImageFilter::vpCannyBackendType	m_backend
double	m_ampliMaxZ
double	m_ampliMaxOmega

Static Public Attributes
static const int	SOFTWARE_CONTINUE = 42

Detailed Description

[Markers_class]

[CLI]

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, tutorial-canny-hsv.cpp, tutorial-canny.cpp, and tutorial-pf.cpp.

Definition at line 592 of file pf-nonlinear-complex-example.cpp.

Constructor & Destructor Documentation

◆ SoftwareArguments() [1/5]

SoftwareArguments::SoftwareArguments ( )

inline

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, tutorial-canny-hsv.cpp, tutorial-canny.cpp, and tutorial-pf.cpp.

Definition at line 608 of file pf-nonlinear-complex-example.cpp.

References m_ampliMaxTheta, m_ampliMaxX, m_ampliMaxY, m_maxDistanceForLikelihood, m_N, m_nbStepsWarmUp, m_nbThreads, m_seedPF, m_useDisplay, and m_useUserInteraction.

Referenced by parseArgs().

◆ SoftwareArguments() [2/5]

SoftwareArguments::SoftwareArguments ( )

inline

Definition at line 353 of file pf-nonlinear-example.cpp.

References m_ampliMaxVx, m_ampliMaxVy, m_ampliMaxX, m_ampliMaxY, m_dt, m_gt_vX_init, m_gt_vY_init, m_gt_X_init, m_gt_Y_init, m_maxDistanceForLikelihood, m_N, m_nbSteps, m_nbStepsWarmUp, m_nbThreads, m_radar_X, m_radar_Y, m_seedPF, m_sigmaElevAngle, m_sigmaRange, m_stdevAircraftVelocity, m_useDisplay, and m_useUserInteraction.

◆ SoftwareArguments() [3/5]

SoftwareArguments::SoftwareArguments ( )

inline

Definition at line 95 of file tutorial-canny-hsv.cpp.

References m_filteringType, m_gaussianKernelSize, m_gaussianStdev, m_img, m_lowerThresh, m_lowerThreshRatio, m_nbThread, m_saveImages, m_upperThresh, m_upperThreshRatio, m_useDisplay, and m_useMask.

◆ SoftwareArguments() [4/5]

SoftwareArguments::SoftwareArguments ( )

inline

Definition at line 67 of file tutorial-canny.cpp.

References m_apertureSize, m_backend, m_filteringType, m_gaussianKernelSize, m_gaussianStdev, m_gradientOutsideClass, m_img, m_lowerThresh, m_lowerThreshRatio, m_nbThread, m_saveEdgeList, m_upperThresh, m_upperThreshRatio, and m_useVpImageFilterCanny.

◆ SoftwareArguments() [5/5]

SoftwareArguments::SoftwareArguments ( )

inline

Definition at line 370 of file tutorial-pf.cpp.

References m_ampliMaxOmega, m_ampliMaxX, m_ampliMaxY, m_ampliMaxZ, m_maxDistanceForLikelihood, m_N, m_nbSteps, m_nbStepsWarmUp, m_nbThreads, m_seedPF, and m_useDisplay.

Member Function Documentation

◆ parseArgs() [1/3]

int SoftwareArguments::parseArgs	(	const int	argc,
		const char *	argv[] )

inline

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 621 of file pf-nonlinear-complex-example.cpp.

References m_ampliMaxTheta, m_ampliMaxX, m_ampliMaxY, m_maxDistanceForLikelihood, m_N, m_nbStepsWarmUp, m_nbThreads, m_seedPF, m_useDisplay, m_useUserInteraction, SOFTWARE_CONTINUE, and SoftwareArguments().

◆ parseArgs() [2/3]

int SoftwareArguments::parseArgs	(	const int	argc,
		const char *	argv[] )

inline

Definition at line 378 of file pf-nonlinear-example.cpp.

References m_ampliMaxVx, m_ampliMaxVy, m_ampliMaxX, m_ampliMaxY, m_dt, m_gt_vX_init, m_gt_vY_init, m_gt_X_init, m_gt_Y_init, m_maxDistanceForLikelihood, m_N, m_nbSteps, m_nbStepsWarmUp, m_nbThreads, m_radar_X, m_radar_Y, m_seedPF, m_sigmaElevAngle, m_sigmaRange, m_stdevAircraftVelocity, m_useDisplay, m_useUserInteraction, vpMath::rad(), SOFTWARE_CONTINUE, and SoftwareArguments().

◆ parseArgs() [3/3]

int SoftwareArguments::parseArgs	(	const int	argc,
		const char *	argv[] )

inline

Definition at line 384 of file tutorial-pf.cpp.

References m_ampliMaxOmega, m_ampliMaxX, m_ampliMaxY, m_ampliMaxZ, m_maxDistanceForLikelihood, m_N, m_nbSteps, m_nbStepsWarmUp, m_nbThreads, m_seedPF, m_useDisplay, SOFTWARE_CONTINUE, and SoftwareArguments().

Member Data Documentation

◆ m_ampliMaxOmega

double SoftwareArguments::m_ampliMaxOmega

Amplitude max of the noise for the state component corresponding to the pulsation.

Examples: tutorial-pf.cpp.

Definition at line 366 of file tutorial-pf.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_ampliMaxTheta

double SoftwareArguments::m_ampliMaxTheta

Amplitude max of the noise for the state component corresponding to the heading.

Examples: pf-nonlinear-complex-example.cpp.

Definition at line 604 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_ampliMaxVx

double SoftwareArguments::m_ampliMaxVx

Amplitude max of the noise for the state component corresponding to the velocity along the X-axis.

Examples: pf-nonlinear-example.cpp.

Definition at line 348 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_ampliMaxVy

double SoftwareArguments::m_ampliMaxVy

Amplitude max of the noise for the state component corresponding to the velocity along the Y-axis.

Examples: pf-nonlinear-example.cpp.

Definition at line 349 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_ampliMaxX

double SoftwareArguments::m_ampliMaxX

Amplitude max of the noise for the state component corresponding to the X coordinate.

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 602 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_ampliMaxY

double SoftwareArguments::m_ampliMaxY

Amplitude max of the noise for the state component corresponding to the Y coordinate.

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 603 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_ampliMaxZ

double SoftwareArguments::m_ampliMaxZ

Amplitude max of the noise for the state component corresponding to the Z coordinate.

Examples: tutorial-pf.cpp.

Definition at line 365 of file tutorial-pf.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_apertureSize

int SoftwareArguments::m_apertureSize

Examples: tutorial-canny.cpp.

Definition at line 57 of file tutorial-canny.cpp.

Referenced by SoftwareArguments().

◆ m_backend

vpImageFilter::vpCannyBackendType SoftwareArguments::m_backend

Examples: tutorial-canny.cpp.

Definition at line 64 of file tutorial-canny.cpp.

Referenced by SoftwareArguments().

◆ m_dt

double SoftwareArguments::m_dt

Examples: pf-nonlinear-example.cpp.

Definition at line 333 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_filteringType

vpImageFilter::vpCannyFilteringAndGradientType SoftwareArguments::m_filteringType

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 89 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_gaussianKernelSize

int SoftwareArguments::m_gaussianKernelSize

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 83 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_gaussianStdev

float SoftwareArguments::m_gaussianStdev

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 84 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_gradientOutsideClass

bool SoftwareArguments::m_gradientOutsideClass

Examples: tutorial-canny.cpp.

Definition at line 53 of file tutorial-canny.cpp.

Referenced by SoftwareArguments().

◆ m_gt_vX_init

double SoftwareArguments::m_gt_vX_init

Examples: pf-nonlinear-example.cpp.

Definition at line 341 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_gt_vY_init

double SoftwareArguments::m_gt_vY_init

Examples: pf-nonlinear-example.cpp.

Definition at line 342 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_gt_X_init

double SoftwareArguments::m_gt_X_init

Examples: pf-nonlinear-example.cpp.

Definition at line 339 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_gt_Y_init

double SoftwareArguments::m_gt_Y_init

Examples: pf-nonlinear-example.cpp.

Definition at line 340 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_img

std::string SoftwareArguments::m_img

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 82 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_lowerThresh

float SoftwareArguments::m_lowerThresh

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 85 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_lowerThreshRatio

float SoftwareArguments::m_lowerThreshRatio

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 87 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_maxDistanceForLikelihood

double SoftwareArguments::m_maxDistanceForLikelihood

The maximum allowed distance between a particle and the measurement, leading to a likelihood equal to 0..

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 601 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_N

unsigned int SoftwareArguments::m_N

The number of particles.

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 600 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_nbSteps

unsigned int SoftwareArguments::m_nbSteps

Number of steps for the main loop.

Examples: pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 332 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_nbStepsWarmUp

unsigned int SoftwareArguments::m_nbStepsWarmUp

Number of steps for the warmup phase.

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 598 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_nbThread

int SoftwareArguments::m_nbThread

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 93 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_nbThreads

int SoftwareArguments::m_nbThreads

Number of thread to use in the Particle Filter.

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 606 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_radar_X

double SoftwareArguments::m_radar_X

Examples: pf-nonlinear-example.cpp.

Definition at line 337 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_radar_Y

double SoftwareArguments::m_radar_Y

Examples: pf-nonlinear-example.cpp.

Definition at line 338 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_saveEdgeList

bool SoftwareArguments::m_saveEdgeList

Examples: tutorial-canny.cpp.

Definition at line 55 of file tutorial-canny.cpp.

Referenced by SoftwareArguments().

◆ m_saveImages

bool SoftwareArguments::m_saveImages

Examples: tutorial-canny-hsv.cpp.

Definition at line 90 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_seedPF

long SoftwareArguments::m_seedPF

Seed for the random generators of the PF.

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 605 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_sigmaElevAngle

double SoftwareArguments::m_sigmaElevAngle

Examples: pf-nonlinear-example.cpp.

Definition at line 335 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_sigmaRange

double SoftwareArguments::m_sigmaRange

Examples: pf-nonlinear-example.cpp.

Definition at line 334 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_stdevAircraftVelocity

double SoftwareArguments::m_stdevAircraftVelocity

Examples: pf-nonlinear-example.cpp.

Definition at line 336 of file pf-nonlinear-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_upperThresh

float SoftwareArguments::m_upperThresh

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 86 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_upperThreshRatio

float SoftwareArguments::m_upperThreshRatio

Examples: tutorial-canny-hsv.cpp, and tutorial-canny.cpp.

Definition at line 88 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_useDisplay

bool SoftwareArguments::m_useDisplay

If true, activate the plot and the renderer if VISP_HAVE_DISPLAY is defined.

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, tutorial-canny-hsv.cpp, and tutorial-pf.cpp.

Definition at line 596 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_useMask

bool SoftwareArguments::m_useMask

If true, use a predifined boolean mask that determines which pixels should be considered and which should be ignored.

Examples: tutorial-canny-hsv.cpp.

Definition at line 92 of file tutorial-canny-hsv.cpp.

Referenced by SoftwareArguments().

◆ m_useUserInteraction

bool SoftwareArguments::m_useUserInteraction

If true, program will require some user inputs.

Examples: pf-nonlinear-complex-example.cpp, and pf-nonlinear-example.cpp.

Definition at line 597 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs(), and SoftwareArguments().

◆ m_useVpImageFilterCanny

bool SoftwareArguments::m_useVpImageFilterCanny

Examples: tutorial-canny.cpp.

Definition at line 54 of file tutorial-canny.cpp.

Referenced by SoftwareArguments().

◆ SOFTWARE_CONTINUE

const int SoftwareArguments::SOFTWARE_CONTINUE = 42

static

Examples: pf-nonlinear-complex-example.cpp, pf-nonlinear-example.cpp, and tutorial-pf.cpp.

Definition at line 595 of file pf-nonlinear-complex-example.cpp.

Referenced by parseArgs().

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SoftwareArguments() [1/5]

◆ SoftwareArguments() [2/5]

◆ SoftwareArguments() [3/5]

◆ SoftwareArguments() [4/5]

◆ SoftwareArguments() [5/5]

Member Function Documentation

◆ parseArgs() [1/3]

◆ parseArgs() [2/3]

◆ parseArgs() [3/3]

Member Data Documentation

◆ m_ampliMaxOmega

◆ m_ampliMaxTheta

◆ m_ampliMaxVx

◆ m_ampliMaxVy

◆ m_ampliMaxX

◆ m_ampliMaxY

◆ m_ampliMaxZ

◆ m_apertureSize

◆ m_backend

◆ m_dt

◆ m_filteringType

◆ m_gaussianKernelSize

◆ m_gaussianStdev

◆ m_gradientOutsideClass

◆ m_gt_vX_init

◆ m_gt_vY_init

◆ m_gt_X_init

◆ m_gt_Y_init

◆ m_img

◆ m_lowerThresh

◆ m_lowerThreshRatio

◆ m_maxDistanceForLikelihood

◆ m_N

◆ m_nbSteps

◆ m_nbStepsWarmUp

◆ m_nbThread

◆ m_nbThreads

◆ m_radar_X

◆ m_radar_Y

◆ m_saveEdgeList

◆ m_saveImages

◆ m_seedPF

◆ m_sigmaElevAngle

◆ m_sigmaRange

◆ m_stdevAircraftVelocity

◆ m_upperThresh

◆ m_upperThreshRatio

◆ m_useDisplay

◆ m_useMask

◆ m_useUserInteraction

◆ m_useVpImageFilterCanny

◆ SOFTWARE_CONTINUE