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


NVIDIA DeepStream SDK API Reference	9.2 Release

Detailed Description

Stores the implementation type selected by the factory.

Definition at line 30 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.hpp.

Inheritance diagram for SegmenterFactoryParams:

Inheritance graph

[legend]

Collaboration diagram for SegmenterFactoryParams:

Collaboration graph

[legend]

Public Member Functions
	SegmenterFactoryParams ()
	Construct segmenter factory parameters. More...

	SegmenterFactoryParams (const std::string &configFilePath, const std::string moduleName)
	Construct a SegmenterFactoryParams instance. More...

	SegmenterFactoryParams (const YAML::Node &fn)
	Construct a SegmenterFactoryParams instance. More...

void	read (const YAML::Node &fn) override
	Load configuration values from a YAML node. More...

	SegmenterFactoryParams ()
	Construct segmenter factory parameters. More...

	SegmenterFactoryParams (const std::string &configFilePath, const std::string moduleName)
	Construct a SegmenterFactoryParams instance. More...

	SegmenterFactoryParams (const YAML::Node &fn)
	Construct a SegmenterFactoryParams instance. More...

void	read (const YAML::Node &fn) override
	Load configuration values 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
SEGMENTER_TYPES	m_segmenterType
	The implementation to construct. More...

Constructor & Destructor Documentation

◆ SegmenterFactoryParams() [1/6]

SegmenterFactoryParams::SegmenterFactoryParams ( )

inline

Construct segmenter factory parameters.

Definition at line 34 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.hpp.

References DUMMY_SEGMENTER, and m_segmenterType.

Referenced by read().

◆ SegmenterFactoryParams() [2/6]

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

inline

Construct a SegmenterFactoryParams instance.

Parameters

[in]	configFilePath	Path to the tracker configuration file.
[in]	moduleName	Configuration module name.

Definition at line 44 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.hpp.

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

◆ SegmenterFactoryParams() [3/6]

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

inline

Construct a SegmenterFactoryParams instance.

Parameters

[in] fn Parsed YAML node.

Definition at line 54 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.hpp.

References read().

◆ SegmenterFactoryParams() [4/6]

SegmenterFactoryParams::SegmenterFactoryParams ( )

inline

Construct segmenter factory parameters.

Definition at line 34 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.hpp.

References DUMMY_SEGMENTER, and m_segmenterType.

◆ SegmenterFactoryParams() [5/6]

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

inline

Construct a SegmenterFactoryParams instance.

Parameters

[in]	configFilePath	Path to the tracker configuration file.
[in]	moduleName	Configuration module name.

Definition at line 44 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.hpp.

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

◆ SegmenterFactoryParams() [6/6]

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

inline

Construct a SegmenterFactoryParams instance.

Parameters

[in] fn Parsed YAML node.

Definition at line 54 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_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(), 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 SegmenterFactoryParams::read ( const YAML::Node & fn )

inlineoverridevirtual

Load configuration values from a YAML node.

Parameters

[in] fn Parsed YAML node.

Set the default values.

Validate the segmenter type (valid range: 0-3) SEGMENTER_TYPES: DUMMY_SEGMENTER=0, SAM2=1, NanoSAM=2, EfficientVitSAM=3.

Implements NvTrackerParams.

Definition at line 63 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.hpp.

References m_segmenterType, and SegmenterFactoryParams().

◆ read() [2/2]

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

inlineoverridevirtual

Load configuration values from a YAML node.

Parameters

[in] fn Parsed YAML node.

Set the default values.

Validate the segmenter type (valid range: 0-3) SEGMENTER_TYPES: DUMMY_SEGMENTER=0, SAM2=1, NanoSAM=2, EfficientVitSAM=3.

Implements NvTrackerParams.

Definition at line 63 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.hpp.

References m_segmenterType, and SegmenterFactoryParams().

Referenced by SegmenterFactoryParams().

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

SEGMENTER_TYPES SegmenterFactoryParams::m_segmenterType

The implementation to construct.

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

Referenced by SegmenterFactory::makeSegmenter(), read(), and SegmenterFactoryParams().

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

sources/libs/nvmultiobjecttracker/include/modules/Segmenter/Segmenter_factory.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:35 | PR-09318-R32