Detailed Description

Stores configuration for a ReID inference module.

Definition at line 40 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

Inheritance diagram for ReIDConfigParams:

Collaboration diagram for ReIDConfigParams:

Public Member Functions
	ReIDConfigParams ()
	Construct a ReIDConfigParams instance. More...

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

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

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

	ReIDConfigParams ()
	Construct a ReIDConfigParams instance. More...

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

	ReIDConfigParams (const YAML::Node &fn)
	Construct a ReIDConfigParams 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
bool	m_keepAspc
	Keep original aspect ratio when rescaling. More...

bool	m_addFeatureNormalization
	Whether to perform additional feature normalization for network output features. More...

bool	m_outputReidTensor
	Whether to output reid tensor. More...

int	m_maxBatchSize
	Maximum batch size for reid network. More...

int	m_reidFeatureSize
	Size of each reid feature. More...

int	m_inputOrder
	Input dimension order: 0: NCHW, 1: NHWC. More...

int	m_width
	Input image patch width. More...

int	m_height
	Input image patch height. More...

int	m_channel
	Input image patch channel. More...

int	m_reidHistorySize
	Max number of reid features per object. More...

int	m_gpuId
	Gpu id. More...

float	m_netScaleFactor
	Input normalization factor. More...

float	m_minVisibility4GalleryUpdate
	Add ReID embedding to the gallery only if the visibility is not lower than this. More...

float	m_minVisibility4ReidOutput
	Minimum visibility to output the reid features. More...

size_t	m_workspaceSize
	Work space for reid network in MiB. More...

std::vector< int >	m_inferDims
	Reid input dimension. More...

std::vector< float >	m_offsets
	List of mean values of color components to be subtracted from input. More...

NvBufSurfaceColorFormat	m_colorFormat
	Color format of input to reid network. More...

REID_TYPES	m_reidType
	Type of reid. More...

bool	m_useVPICropScaler
	Use VPI crop scaler instead of in built crop scaler. More...

bool	m_useSegmentationMask4Input
	Multiply input patches with segmentation mask, so background is set as zero. More...

int	m_debugVerboseLevel
	Debug message verbose mode level. More...

Constructor & Destructor Documentation

◆ ReIDConfigParams() [1/6]

ReIDConfigParams::ReIDConfigParams ( )

Construct a ReIDConfigParams instance.

◆ ReIDConfigParams() [2/6]

ReIDConfigParams::ReIDConfigParams	(	const std::string &	configFilePath,
		const std::string	moduleName,
		const std::string	submoduleName
	)

Construct a ReIDConfigParams instance.

Parameters

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

◆ ReIDConfigParams() [3/6]

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

Construct a ReIDConfigParams instance.

Parameters

[in] fn Parsed YAML node.

◆ ReIDConfigParams() [4/6]

ReIDConfigParams::ReIDConfigParams ( )

Construct a ReIDConfigParams instance.

◆ ReIDConfigParams() [5/6]

ReIDConfigParams::ReIDConfigParams	(	const std::string &	configFilePath,
		const std::string	moduleName,
		const std::string	submoduleName
	)

Construct a ReIDConfigParams instance.

Parameters

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

◆ ReIDConfigParams() [6/6]

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

Construct a ReIDConfigParams instance.

Parameters

[in] fn Parsed YAML node.

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

overridevirtual

Load configuration values from a YAML node.

Parameters

[in] fn Parsed YAML node.

Implements NvTrackerParams.

◆ read() [2/2]

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

overridevirtual

Load configuration values from a YAML node.

Parameters

[in] fn Parsed YAML node.

Implements NvTrackerParams.

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

bool ReIDConfigParams::m_addFeatureNormalization

Whether to perform additional feature normalization for network output features.

Definition at line 67 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_channel

int ReIDConfigParams::m_channel

Input image patch channel.

Definition at line 74 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_colorFormat

NvBufSurfaceColorFormat ReIDConfigParams::m_colorFormat

Color format of input to reid network.

Definition at line 83 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_debugVerboseLevel

int ReIDConfigParams::m_debugVerboseLevel

Debug message verbose mode level.

Definition at line 87 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_gpuId

int ReIDConfigParams::m_gpuId

Gpu id.

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

◆ m_height

int ReIDConfigParams::m_height

Input image patch height.

Definition at line 73 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_inferDims

std::vector< int > ReIDConfigParams::m_inferDims

Reid input dimension.

Definition at line 81 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_inputOrder

int ReIDConfigParams::m_inputOrder

Input dimension order: 0: NCHW, 1: NHWC.

Definition at line 71 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_keepAspc

bool ReIDConfigParams::m_keepAspc

Keep original aspect ratio when rescaling.

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

◆ m_maxBatchSize

int ReIDConfigParams::m_maxBatchSize

Maximum batch size for reid network.

Definition at line 69 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_minVisibility4GalleryUpdate

float ReIDConfigParams::m_minVisibility4GalleryUpdate

Add ReID embedding to the gallery only if the visibility is not lower than this.

Definition at line 78 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_minVisibility4ReidOutput

float ReIDConfigParams::m_minVisibility4ReidOutput

Minimum visibility to output the reid features.

Definition at line 79 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_netScaleFactor

float ReIDConfigParams::m_netScaleFactor

Input normalization factor.

Definition at line 77 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_offsets

std::vector< float > ReIDConfigParams::m_offsets

List of mean values of color components to be subtracted from input.

Definition at line 82 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_outputReidTensor

bool ReIDConfigParams::m_outputReidTensor

Whether to output reid tensor.

Definition at line 68 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_reidFeatureSize

int ReIDConfigParams::m_reidFeatureSize

Size of each reid feature.

Definition at line 70 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_reidHistorySize

int ReIDConfigParams::m_reidHistorySize

Max number of reid features per object.

Definition at line 75 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_reidType

REID_TYPES ReIDConfigParams::m_reidType

Type of reid.

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

Referenced by ReID::getReIDType().

◆ m_useSegmentationMask4Input

bool ReIDConfigParams::m_useSegmentationMask4Input

Multiply input patches with segmentation mask, so background is set as zero.

Definition at line 86 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_useVPICropScaler

bool ReIDConfigParams::m_useVPICropScaler

Use VPI crop scaler instead of in built crop scaler.

Definition at line 85 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_width

int ReIDConfigParams::m_width

Input image patch width.

Definition at line 72 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp.

◆ m_workspaceSize

size_t ReIDConfigParams::m_workspaceSize

Work space for reid network in MiB.

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

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

sources/libs/nvmultiobjecttracker/include/modules/ReID/ReID.hpp


NVIDIA DeepStream SDK API Reference	9.2 Release

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Static Public Member Functions

Data Fields

Constructor & Destructor Documentation

◆ ReIDConfigParams() [1/6]

◆ ReIDConfigParams() [2/6]

◆ ReIDConfigParams() [3/6]

◆ ReIDConfigParams() [4/6]

◆ ReIDConfigParams() [5/6]

◆ ReIDConfigParams() [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_addFeatureNormalization

◆ m_channel

◆ m_colorFormat

◆ m_debugVerboseLevel

◆ m_gpuId

◆ m_height

◆ m_inferDims

◆ m_inputOrder

◆ m_keepAspc

◆ m_maxBatchSize

◆ m_minVisibility4GalleryUpdate

◆ m_minVisibility4ReidOutput

◆ m_netScaleFactor

◆ m_offsets

◆ m_outputReidTensor

◆ m_reidFeatureSize

◆ m_reidHistorySize

◆ m_reidType

◆ m_useSegmentationMask4Input

◆ m_useVPICropScaler

◆ m_width

◆ m_workspaceSize