NVIDIA DeepStream SDK API Reference

9.2 Release
NvTrackerParamsTargetManager Class Reference

Detailed Description

Stores target-manager configuration parameters.

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

Inheritance diagram for NvTrackerParamsTargetManager:
Collaboration diagram for NvTrackerParamsTargetManager:

Public Member Functions

 NvTrackerParamsTargetManager ()
 Initialize target-manager parameters with default values. More...
 
 NvTrackerParamsTargetManager (const std::string &configFilePath, const std::string moduleName)
 Load target-manager parameters from a configuration module. More...
 
 NvTrackerParamsTargetManager (const YAML::Node &fn)
 Load target-manager parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Read target-manager parameters from a YAML node. More...
 
 NvTrackerParamsTargetManager ()
 Initialize target-manager parameters with default values. More...
 
 NvTrackerParamsTargetManager (const std::string &configFilePath, const std::string moduleName)
 Load target-manager parameters from a configuration module. More...
 
 NvTrackerParamsTargetManager (const YAML::Node &fn)
 Load target-manager parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Read target-manager 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_preserveStreamUpdateOrder
 Preserves input stream order when assigning target IDs for deterministic results. More...
 
bool m_enableBboxUnClipping
 Enables recovery of bounding boxes clipped by the image border. More...
 
bool m_outputVisibility
 Output visibility flag. More...
 
bool m_saveTerminatedTracks
 Enables saving terminated tracks for user reporting. More...
 
bool m_useVOTBasedTargetUpdate
 Enables VOT-based target updates. More...
 
std::string m_terminatedTrackFilename
 Terminated tracker file name. More...
 
std::string m_intermediateInfoFileName
 Base filename for intermediate detector and target dumps. More...
 
int m_maxTargetsPerStream
 The max # of targets to track per stream. More...
 
bool m_checkClassMatch
 If true, only objects of the same class are associated (sourced from BaseConfig:checkClassMatch). More...
 
float m_minDetectorConfidence
 If the confidence of a detected object is lower than this, it will not be considered as a new target. More...
 
float m_minTrackerConfidence
 Localization confidence threshold for the peak correlation response. More...
 
int m_probationAge
 If the target's age exceeds this, the target will be considered to be valid. More...
 
int m_maxShadowTrackingAge
 Max length of shadow tracking. If the shadowTrackingAge exceeds this limit, the tracker will be terminated. More...
 
int m_maxActiveShadowTrackingAge
 Override the shadow cap for tracks that were ever ACTIVE. More...
 
int m_earlyTerminationAge
 If the shadowTrackingAge reaches this threshold while in TENTATIVE period, the target will be terminated prematurely. More...
 
float m_minIouDiff4NewTarget
 If the IOU between the newly detected object and any of the existing targets is higher than this threshold, this newly detected object will be discarded. More...
 
float m_searchRegionPaddingScale
 Search-region padding scale relative to the target bounding box. More...
 
int m_maxTrajectoryBufferLength
 Maximum retained trajectory length before subsampling. More...
 
bool m_saveShadowTracks
 Output shadow track objects. More...
 
int m_debugParamInt0
 
int m_debugParamInt1
 
int m_debugParamInt2
 
float m_debugParamFloat0
 
float m_debugParamFloat1
 
float m_debugParamFloat2
 
uint m_maxTargetsToTrack
 Maximum number of targets across all streams. More...
 
NvMotDataTypes::Rect2f originalSrcImageBox
 Original video source image box. More...
 
NvMotDataTypes::Rect2f srcImageBox
 Tracker source image box. More...
 
bool m_isInit = false
 Indicates whether the parameters have been initialized. More...
 

Constructor & Destructor Documentation

◆ NvTrackerParamsTargetManager() [1/6]

NvTrackerParamsTargetManager::NvTrackerParamsTargetManager ( )

Initialize target-manager parameters with default values.

◆ NvTrackerParamsTargetManager() [2/6]

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

Load target-manager parameters from a configuration module.

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

◆ NvTrackerParamsTargetManager() [3/6]

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

Load target-manager parameters from a YAML node.

Parameters
[in]fnYAML node containing the target-manager configuration.

◆ NvTrackerParamsTargetManager() [4/6]

NvTrackerParamsTargetManager::NvTrackerParamsTargetManager ( )

Initialize target-manager parameters with default values.

◆ NvTrackerParamsTargetManager() [5/6]

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

Load target-manager parameters from a configuration module.

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

◆ NvTrackerParamsTargetManager() [6/6]

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

Load target-manager parameters from a YAML node.

Parameters
[in]fnYAML node containing the target-manager 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 NvTrackerParamsTargetManager::read ( const YAML::Node &  fn)
overridevirtual

Read target-manager parameters from a YAML node.

Parameters
[in]fnYAML node containing the target-manager configuration.

Implements NvTrackerParams.

◆ read() [2/2]

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

Read target-manager parameters from a YAML node.

