NVIDIA DeepStream SDK API Reference

9.2 Release
MultiViewAssociatorParams Class Reference

Detailed Description

Store multi-view association configuration parameters.

Definition at line 25 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Inheritance diagram for MultiViewAssociatorParams:
Collaboration diagram for MultiViewAssociatorParams:

Public Member Functions

 MultiViewAssociatorParams ()
 Initialize multi-view association parameters with default values. More...
 
 MultiViewAssociatorParams (const std::string &configFilePath, const std::string moduleName)
 Initialize multi-view association parameters from a configuration module. More...
 
 MultiViewAssociatorParams (const YAML::Node &fn)
 Initialize multi-view association parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Update multi-view association parameters from a YAML node. More...
 
 MultiViewAssociatorParams ()
 Initialize multi-view association parameters with default values. More...
 
 MultiViewAssociatorParams (const std::string &configFilePath, const std::string moduleName)
 Initialize multi-view association parameters from a configuration module. More...
 
 MultiViewAssociatorParams (const YAML::Node &fn)
 Initialize multi-view association parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Update multi-view 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

MULTI_VIEW_ASSOCIATOR_TYPES m_multiViewAssociatorType
 Selects the multi-view-associator implementation. More...
 
int m_debugVerboseLevel
 Controls debug message verbosity. More...
 
bool m_enableLatePeerReAssoc
 Enables late peer reassociation. More...
 
bool m_enableIDCorrection
 Enables correction of target IDs from peer messages. More...
 
bool m_enableSeeThrough
 Enables peer-state fusion for occluded targets. More...
 
bool m_enableMsgSync
 Enables synchronization messages between cameras. More...
 
bool m_checkClassMatch
 Requires peer targets to have the same class when enabled. More...
 
int m_maxPeerTrackletSize
 Specifies the maximum peer tracklet size used for transmission and storage. More...
 
int m_recentlyActiveAge
 Specifies the target age limit for late peer reassociation. More...
 
int m_minCommonFrames4MatchScore
 Specifies the minimum common-frame count for tracklet similarity. More...
 
int m_maxTrackletMatchingTimeSearchRange
 Specifies the maximum temporal offset searched during tracklet matching. More...
 
float m_maxPeerToPredDistance4Fusion
 Specifies the maximum distance from an ego prediction to a peer measurement used for fusion. More...
 
float m_minPeerVisibility4Fusion
 Specifies the minimum peer visibility for measurement fusion. More...
 
float m_minPeerTrackletMatchScore
 Specifies the tracklet-similarity threshold for matching. More...
 
int m_maxPeerFrameDiff4NoDet
 Specifies the maximum peer-frame difference when detections are unavailable. More...
 
int m_communicatorInitSleepTime
 Specifies the delay after communicator initialization. More...
 
float m_minReidServiceMatchConfidence
 Specifies the minimum ReID-service confidence for peer reassociation. More...
 
int m_egoTrackletHistoryMultiplier
 Scales the ego comparison window relative to the maximum peer tracklet size. More...
 
float m_minMatchingScore4PartialOverlap
 Specifies the minimum score for adopting a partial-overlap pair; 1.0 disables adoption. More...
 
int m_partialTimeSearchMultiplier
 Scales the temporal search range for partial-overlap scoring. More...
 
int m_minCommonFrames4PartialOverlap
 Specifies the minimum co-visible frames for partial-overlap adoption. More...
 
float m_maxSeqBridgeDist
 Specifies the maximum junction distance in meters for sequential bridging; zero disables it. More...
 
float m_minMatchingScore4RegularReAssoc
 Specifies the minimum score for regular reassociation; zero uses the shared score gate. More...
 
bool m_enablePeerReidEmbedding
 Enables copying ReID embeddings into peer tracklet payloads. More...
 

Constructor & Destructor Documentation

◆ MultiViewAssociatorParams() [1/6]

◆ MultiViewAssociatorParams() [2/6]

MultiViewAssociatorParams::MultiViewAssociatorParams ( const std::string &  configFilePath,
const std::string  moduleName 
)
inline

Initialize multi-view association parameters from a configuration module.

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

Read cross-cutting BaseConfig params (startup-only; overrides in-section default).

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

References NvTrackerParams::getConfigRoot(), m_checkClassMatch, and read().

◆ MultiViewAssociatorParams() [3/6]

MultiViewAssociatorParams::MultiViewAssociatorParams ( const YAML::Node &  fn)
inline

Initialize multi-view association parameters from a YAML node.

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

Definition at line 76 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

References read().

◆ MultiViewAssociatorParams() [4/6]

◆ MultiViewAssociatorParams() [5/6]

MultiViewAssociatorParams::MultiViewAssociatorParams ( const std::string &  configFilePath,
const std::string  moduleName 
)
inline

Initialize multi-view association parameters from a configuration module.

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

Read cross-cutting BaseConfig params (startup-only; overrides in-section default).

Definition at line 62 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

References NvTrackerParams::getConfigRoot(), m_checkClassMatch, and read().

◆ MultiViewAssociatorParams() [6/6]

MultiViewAssociatorParams::MultiViewAssociatorParams ( const YAML::Node &  fn)
inline

Initialize multi-view association parameters from a YAML node.

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

