Visual Servoing Platform  version 3.6.1 under development (2024-11-21)
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
SoftwareArguments Struct Reference

Public Member Functions

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

Public Attributes

bool m_useDisplay
 
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
 
bool m_gradientOutsideClass
 
bool m_useVpImageFilterCanny
 
bool m_saveEdgeList
 
int m_gaussianKernelSize
 
int m_apertureSize
 
vpImageFilter::vpCannyFilteringAndGradientType m_filteringType
 
float m_gaussianStdev
 
float m_lowerThresh
 
float m_upperThresh
 
float m_lowerThreshRatio
 
float m_upperThreshRatio
 
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.cpp, and tutorial-pf.cpp.

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

Constructor & Destructor Documentation

◆ SoftwareArguments() [1/4]

SoftwareArguments::SoftwareArguments ( )
inline

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

◆ SoftwareArguments() [2/4]

SoftwareArguments::SoftwareArguments ( )
inline

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

◆ SoftwareArguments() [3/4]

SoftwareArguments::SoftwareArguments ( )
inline

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

◆ SoftwareArguments() [4/4]

SoftwareArguments::SoftwareArguments ( )
inline

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

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 619 of file pf-nonlinear-complex-example.cpp.

◆ parseArgs() [2/3]

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

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

References vpMath::rad().

◆ parseArgs() [3/3]

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

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

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.

◆ 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 603 of file pf-nonlinear-complex-example.cpp.

◆ 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 347 of file pf-nonlinear-example.cpp.

◆ 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 348 of file pf-nonlinear-example.cpp.

◆ 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 601 of file pf-nonlinear-complex-example.cpp.

◆ 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 602 of file pf-nonlinear-complex-example.cpp.

◆ 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.

◆ m_apertureSize

int SoftwareArguments::m_apertureSize
Examples
tutorial-canny.cpp.

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

◆ m_backend

vpImageFilter::vpCannyBackendType SoftwareArguments::m_backend
Examples
tutorial-canny.cpp.

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

◆ m_dt

double SoftwareArguments::m_dt
Examples
pf-nonlinear-example.cpp.

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

◆ m_filteringType

vpImageFilter::vpCannyFilteringAndGradientType SoftwareArguments::m_filteringType
Examples
tutorial-canny.cpp.

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

◆ m_gaussianKernelSize

int SoftwareArguments::m_gaussianKernelSize
Examples
tutorial-canny.cpp.

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

◆ m_gaussianStdev

float SoftwareArguments::m_gaussianStdev
Examples
tutorial-canny.cpp.

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

◆ m_gradientOutsideClass

bool SoftwareArguments::m_gradientOutsideClass
Examples
tutorial-canny.cpp.

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

◆ m_gt_vX_init

double SoftwareArguments::m_gt_vX_init
Examples
pf-nonlinear-example.cpp.

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

◆ m_gt_vY_init

double SoftwareArguments::m_gt_vY_init
Examples
pf-nonlinear-example.cpp.

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

◆ m_gt_X_init

double SoftwareArguments::m_gt_X_init
Examples
pf-nonlinear-example.cpp.

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

◆ m_gt_Y_init

double SoftwareArguments::m_gt_Y_init
Examples
pf-nonlinear-example.cpp.

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

◆ m_img

std::string SoftwareArguments::m_img
Examples
tutorial-canny.cpp.

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

◆ m_lowerThresh

float SoftwareArguments::m_lowerThresh
Examples
tutorial-canny.cpp.

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

◆ m_lowerThreshRatio

float SoftwareArguments::m_lowerThreshRatio
Examples
tutorial-canny.cpp.

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

◆ 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 600 of file pf-nonlinear-complex-example.cpp.

◆ 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 599 of file pf-nonlinear-complex-example.cpp.

◆ m_nbSteps

unsigned int SoftwareArguments::m_nbSteps

Number of steps for the main loop.

Examples
pf-nonlinear-example.cpp.

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

◆ m_nbStepsWarmUp

unsigned int SoftwareArguments::m_nbStepsWarmUp

Number of steps for the warmup phase.

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

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

◆ 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 605 of file pf-nonlinear-complex-example.cpp.

◆ m_radar_X

double SoftwareArguments::m_radar_X
Examples
pf-nonlinear-example.cpp.

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

◆ m_radar_Y

double SoftwareArguments::m_radar_Y
Examples
pf-nonlinear-example.cpp.

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

◆ m_saveEdgeList

bool SoftwareArguments::m_saveEdgeList
Examples
tutorial-canny.cpp.

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

◆ 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 604 of file pf-nonlinear-complex-example.cpp.

◆ m_sigmaElevAngle

double SoftwareArguments::m_sigmaElevAngle
Examples
pf-nonlinear-example.cpp.

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

◆ m_sigmaRange

double SoftwareArguments::m_sigmaRange
Examples
pf-nonlinear-example.cpp.

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

◆ m_stdevAircraftVelocity

double SoftwareArguments::m_stdevAircraftVelocity
Examples
pf-nonlinear-example.cpp.

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

◆ m_upperThresh

float SoftwareArguments::m_upperThresh
Examples
tutorial-canny.cpp.

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

◆ m_upperThreshRatio

float SoftwareArguments::m_upperThreshRatio
Examples
tutorial-canny.cpp.

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

◆ 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, and pf-nonlinear-example.cpp.

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

◆ m_useVpImageFilterCanny

bool SoftwareArguments::m_useVpImageFilterCanny
Examples
tutorial-canny.cpp.

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

◆ SOFTWARE_CONTINUE

static 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.