Parameters
[in]fnYAML node containing the target-manager 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 NvTrackerParamsTargetManager::m_checkClassMatch

If true, only objects of the same class are associated (sourced from BaseConfig:checkClassMatch).

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

◆ m_debugParamFloat0

float NvTrackerParamsTargetManager::m_debugParamFloat0

◆ m_debugParamFloat1

float NvTrackerParamsTargetManager::m_debugParamFloat1

◆ m_debugParamFloat2

float NvTrackerParamsTargetManager::m_debugParamFloat2

◆ m_debugParamInt0

int NvTrackerParamsTargetManager::m_debugParamInt0

◆ m_debugParamInt1

int NvTrackerParamsTargetManager::m_debugParamInt1

◆ m_debugParamInt2

int NvTrackerParamsTargetManager::m_debugParamInt2

◆ m_debugVerboseLevel

int NvTrackerParamsTargetManager::m_debugVerboseLevel

Debug message verbose mode level.

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

◆ m_earlyTerminationAge

int NvTrackerParamsTargetManager::m_earlyTerminationAge

If the shadowTrackingAge reaches this threshold while in TENTATIVE period, the target will be terminated prematurely.

If this is zero/negative or larger than m_probationAge, then no early termination would be performed.

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

◆ m_enableBboxUnClipping

bool NvTrackerParamsTargetManager::m_enableBboxUnClipping

Enables recovery of bounding boxes clipped by the image border.

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

◆ m_intermediateInfoFileName

std::string NvTrackerParamsTargetManager::m_intermediateInfoFileName

Base filename for intermediate detector and target dumps.

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

◆ m_isInit

bool NvTrackerParamsTargetManager::m_isInit = false

Indicates whether the parameters have been initialized.

Prevents changing static params in dynamic updates.

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

◆ m_maxActiveShadowTrackingAge

int NvTrackerParamsTargetManager::m_maxActiveShadowTrackingAge

Override the shadow cap for tracks that were ever ACTIVE.

When greater than m_maxShadowTrackingAge, ACTIVE-lineage tracks survive longer.

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

◆ m_maxShadowTrackingAge

int NvTrackerParamsTargetManager::m_maxShadowTrackingAge

Max length of shadow tracking. If the shadowTrackingAge exceeds this limit, the tracker will be terminated.

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

◆ m_maxTargetsPerStream

int NvTrackerParamsTargetManager::m_maxTargetsPerStream

◆ m_maxTargetsToTrack

uint NvTrackerParamsTargetManager::m_maxTargetsToTrack

Maximum number of targets across all streams.

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

◆ m_maxTrajectoryBufferLength

int NvTrackerParamsTargetManager::m_maxTrajectoryBufferLength

Maximum retained trajectory length before subsampling.

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

◆ m_minDetectorConfidence

float NvTrackerParamsTargetManager::m_minDetectorConfidence

If the confidence of a detected object is lower than this, it will not be considered as a new target.

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

◆ m_minIouDiff4NewTarget

float NvTrackerParamsTargetManager::m_minIouDiff4NewTarget

If the IOU between the newly detected object and any of the existing targets is higher than this threshold, this newly detected object will be discarded.

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

◆ m_minTrackerConfidence

float NvTrackerParamsTargetManager::m_minTrackerConfidence

Localization confidence threshold for the peak correlation response.

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

◆ m_outputVisibility

bool NvTrackerParamsTargetManager::m_outputVisibility

◆ m_preserveStreamUpdateOrder

bool NvTrackerParamsTargetManager::m_preserveStreamUpdateOrder

Preserves input stream order when assigning target IDs for deterministic results.

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

◆ m_probationAge

int NvTrackerParamsTargetManager::m_probationAge

If the target's age exceeds this, the target will be considered to be valid.

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

◆ m_saveShadowTracks

bool NvTrackerParamsTargetManager::m_saveShadowTracks

◆ m_saveTerminatedTracks

bool NvTrackerParamsTargetManager::m_saveTerminatedTracks

Enables saving terminated tracks for user reporting.

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

Referenced by NvTrackedObjectManager::clearOutputTerminatedTracks().

◆ m_searchRegionPaddingScale

float NvTrackerParamsTargetManager::m_searchRegionPaddingScale

Search-region padding scale relative to the target bounding box.

A value of three produces a region four times the target bounding-box size in each dimension.

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

◆ m_terminatedTrackFilename

std::string NvTrackerParamsTargetManager::m_terminatedTrackFilename

◆ m_useVOTBasedTargetUpdate

bool NvTrackerParamsTargetManager::m_useVOTBasedTargetUpdate

Enables VOT-based target updates.

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

◆ originalSrcImageBox

NvMotDataTypes::Rect2f NvTrackerParamsTargetManager::originalSrcImageBox

Original video source image box.

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

◆ srcImageBox

NvMotDataTypes::Rect2f NvTrackerParamsTargetManager::srcImageBox

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