Detailed Description

Config params for the custom distance function for the data association, including the min criteria and weights for each score factor.

Definition at line 39 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

Inheritance diagram for NvTrackerParamsAssoc:

[legend]

Collaboration diagram for NvTrackerParamsAssoc:

[legend]

Public Types
enum	MATCHING_SCORE_SET_STATUS { MIN_VISUAL = 1 << 0, WEIGHT_VISUAL = 1 << 1, MIN_REID = 1 << 2, WEIGHT_REID = 1 << 3, MIN_VISUAL = 1 << 0, WEIGHT_VISUAL = 1 << 1, MIN_REID = 1 << 2, WEIGHT_REID = 1 << 3 }

enum	MATCHING_SCORE_SET_STATUS { MIN_VISUAL = 1 << 0, WEIGHT_VISUAL = 1 << 1, MIN_REID = 1 << 2, WEIGHT_REID = 1 << 3, MIN_VISUAL = 1 << 0, WEIGHT_VISUAL = 1 << 1, MIN_REID = 1 << 2, WEIGHT_REID = 1 << 3 }

Public Member Functions
	NvTrackerParamsAssoc ()
	Initialize association parameters with default values. More...

	NvTrackerParamsAssoc (const std::string &configFilePath, const std::string moduleName)
	Initialize association parameters from a configuration module. More...

	NvTrackerParamsAssoc (const YAML::Node &fn)
	Initialize association parameters from a YAML node. More...

void	read (const YAML::Node &fn) override
	Update association parameters from a YAML node. More...

	NvTrackerParamsAssoc ()
	Initialize association parameters with default values. More...

	NvTrackerParamsAssoc (const std::string &configFilePath, const std::string moduleName)
	Initialize association parameters from a configuration module. More...

	NvTrackerParamsAssoc (const YAML::Node &fn)
	Initialize association parameters from a YAML node. More...

void	read (const YAML::Node &fn) override
	Update association 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...

ASSOCIATION_MATCHER_TYPE	m_associationMatcherType
	Selects the GREEDY or CASCADED matcher. More...

bool	m_checkClassMatch
	Indicates whether association requires matching object classes. More...

bool	m_usePrediction4Assoc
	Indicates whether association uses predicted states instead of previous states. More...

float	m_minMatchingScore4Overall
	Specifies the minimum total matching score for a candidate. More...

float	m_minMatchingScore4Iou
	Specifies the minimum IOU matching score for a candidate. More...

float	m_minMatchingScore4SizeSimilarity
	Specifies the minimum bounding-box size-similarity score for a candidate. More...

float	m_minMatchingScore4VisualSimilarity
	Specifies the minimum visual-similarity score for a candidate. More...

float	m_minMatchingScore4ReidSimilarity
	Specifies the minimum ReID-similarity score for a candidate. More...

float	m_matchingScoreWeight4Iou
	Specifies the weight of the IOU score. More...

float	m_matchingScoreWeight4SizeSimilarity
	Specifies the weight of the bounding-box size-similarity score. More...

float	m_matchingScoreWeight4VisualSimilarity
	Specifies the weight of visual similarity measured by the correlation-response ratio. More...

float	m_matchingScoreWeight4ReidSimilarity
	Specifies the weight of ReID similarity. More...

uint	m_matchingScoreSet
	Records which optional matching scores were configured. More...

float	m_tentativeDetectorConfidence
	Specifies the confidence ceiling for tentative detections above the minimum detector confidence. More...

float	m_minMatchingScore4TentativeIou
	Specifies the minimum IOU score for matching tentative objects. More...

float	m_minMatchingScore4TentativeIouInactive
	Lower IoU floor for INACTIVE Stage 3 pairs; 0 disables it. More...

bool	m_useSimpleIou4Tentative
	Indicates whether tentative targets use simple IOU instead of the valid-object similarity calculation. More...

float	m_minMatchingScore4PeerAssocIou
	Specifies the minimum IOU score for matching peer targets. More...

double	m_thresholdMahalanobis
	Specifies the Mahalanobis-distance threshold. More...

float	m_maxWorldDist4PrimaryAssoc
	Specifies the maximum world-space feet distance in meters for primary association; a nonpositive value disables the limit. More...

