Detailed Description

Configuration parameters for the visual tracker factory.

Definition at line 33 of file sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp.

Inheritance diagram for VisualTrackerFactoryParams:

[legend]

Collaboration diagram for VisualTrackerFactoryParams:

[legend]

Public Member Functions
	VisualTrackerFactoryParams ()
	Construct default factory parameters selecting the dummy tracker. More...

	VisualTrackerFactoryParams (const std::string &configFilePath, const std::string moduleName)
	Construct factory parameters from a named module in a file. More...

	VisualTrackerFactoryParams (const YAML::Node &fn)
	Construct factory parameters from a YAML node. More...

void	read (const YAML::Node &fn) override
	Read visual tracker factory parameters from a YAML node. More...

	VisualTrackerFactoryParams ()
	Construct default factory parameters selecting the dummy tracker. More...

	VisualTrackerFactoryParams (const std::string &configFilePath, const std::string moduleName)
	Construct factory parameters from a named module in a file. More...

	VisualTrackerFactoryParams (const YAML::Node &fn)
	Construct factory parameters from a YAML node. More...

void	read (const YAML::Node &fn) override
	Read visual tracker 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
VISUAL_TRACKER_TYPES	m_visualTrackerType
	The type of visual tracker. More...

Constructor & Destructor Documentation

◆ VisualTrackerFactoryParams() [1/6]

VisualTrackerFactoryParams::VisualTrackerFactoryParams ( )

inline

Construct default factory parameters selecting the dummy tracker.

Definition at line 37 of file sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp.

References DUMMY_VOT, and m_visualTrackerType.

Referenced by read().

◆ VisualTrackerFactoryParams() [2/6]

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

inline

Construct factory parameters from a named module in a file.

Parameters

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

Definition at line 47 of file sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp.

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

◆ VisualTrackerFactoryParams() [3/6]

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

inline

Construct factory parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure containing the configuration.

Definition at line 57 of file sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp.

References read().

◆ VisualTrackerFactoryParams() [4/6]

VisualTrackerFactoryParams::VisualTrackerFactoryParams ( )

inline

Construct default factory parameters selecting the dummy tracker.

Definition at line 37 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp.

References DUMMY_VOT, and m_visualTrackerType.

◆ VisualTrackerFactoryParams() [5/6]

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

inline

Construct factory parameters from a named module in a file.

Parameters

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

Definition at line 47 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp.

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

◆ VisualTrackerFactoryParams() [6/6]

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

inline

Construct factory parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure containing the configuration.

Definition at line 57 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_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

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().

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

inlineoverridevirtual

Read visual tracker factory parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of configuration parameters.

Set the default values.

Validate the visual tracker type (valid range: 0-2).

Implements NvTrackerParams.

Definition at line 66 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp.

References m_visualTrackerType, and VisualTrackerFactoryParams().

◆ read() [2/2]

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

inlineoverridevirtual

Read visual tracker factory parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of configuration parameters.

Set the default values.

Validate the visual tracker type (valid range: 0-2).

Implements NvTrackerParams.

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

References m_visualTrackerType, and VisualTrackerFactoryParams().

Referenced by VisualTrackerFactoryParams().

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

VISUAL_TRACKER_TYPES VisualTrackerFactoryParams::m_visualTrackerType

The type of visual tracker.

Definition at line 92 of file sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp.

Referenced by VisualTrackerFactory::makeVisualTracker(), read(), and VisualTrackerFactoryParams().

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

sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker_factory.hpp

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Static Public Member Functions

Data Fields

Constructor & Destructor Documentation

◆ VisualTrackerFactoryParams() [1/6]

◆ VisualTrackerFactoryParams() [2/6]

◆ VisualTrackerFactoryParams() [3/6]

◆ VisualTrackerFactoryParams() [4/6]

◆ VisualTrackerFactoryParams() [5/6]

◆ VisualTrackerFactoryParams() [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_visualTrackerType