NVIDIA DeepStream SDK API Reference

9.2 Release
SimpleEstimatorParams2 Class Reference

Detailed Description

Config params for the simple state estimator.

Definition at line 28 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

Inheritance diagram for SimpleEstimatorParams2:
Collaboration diagram for SimpleEstimatorParams2:

Public Member Functions

 SimpleEstimatorParams2 ()
 Initialize simple-estimator parameters with default values. More...
 
 SimpleEstimatorParams2 (const std::string &configFilePath, const std::string moduleName)
 Initialize simple-estimator parameters from a configuration module. More...
 
 SimpleEstimatorParams2 (const YAML::Node &fn)
 Initialize simple-estimator parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Update simple-estimator parameters from a YAML node. More...
 
 SimpleEstimatorParams2 ()
 Initialize simple-estimator parameters with default values. More...
 
 SimpleEstimatorParams2 (const std::string &configFilePath, const std::string moduleName)
 Initialize simple-estimator parameters from a configuration module. More...
 
 SimpleEstimatorParams2 (const YAML::Node &fn)
 Initialize simple-estimator parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Update simple-estimator parameters from a YAML node. More...
 

Static Public Member Functions

static std::string resolvePathRelativeToConfig (const std::string &configFilePath, const std::string &filePath)
 Resolve a configured path relative to the tracker configuration file. More...
 
static std::string resolvePathRelativeToConfig (const std::string &configFilePath, const std::string &filePath)
 Resolve a configured path relative to the tracker configuration file. More...
 
static const YAML::Node getConfigRoot (const std::string &configFilePath, const bool printMessage=false)
 Load the root YAML node from a tracker configuration file. More...
 
static const YAML::Node getConfigRoot (const std::string &configFilePath, const bool printMessage=false)
 Load the root YAML node from a tracker configuration file. More...
 

Data Fields

int m_debugVerboseLevel
 Controls debug message verbosity. More...
 
STATE_ESTIMATOR_TYPES m_stateEstimatorType
 Selects the state-estimator type. More...
 
float m_measurementNoiseVar4Detector
 Specifies measurement-noise variance for detector observations. More...
 
float m_measurementNoiseVar4Tracker
 Specifies measurement-noise variance for tracker localization. More...
 
float m_measurementNoiseVar4Aspc
 Specifies measurement-noise variance for aspect ratio. More...
 
float m_processNoiseVar4Loc
 Specifies process-noise variance for the bounding-box center. More...
 
float m_processNoiseVar4Size
 Specifies process-noise variance for bounding-box size. More...
 
float m_processNoiseVar4Vel
 Specifies process-noise variance for velocity. More...
 
float m_processNoiseVar4Aspc
 Specifies process-noise variance for aspect ratio. More...
 
float m_processNoiseVar4AspcVel
 Specifies process-noise variance for the aspect-ratio change rate. More...
 
float m_noiseWeightVar4Loc
 Specifies the noise-variance weight for the bounding-box center. More...
 
float m_noiseWeightVar4Vel
 Noise variance weight for velocity. More...
 
float m_highUncertainty
 Specifies initial uncertainty for faster adaptation. More...
 
bool m_useAspectRatio
 Indicates whether the estimator uses aspect ratio instead of width. More...
 

Constructor & Destructor Documentation

◆ SimpleEstimatorParams2() [1/6]

SimpleEstimatorParams2::SimpleEstimatorParams2 ( )

Initialize simple-estimator parameters with default values.

◆ SimpleEstimatorParams2() [2/6]

SimpleEstimatorParams2::SimpleEstimatorParams2 ( const std::string &  configFilePath,
const std::string  moduleName 
)

Initialize simple-estimator parameters from a configuration module.

Parameters
[in]configFilePathThe path to a configuration file.
[in]moduleNameThe configuration module name.

◆ SimpleEstimatorParams2() [3/6]

SimpleEstimatorParams2::SimpleEstimatorParams2 ( const YAML::Node &  fn)

Initialize simple-estimator parameters from a YAML node.

Parameters
[in]fnParsed YAML structure of config to update.

◆ SimpleEstimatorParams2() [4/6]

SimpleEstimatorParams2::SimpleEstimatorParams2 ( )

Initialize simple-estimator parameters with default values.

◆ SimpleEstimatorParams2() [5/6]

SimpleEstimatorParams2::SimpleEstimatorParams2 ( const std::string &  configFilePath,
const std::string  moduleName 
)

Initialize simple-estimator parameters from a configuration module.

Parameters
[in]configFilePathThe path to a configuration file.
[in]moduleNameThe configuration module name.

◆ SimpleEstimatorParams2() [6/6]

SimpleEstimatorParams2::SimpleEstimatorParams2 ( const YAML::Node &  fn)

Initialize simple-estimator parameters from a YAML node.

Parameters
[in]fnParsed YAML structure of config to update.

Member Function Documentation