float	m_maxWorldDist4QuasiactiveRescue
	Specifies the maximum world-space distance in meters for QUASIACTIVE IOU rescue. More...

float	m_maxWorldDist4SizeBypass
	Specifies the maximum world-space distance in meters for bypassing the size gate. More...

float	m_maxWorldDist4ActiveIouRescue
	Specifies the maximum world-space distance for ACTIVE or INACTIVE Stage 3 IOU rescue; zero disables it. More...

DATA_ASSOCIATOR_TYPES	m_dataAssociatorType
	Selects the data-associator implementation to construct. More...

bool	m_isInit = false
	Indicates whether the parameters have been initialized. More...

Member Enumeration Documentation

◆ MATCHING_SCORE_SET_STATUS [1/2]

enum NvTrackerParamsAssoc::MATCHING_SCORE_SET_STATUS

Enumerator
MIN_VISUAL	Indicates that minMatchingScore4VisualSimilarity was configured.
WEIGHT_VISUAL	Indicates that matchingScoreWeight4VisualSimilarity was configured.
MIN_REID	Indicates that minMatchingScore4ReidSimilarity was configured.
WEIGHT_REID	Indicates that matchingScoreWeight4ReidSimilarity was configured.
MIN_VISUAL	Indicates that minMatchingScore4VisualSimilarity was configured.
WEIGHT_VISUAL	Indicates that matchingScoreWeight4VisualSimilarity was configured.
MIN_REID	Indicates that minMatchingScore4ReidSimilarity was configured.
WEIGHT_REID	Indicates that matchingScoreWeight4ReidSimilarity was configured.

Definition at line 104 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ MATCHING_SCORE_SET_STATUS [2/2]

enum NvTrackerParamsAssoc::MATCHING_SCORE_SET_STATUS

Enumerator
MIN_VISUAL	Indicates that minMatchingScore4VisualSimilarity was configured.
WEIGHT_VISUAL	Indicates that matchingScoreWeight4VisualSimilarity was configured.
MIN_REID	Indicates that minMatchingScore4ReidSimilarity was configured.
WEIGHT_REID	Indicates that matchingScoreWeight4ReidSimilarity was configured.
MIN_VISUAL	Indicates that minMatchingScore4VisualSimilarity was configured.
WEIGHT_VISUAL	Indicates that matchingScoreWeight4VisualSimilarity was configured.
MIN_REID	Indicates that minMatchingScore4ReidSimilarity was configured.
WEIGHT_REID	Indicates that matchingScoreWeight4ReidSimilarity was configured.

Definition at line 104 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

Constructor & Destructor Documentation

◆ NvTrackerParamsAssoc() [1/6]

NvTrackerParamsAssoc::NvTrackerParamsAssoc ( )

Initialize association parameters with default values.

◆ NvTrackerParamsAssoc() [2/6]

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

Initialize association parameters from a configuration module.

Parameters

[in]	configFilePath	The path to a configuration file.
[in]	moduleName	The configuration module name.

◆ NvTrackerParamsAssoc() [3/6]

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

Initialize association parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of config to update.

◆ NvTrackerParamsAssoc() [4/6]

NvTrackerParamsAssoc::NvTrackerParamsAssoc ( )

Initialize association parameters with default values.

◆ NvTrackerParamsAssoc() [5/6]

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

Initialize association parameters from a configuration module.

Parameters

[in]	configFilePath	The path to a configuration file.
[in]	moduleName	The configuration module name.

◆ NvTrackerParamsAssoc() [6/6]

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

Initialize association parameters from a YAML node.

Parameters

[in] fn Parsed 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

Load the root YAML node from a tracker configuration file.

Parameters

[in]	configFilePath	Path to the tracker configuration file.
[in]	printMessage	Enables 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 sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/NvTrackerParams.hpp.

References CLOG.

Referenced by CommunicatorFactoryParams::CommunicatorFactoryParams(), CommunicatorParams::CommunicatorParams(), DataAssociatorFactoryParams::DataAssociatorFactoryParams(), EstimatorFactoryParams2::EstimatorFactoryParams2(), MqttCommunicatorParams::MqttCommunicatorParams(), MultiViewAssociatorFactoryParams::MultiViewAssociatorFactoryParams(), MultiViewAssociatorParams::MultiViewAssociatorParams(), PoseEstimatorFactoryParams::PoseEstimatorFactoryParams(), ReIDFactoryParams::ReIDFactoryParams(), ReIDServiceFactoryParams::ReIDServiceFactoryParams(), SegmenterFactoryParams::SegmenterFactoryParams(), and VisualTrackerFactoryParams::VisualTrackerFactoryParams().