Definition at line 76 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

References read().

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]

◆ read() [2/2]

◆ 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 MultiViewAssociatorParams::m_checkClassMatch

Requires peer targets to have the same class when enabled.

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

Referenced by MultiViewAssociatorParams().

◆ m_communicatorInitSleepTime

int MultiViewAssociatorParams::m_communicatorInitSleepTime

Specifies the delay after communicator initialization.

Definition at line 181 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_debugVerboseLevel

int MultiViewAssociatorParams::m_debugVerboseLevel

Controls debug message verbosity.

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

Referenced by MultiViewAssociatorParams(), and read().

◆ m_egoTrackletHistoryMultiplier

int MultiViewAssociatorParams::m_egoTrackletHistoryMultiplier

Scales the ego comparison window relative to the maximum peer tracklet size.

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

Referenced by MultiViewAssociatorParams(), and read().

◆ m_enableIDCorrection

bool MultiViewAssociatorParams::m_enableIDCorrection

Enables correction of target IDs from peer messages.

Definition at line 169 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_enableLatePeerReAssoc

bool MultiViewAssociatorParams::m_enableLatePeerReAssoc

Enables late peer reassociation.

Definition at line 168 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_enableMsgSync

bool MultiViewAssociatorParams::m_enableMsgSync

Enables synchronization messages between cameras.

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

Referenced by MultiViewAssociatorParams(), and read().

◆ m_enablePeerReidEmbedding

bool MultiViewAssociatorParams::m_enablePeerReidEmbedding

Enables copying ReID embeddings into peer tracklet payloads.

Definition at line 189 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_enableSeeThrough

bool MultiViewAssociatorParams::m_enableSeeThrough

Enables peer-state fusion for occluded targets.

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

Referenced by MultiViewAssociatorParams(), and read().

◆ m_maxPeerFrameDiff4NoDet

int MultiViewAssociatorParams::m_maxPeerFrameDiff4NoDet

Specifies the maximum peer-frame difference when detections are unavailable.

Definition at line 180 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_maxPeerToPredDistance4Fusion

float MultiViewAssociatorParams::m_maxPeerToPredDistance4Fusion

Specifies the maximum distance from an ego prediction to a peer measurement used for fusion.

Definition at line 177 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_maxPeerTrackletSize

int MultiViewAssociatorParams::m_maxPeerTrackletSize

Specifies the maximum peer tracklet size used for transmission and storage.

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

Referenced by MultiViewAssociatorParams(), and read().

◆ m_maxSeqBridgeDist

float MultiViewAssociatorParams::m_maxSeqBridgeDist

Specifies the maximum junction distance in meters for sequential bridging; zero disables it.

Definition at line 187 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_maxTrackletMatchingTimeSearchRange

int MultiViewAssociatorParams::m_maxTrackletMatchingTimeSearchRange

Specifies the maximum temporal offset searched during tracklet matching.

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

Referenced by MultiViewAssociatorParams(), and read().

◆ m_minCommonFrames4MatchScore

int MultiViewAssociatorParams::m_minCommonFrames4MatchScore

Specifies the minimum common-frame count for tracklet similarity.

Definition at line 175 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_minCommonFrames4PartialOverlap

int MultiViewAssociatorParams::m_minCommonFrames4PartialOverlap

Specifies the minimum co-visible frames for partial-overlap adoption.

Definition at line 186 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_minMatchingScore4PartialOverlap

float MultiViewAssociatorParams::m_minMatchingScore4PartialOverlap

Specifies the minimum score for adopting a partial-overlap pair; 1.0 disables adoption.

Definition at line 184 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_minMatchingScore4RegularReAssoc

float MultiViewAssociatorParams::m_minMatchingScore4RegularReAssoc

Specifies the minimum score for regular reassociation; zero uses the shared score gate.

Definition at line 188 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_minPeerTrackletMatchScore

float MultiViewAssociatorParams::m_minPeerTrackletMatchScore

Specifies the tracklet-similarity threshold for matching.

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

Referenced by MultiViewAssociatorParams(), and read().

◆ m_minPeerVisibility4Fusion

float MultiViewAssociatorParams::m_minPeerVisibility4Fusion

Specifies the minimum peer visibility for measurement fusion.

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

Referenced by MultiViewAssociatorParams(), and read().

◆ m_minReidServiceMatchConfidence

float MultiViewAssociatorParams::m_minReidServiceMatchConfidence

Specifies the minimum ReID-service confidence for peer reassociation.

Definition at line 182 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_multiViewAssociatorType

MULTI_VIEW_ASSOCIATOR_TYPES MultiViewAssociatorParams::m_multiViewAssociatorType

Selects the multi-view-associator implementation.

Definition at line 166 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_partialTimeSearchMultiplier

int MultiViewAssociatorParams::m_partialTimeSearchMultiplier

Scales the temporal search range for partial-overlap scoring.

Definition at line 185 of file sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator.hpp.

Referenced by MultiViewAssociatorParams(), and read().

◆ m_recentlyActiveAge

int MultiViewAssociatorParams::m_recentlyActiveAge

Specifies the target age limit for late peer reassociation.

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

Referenced by MultiViewAssociatorParams(), and read().


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