NVIDIA DeepStream SDK API Reference

9.2 Release
NvTrackerParamsBase Class Reference

Detailed Description

Stores configuration parameters used by the base tracker.

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

Inheritance diagram for NvTrackerParamsBase:
Collaboration diagram for NvTrackerParamsBase:

Public Member Functions

 NvTrackerParamsBase ()
 Initialize the base tracker parameters with default values. More...
 
 NvTrackerParamsBase (const std::string &configFilePath, const std::string moduleName)
 Load the base tracker parameters from a configuration module. More...
 
 NvTrackerParamsBase (const YAML::Node &fn)
 Load the base tracker parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Read base tracker parameters from a YAML node. More...
 
 NvTrackerParamsBase ()
 Initialize the base tracker parameters with default values. More...
 
 NvTrackerParamsBase (const std::string &configFilePath, const std::string moduleName)
 Load the base tracker parameters from a configuration module. More...
 
 NvTrackerParamsBase (const YAML::Node &fn)
 Load the base tracker parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Read base tracker 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
 Debug message verbose mode level. More...
 
bool m_isInit = false
 Indicates whether the parameters have been initialized. More...
 
bool m_checkClassMatch
 Restricts association to objects of the same class when enabled. More...
 
float m_minDetectorConfidence
 Minimum detector confidence required for tracking. More...
 
bool m_useBatchNumForFrameId
 Selects the batch counter instead of the per-stream frame number for cross-stream synchronization. More...
 

Constructor & Destructor Documentation

◆ NvTrackerParamsBase() [1/6]

NvTrackerParamsBase::NvTrackerParamsBase ( )

Initialize the base tracker parameters with default values.

◆ NvTrackerParamsBase() [2/6]

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

Load the base tracker parameters from a configuration module.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]moduleNameName of the configuration module to load.

◆ NvTrackerParamsBase() [3/6]

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

Load the base tracker parameters from a YAML node.

Parameters
[in]fnYAML node containing the base tracker configuration.

◆ NvTrackerParamsBase() [4/6]

NvTrackerParamsBase::NvTrackerParamsBase ( )

Initialize the base tracker parameters with default values.

◆ NvTrackerParamsBase() [5/6]

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

Load the base tracker parameters from a configuration module.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]moduleNameName of the configuration module to load.

◆ NvTrackerParamsBase() [6/6]

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

Load the base tracker parameters from a YAML node.

Parameters
[in]fnYAML node containing the base tracker configuration.

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 NvTrackerParamsBase::read ( const YAML::Node &  fn)
overridevirtual

Read base tracker parameters from a YAML node.

Parameters
[in]fnYAML node containing the base tracker configuration.

Implements NvTrackerParams.

◆ read() [2/2]

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

Read base tracker parameters from a YAML node.

Parameters
[in]fnYAML node containing the base tracker configuration.

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_checkClassMatch

bool NvTrackerParamsBase::m_checkClassMatch

Restricts association to objects of the same class when enabled.

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

◆ m_debugVerboseLevel

int NvTrackerParamsBase::m_debugVerboseLevel

Debug message verbose mode level.

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

◆ m_isInit

bool NvTrackerParamsBase::m_isInit = false

Indicates whether the parameters have been initialized.

Prevents changing static params in dynamic updates.

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

◆ m_minDetectorConfidence

float NvTrackerParamsBase::m_minDetectorConfidence

Minimum detector confidence required for tracking.

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

◆ m_useBatchNumForFrameId

bool NvTrackerParamsBase::m_useBatchNumForFrameId

Selects the batch counter instead of the per-stream frame number for cross-stream synchronization.

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


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