◆ 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]	configFilePath	Path to the tracker configuration file.
[in]	printMessage	Enables 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 NvTrackerParamsAssoc::read ( const YAML::Node & fn )

overridevirtual

Update association parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of config to update.

Implements NvTrackerParams.

◆ read() [2/2]

void NvTrackerParamsAssoc::read ( const YAML::Node & fn )

overridevirtual

Update association parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of config to update.

Implements NvTrackerParams.

Referenced by DataAssociator::updateParams().

◆ 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]	configFilePath	Path to the tracker configuration file.
[in]	filePath	Absolute 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]	configFilePath	Path to the tracker configuration file.
[in]	filePath	Absolute 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_associationMatcherType

ASSOCIATION_MATCHER_TYPE NvTrackerParamsAssoc::m_associationMatcherType

Selects the GREEDY or CASCADED matcher.

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

◆ m_checkClassMatch

bool NvTrackerParamsAssoc::m_checkClassMatch

Indicates whether association requires matching object classes.

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

◆ m_dataAssociatorType

DATA_ASSOCIATOR_TYPES NvTrackerParamsAssoc::m_dataAssociatorType

Selects the data-associator implementation to construct.

Definition at line 102 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

Referenced by DataAssociator::getDataAssociatorType().

◆ m_debugVerboseLevel

int NvTrackerParamsAssoc::m_debugVerboseLevel

Controls debug message verbosity.

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

◆ m_isInit

bool NvTrackerParamsAssoc::m_isInit = false

Indicates whether the parameters have been initialized.

This prevents static parameters from changing during dynamic updates.

Definition at line 111 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_matchingScoreSet

uint NvTrackerParamsAssoc::m_matchingScoreSet

Records which optional matching scores were configured.

Definition at line 83 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_matchingScoreWeight4Iou

float NvTrackerParamsAssoc::m_matchingScoreWeight4Iou

Specifies the weight of the IOU score.

Definition at line 77 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_matchingScoreWeight4ReidSimilarity

float NvTrackerParamsAssoc::m_matchingScoreWeight4ReidSimilarity

Specifies the weight of ReID similarity.

Definition at line 80 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_matchingScoreWeight4SizeSimilarity

float NvTrackerParamsAssoc::m_matchingScoreWeight4SizeSimilarity

Specifies the weight of the bounding-box size-similarity score.

Definition at line 78 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_matchingScoreWeight4VisualSimilarity

float NvTrackerParamsAssoc::m_matchingScoreWeight4VisualSimilarity

Specifies the weight of visual similarity measured by the correlation-response ratio.

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

◆ m_maxWorldDist4ActiveIouRescue

float NvTrackerParamsAssoc::m_maxWorldDist4ActiveIouRescue

Specifies the maximum world-space distance for ACTIVE or INACTIVE Stage 3 IOU rescue; zero disables it.

Definition at line 99 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_maxWorldDist4PrimaryAssoc

float NvTrackerParamsAssoc::m_maxWorldDist4PrimaryAssoc

Specifies the maximum world-space feet distance in meters for primary association; a nonpositive value disables the limit.

Definition at line 96 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_maxWorldDist4QuasiactiveRescue

float NvTrackerParamsAssoc::m_maxWorldDist4QuasiactiveRescue

Specifies the maximum world-space distance in meters for QUASIACTIVE IOU rescue.

Definition at line 97 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_maxWorldDist4SizeBypass

float NvTrackerParamsAssoc::m_maxWorldDist4SizeBypass

Specifies the maximum world-space distance in meters for bypassing the size gate.

Definition at line 98 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_minMatchingScore4Iou

float NvTrackerParamsAssoc::m_minMatchingScore4Iou

Specifies the minimum IOU matching score for a candidate.

Definition at line 71 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_minMatchingScore4Overall

float NvTrackerParamsAssoc::m_minMatchingScore4Overall

Specifies the minimum total matching score for a candidate.

