NVIDIA DeepStream SDK API Reference

9.2 Release
MultiViewAssociatorFactoryParams Class Reference

Detailed Description

Store multi-view-associator factory parameters.

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

Inheritance diagram for MultiViewAssociatorFactoryParams:
Collaboration diagram for MultiViewAssociatorFactoryParams:

Public Member Functions

 MultiViewAssociatorFactoryParams ()
 Initialize factory parameters with the dummy associator type. More...
 
 MultiViewAssociatorFactoryParams (const std::string &configFilePath, const std::string moduleName)
 Initialize factory parameters from a configuration module. More...
 
 MultiViewAssociatorFactoryParams (const YAML::Node &fn)
 Initialize factory parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Update factory parameters from a YAML node. More...
 
 MultiViewAssociatorFactoryParams ()
 Initialize factory parameters with the dummy associator type. More...
 
 MultiViewAssociatorFactoryParams (const std::string &configFilePath, const std::string moduleName)
 Initialize factory parameters from a configuration module. More...
 
 MultiViewAssociatorFactoryParams (const YAML::Node &fn)
 Initialize factory parameters from a YAML node. More...
 
void read (const YAML::Node &fn) override
 Update factory 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...
 

Constructor & Destructor Documentation

◆ MultiViewAssociatorFactoryParams() [1/6]

MultiViewAssociatorFactoryParams::MultiViewAssociatorFactoryParams ( )
inline

Initialize factory parameters with the dummy associator type.

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

References DUMMY_MULTI_VIEW_ASSOCIATOR, and m_multiViewAssociatorType.

Referenced by read().

◆ MultiViewAssociatorFactoryParams() [2/6]

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

Initialize factory parameters from a configuration module.

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

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

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

◆ MultiViewAssociatorFactoryParams() [3/6]

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

Initialize factory parameters from a YAML node.

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

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

References read().

◆ MultiViewAssociatorFactoryParams() [4/6]

MultiViewAssociatorFactoryParams::MultiViewAssociatorFactoryParams ( )
inline

Initialize factory parameters with the dummy associator type.

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

References DUMMY_MULTI_VIEW_ASSOCIATOR, and m_multiViewAssociatorType.

◆ MultiViewAssociatorFactoryParams() [5/6]

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

Initialize factory parameters from a configuration module.

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

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

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

◆ MultiViewAssociatorFactoryParams() [6/6]

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

Initialize factory parameters from a YAML node.

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

Definition at line 104 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/MultiViewAssociator/MultiViewAssociator_factory.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]

void MultiViewAssociatorFactoryParams::read ( const YAML::Node &  fn)
inlineoverridevirtual

Update factory parameters from a YAML node.

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

Implements NvTrackerParams.

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

References m_multiViewAssociatorType, and MultiViewAssociatorFactoryParams().

◆ read() [2/2]

void MultiViewAssociatorFactoryParams::read ( const YAML::Node &  fn)
inlineoverridevirtual

Update factory parameters from a YAML node.

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

Implements NvTrackerParams.

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

References m_multiViewAssociatorType, and MultiViewAssociatorFactoryParams().

Referenced by MultiViewAssociatorFactoryParams().

◆ 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_multiViewAssociatorType

MULTI_VIEW_ASSOCIATOR_TYPES MultiViewAssociatorFactoryParams::m_multiViewAssociatorType

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