◆ getConfigRoot() [1/2]

static const YAML::Node NvTrackerParams::getConfigRoot ( const std::string &  configFilePath,
const bool  printMessage = false 
)
inlinestaticinherited

◆ getConfigRoot() [2/2]

static const YAML::Node NvTrackerParams::getConfigRoot ( const std::string &  configFilePath,
const bool  printMessage = false 
)
inlinestaticinherited

Load the root YAML node from a tracker configuration file.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]printMessageEnables warning output when the configuration cannot be loaded.
Returns
Loaded YAML root node, or an empty node when loading fails.

Definition at line 121 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp.

References CLOG.

◆ read() [1/2]

void SimpleEstimatorParams2::read ( const YAML::Node &  fn)
overridevirtual

Update simple-estimator parameters from a YAML node.

Parameters
[in]fnParsed YAML structure of config to update.

Implements NvTrackerParams.

◆ read() [2/2]

void SimpleEstimatorParams2::read ( const YAML::Node &  fn)
overridevirtual

Update simple-estimator parameters from a YAML node.

Parameters
[in]fnParsed YAML structure of config to update.

Implements NvTrackerParams.

◆ resolvePathRelativeToConfig() [1/2]

static std::string NvTrackerParams::resolvePathRelativeToConfig ( const std::string &  configFilePath,
const std::string &  filePath 
)
inlinestaticinherited

Resolve a configured path relative to the tracker configuration file.

Existing paths are canonicalized, while nonexistent relative paths remain joined to the configuration directory.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]filePathAbsolute or configuration-relative path to resolve.
Returns
Resolved path, or the original path when the configuration path cannot be resolved.

Definition at line 55 of file sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp.

Referenced by CommunicatorParams::CommunicatorParams(), and MqttCommunicatorParams::MqttCommunicatorParams().

◆ resolvePathRelativeToConfig() [2/2]

static std::string NvTrackerParams::resolvePathRelativeToConfig ( const std::string &  configFilePath,
const std::string &  filePath 
)
inlinestaticinherited

Resolve a configured path relative to the tracker configuration file.

Existing paths are canonicalized, while nonexistent relative paths remain joined to the configuration directory.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]filePathAbsolute or configuration-relative path to resolve.
Returns
Resolved path, or the original path when the configuration path cannot be resolved.

Definition at line 55 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp.

Field Documentation

◆ m_debugVerboseLevel

int SimpleEstimatorParams2::m_debugVerboseLevel

Controls debug message verbosity.

Definition at line 53 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_highUncertainty

float SimpleEstimatorParams2::m_highUncertainty

Specifies initial uncertainty for faster adaptation.

Definition at line 67 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_measurementNoiseVar4Aspc

float SimpleEstimatorParams2::m_measurementNoiseVar4Aspc

Specifies measurement-noise variance for aspect ratio.

Definition at line 59 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_measurementNoiseVar4Detector

float SimpleEstimatorParams2::m_measurementNoiseVar4Detector

Specifies measurement-noise variance for detector observations.

Definition at line 57 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_measurementNoiseVar4Tracker

float SimpleEstimatorParams2::m_measurementNoiseVar4Tracker

Specifies measurement-noise variance for tracker localization.

Definition at line 58 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_noiseWeightVar4Loc

float SimpleEstimatorParams2::m_noiseWeightVar4Loc

Specifies the noise-variance weight for the bounding-box center.

Definition at line 65 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_noiseWeightVar4Vel

float SimpleEstimatorParams2::m_noiseWeightVar4Vel

Noise variance weight for velocity.

Definition at line 66 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_processNoiseVar4Aspc

float SimpleEstimatorParams2::m_processNoiseVar4Aspc

Specifies process-noise variance for aspect ratio.

Definition at line 63 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_processNoiseVar4AspcVel

float SimpleEstimatorParams2::m_processNoiseVar4AspcVel

Specifies process-noise variance for the aspect-ratio change rate.

Definition at line 64 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_processNoiseVar4Loc

float SimpleEstimatorParams2::m_processNoiseVar4Loc

Specifies process-noise variance for the bounding-box center.

Definition at line 60 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_processNoiseVar4Size

float SimpleEstimatorParams2::m_processNoiseVar4Size

Specifies process-noise variance for bounding-box size.

Definition at line 61 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_processNoiseVar4Vel

float SimpleEstimatorParams2::m_processNoiseVar4Vel

Specifies process-noise variance for velocity.

Definition at line 62 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

◆ m_stateEstimatorType

STATE_ESTIMATOR_TYPES SimpleEstimatorParams2::m_stateEstimatorType

◆ m_useAspectRatio

bool SimpleEstimatorParams2::m_useAspectRatio

Indicates whether the estimator uses aspect ratio instead of width.

Definition at line 68 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/SimpleEstimator2.hpp.

Referenced by SimpleEstimator2::useAspectRatio().


The documentation for this class was generated from the following file: