NVIDIA DeepStream SDK API Reference: EstimatorFactoryParams2 Class Reference | NVIDIA Docs


NVIDIA DeepStream SDK API Reference	9.2 Release

Detailed Description

Config parser for factory.

Definition at line 31 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.hpp.

Inheritance diagram for EstimatorFactoryParams2:

Inheritance graph

[legend]

Collaboration diagram for EstimatorFactoryParams2:

Collaboration graph

[legend]

Public Member Functions
	EstimatorFactoryParams2 ()
	Initialize factory parameters with the default estimator type. More...

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

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

	EstimatorFactoryParams2 ()
	Initialize factory parameters with the default estimator type. More...

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

	EstimatorFactoryParams2 (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
STATE_ESTIMATOR_TYPES	m_stateEstimatorType
	Selects the state-estimator type. More...

Constructor & Destructor Documentation

◆ EstimatorFactoryParams2() [1/6]

EstimatorFactoryParams2::EstimatorFactoryParams2 ( )

inline

Initialize factory parameters with the default estimator type.

Definition at line 35 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.hpp.

References DUMMY_ESTIMATOR, and m_stateEstimatorType.

Referenced by read().

◆ EstimatorFactoryParams2() [2/6]

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

inline

Initialize factory parameters from a configuration module.

Parameters

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

Definition at line 45 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.hpp.

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

◆ EstimatorFactoryParams2() [3/6]

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

inline

Initialize factory parameters from a YAML node.

Parameters

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

Definition at line 55 of file sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.hpp.

References read().

◆ EstimatorFactoryParams2() [4/6]

EstimatorFactoryParams2::EstimatorFactoryParams2 ( )

inline

Initialize factory parameters with the default estimator type.

Definition at line 35 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.hpp.

References DUMMY_ESTIMATOR, and m_stateEstimatorType.

◆ EstimatorFactoryParams2() [5/6]

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

inline

Initialize factory parameters from a configuration module.

Parameters

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

Definition at line 45 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.hpp.

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

◆ EstimatorFactoryParams2() [6/6]

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

inline

Initialize factory parameters from a YAML node.

Parameters

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

Definition at line 55 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.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(), 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 EstimatorFactoryParams2::read ( const YAML::Node & fn )

inlineoverridevirtual

Update factory parameters from a YAML node.

Parameters

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

Reject unsupported state-estimator types.

Implements NvTrackerParams.

Definition at line 64 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.hpp.

References EstimatorFactoryParams2(), and m_stateEstimatorType.

◆ read() [2/2]

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

inlineoverridevirtual

Update factory parameters from a YAML node.

Parameters

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

Reject unsupported state-estimator types.

Implements NvTrackerParams.

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

References EstimatorFactoryParams2(), and m_stateEstimatorType.

Referenced by EstimatorFactoryParams2().

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

STATE_ESTIMATOR_TYPES EstimatorFactoryParams2::m_stateEstimatorType

Selects the state-estimator type.

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

Referenced by EstimatorFactoryParams2(), EstimatorFactory2::makeEstimator(), and read().

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

sources/libs/nvmultiobjecttracker/include/modules/Estimatorv2/estimator_factory2.hpp

Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact
© 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
NVIDIA Confidential | Subject to Change | For test and development only.
Wed Oct 28 2026 12:03:25 | PR-09318-R32