Definition at line 70 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_minMatchingScore4PeerAssocIou

float NvTrackerParamsAssoc::m_minMatchingScore4PeerAssocIou

Specifies the minimum IOU score for matching peer targets.

Definition at line 90 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_minMatchingScore4ReidSimilarity

float NvTrackerParamsAssoc::m_minMatchingScore4ReidSimilarity

Specifies the minimum ReID-similarity score for a candidate.

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

◆ m_minMatchingScore4SizeSimilarity

float NvTrackerParamsAssoc::m_minMatchingScore4SizeSimilarity

Specifies the minimum bounding-box size-similarity score for a candidate.

Definition at line 72 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_minMatchingScore4TentativeIou

float NvTrackerParamsAssoc::m_minMatchingScore4TentativeIou

Specifies the minimum IOU score for matching tentative objects.

Definition at line 87 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_minMatchingScore4TentativeIouInactive

float NvTrackerParamsAssoc::m_minMatchingScore4TentativeIouInactive

Lower IoU floor for INACTIVE Stage 3 pairs; 0 disables it.

Definition at line 88 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_minMatchingScore4VisualSimilarity

float NvTrackerParamsAssoc::m_minMatchingScore4VisualSimilarity

Specifies the minimum visual-similarity score for a candidate.

Definition at line 73 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_tentativeDetectorConfidence

float NvTrackerParamsAssoc::m_tentativeDetectorConfidence

Specifies the confidence ceiling for tentative detections above the minimum detector confidence.

Definition at line 86 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_thresholdMahalanobis

double NvTrackerParamsAssoc::m_thresholdMahalanobis

Specifies the Mahalanobis-distance threshold.

Definition at line 93 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

◆ m_usePrediction4Assoc

bool NvTrackerParamsAssoc::m_usePrediction4Assoc

Indicates whether association uses predicted states instead of previous states.

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

◆ m_useSimpleIou4Tentative

bool NvTrackerParamsAssoc::m_useSimpleIou4Tentative

Indicates whether tentative targets use simple IOU instead of the valid-object similarity calculation.

Definition at line 89 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp.

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

sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/DataAssociator.hpp


NVIDIA DeepStream SDK API Reference	9.2 Release

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Member Enumeration Documentation

◆ MATCHING_SCORE_SET_STATUS [1/2]

◆ MATCHING_SCORE_SET_STATUS [2/2]

Constructor & Destructor Documentation

◆ NvTrackerParamsAssoc() [1/6]

◆ NvTrackerParamsAssoc() [2/6]

◆ NvTrackerParamsAssoc() [3/6]

◆ NvTrackerParamsAssoc() [4/6]

◆ NvTrackerParamsAssoc() [5/6]

◆ NvTrackerParamsAssoc() [6/6]

Member Function Documentation

◆ getConfigRoot() [1/2]

◆ getConfigRoot() [2/2]

◆ read() [1/2]

◆ read() [2/2]

◆ resolvePathRelativeToConfig() [1/2]

◆ resolvePathRelativeToConfig() [2/2]

Field Documentation

◆ m_associationMatcherType

◆ m_checkClassMatch

◆ m_dataAssociatorType

◆ m_debugVerboseLevel

◆ m_isInit

◆ m_matchingScoreSet

◆ m_matchingScoreWeight4Iou

◆ m_matchingScoreWeight4ReidSimilarity

◆ m_matchingScoreWeight4SizeSimilarity

◆ m_matchingScoreWeight4VisualSimilarity

◆ m_maxWorldDist4ActiveIouRescue

◆ m_maxWorldDist4PrimaryAssoc

◆ m_maxWorldDist4QuasiactiveRescue

◆ m_maxWorldDist4SizeBypass

◆ m_minMatchingScore4Iou

◆ m_minMatchingScore4Overall

◆ m_minMatchingScore4PeerAssocIou

◆ m_minMatchingScore4ReidSimilarity

◆ m_minMatchingScore4SizeSimilarity

◆ m_minMatchingScore4TentativeIou

◆ m_minMatchingScore4TentativeIouInactive

◆ m_minMatchingScore4VisualSimilarity

◆ m_tentativeDetectorConfidence

◆ m_thresholdMahalanobis

◆ m_usePrediction4Assoc

◆ m_useSimpleIou4Tentative