Detailed Description

Configuration parameters for the visual tracker.

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

Inheritance diagram for VisualTrackerConfigParams:

Collaboration diagram for VisualTrackerConfigParams:

Public Member Functions
	VisualTrackerConfigParams ()
	Construct the default configuration. More...

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

	VisualTrackerConfigParams (const YAML::Node &fn)
	Construct configuration parameters from a YAML node. More...

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

	VisualTrackerConfigParams ()
	Construct the default configuration. More...

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

	VisualTrackerConfigParams (const YAML::Node &fn)
	Construct configuration parameters from a YAML node. More...

void	read (const YAML::Node &fn) override
	Read visual tracker 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
int	m_showGpuTiming
	Controls whether GPU timing is displayed. More...

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

int	m_debugVerboseLevel_gpumemory
	GPU memory debug verbosity level. More...

int	m_debugVerboseLevel_cufft
	Debug verbosity level for cuFFT. More...

bool	m_useColorNames
	Enables the ColorNames feature. More...

bool	m_useHog
	Enables the HOG feature. More...

bool	m_useGray
	Enables the grayscale pixel-intensity feature. More...

bool	m_useRgb
	Enables the RGB feature. More...

bool	m_useHighPrecisionFeature
	Enables high-precision 16-bit VPI output instead of low-precision 8-bit output. More...

bool	m_useCpuBackends4VPI
	Enables CPU backends for VPI instead of CUDA. More...

float	m_featureImgSize
	Maximum template length in one dimension. More...

float	m_featureFocusOffsetFactor_y
	Vertical Hanning-window center offset relative to the feature height. More...

float	m_modelMaskingWindowFactor
	Masking-window factor used for focused filter learning. More...

int	m_hogCellSize
	Cell size of HOG feature. More...

float	m_filterLr
	Learning rate for DCF filter in exponential moving average. More...

float	m_filterChannelWeightsLr
	Learning rate for DCF filter channel weights in exponential moving average. More...

float	m_gaussianSigma
	Sigma for Gaussian for desired response. More...

float	m_lambda
	Regularization factor used in DCF filter creation. More...

float	m_peakCorrLr
	Learning rate for peak correlation response in exponential moving average. More...

float	m_minConfidence4SegmentationFilter
	Minimum confidence for using a segmentation mask during filter learning. More...

int	m_cufftHandleQuantFactor
	Clustering size for cuFFT plans. More...

bool	m_generateTrackerVisualization
	Enables tracker visualization generation. More...

bool	m_vizWriteSrcImgPatchesAndCorrResp
	Write the cropped/scaled image patches and correlation response. More...

bool	m_vizWriteBirdsEyeView
	Write the bird's-eye view. More...

bool	m_vizWriteAllTrajectoriesOnEveryFrame
	Write the whole frame with trajectories of all targets in the scene. More...

bool	m_vizWriteEachCompletedTrajectory
	Write each completed trajectory. More...

bool	m_vizWriteSegMask
	Save the filter mask generated by the segmenter. More...

int	m_vizJpegImageQuality
	JPEG output quality in the range [1, 100]. More...

std::string	m_vizOutDirectory
	The directory to write the outputs. More...

int	m_vizDebugStreamId
	Video stream ID selected for visualization debugging. More...

int	m_debugParamInt0
	First integer debugging parameter. More...

int	m_debugParamInt1
	Second integer debugging parameter. More...

int	m_debugParamInt2
	Third integer debugging parameter. More...

float	m_debugParamFloat0
	First floating-point debugging parameter. More...

float	m_debugParamFloat1
	Second floating-point debugging parameter. More...

float	m_debugParamFloat2
	Third floating-point debugging parameter. More...

VISUAL_TRACKER_TYPES	m_visualTrackerType
	The type of visual tracker. More...

bool	m_isInit = false
	Indicates whether the parameters have been initialized. More...

Constructor & Destructor Documentation

◆ VisualTrackerConfigParams() [1/6]

VisualTrackerConfigParams::VisualTrackerConfigParams ( )

Construct the default configuration.

◆ VisualTrackerConfigParams() [2/6]

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

Construct configuration parameters from a named module in a file.

Parameters

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

◆ VisualTrackerConfigParams() [3/6]

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

Construct configuration parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure containing the configuration.

◆ VisualTrackerConfigParams() [4/6]

VisualTrackerConfigParams::VisualTrackerConfigParams ( )

Construct the default configuration.

◆ VisualTrackerConfigParams() [5/6]

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

Construct configuration parameters from a named module in a file.

Parameters

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

◆ VisualTrackerConfigParams() [6/6]

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

Construct configuration parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure containing the configuration.

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

overridevirtual

Read visual tracker parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of configuration parameters.

Implements NvTrackerParams.

◆ read() [2/2]

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

overridevirtual

Read visual tracker parameters from a YAML node.

Parameters

[in] fn Parsed YAML structure of configuration parameters.

Implements NvTrackerParams.

Referenced by VisualTracker::updateParams().

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

int VisualTrackerConfigParams::m_cufftHandleQuantFactor

Clustering size for cuFFT plans.

Each plan covers a range of input sizes, and this sets how fine that range is.

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

◆ m_debugParamFloat0

float VisualTrackerConfigParams::m_debugParamFloat0

First floating-point debugging parameter.

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

◆ m_debugParamFloat1

float VisualTrackerConfigParams::m_debugParamFloat1

Second floating-point debugging parameter.

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

◆ m_debugParamFloat2

float VisualTrackerConfigParams::m_debugParamFloat2

Third floating-point debugging parameter.

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

◆ m_debugParamInt0

int VisualTrackerConfigParams::m_debugParamInt0

First integer debugging parameter.

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

◆ m_debugParamInt1

int VisualTrackerConfigParams::m_debugParamInt1

Second integer debugging parameter.

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

◆ m_debugParamInt2

int VisualTrackerConfigParams::m_debugParamInt2

Third integer debugging parameter.

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

◆ m_debugVerboseLevel

int VisualTrackerConfigParams::m_debugVerboseLevel

Debug message verbose mode level.

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

◆ m_debugVerboseLevel_cufft

int VisualTrackerConfigParams::m_debugVerboseLevel_cufft

Debug verbosity level for cuFFT.

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

◆ m_debugVerboseLevel_gpumemory

int VisualTrackerConfigParams::m_debugVerboseLevel_gpumemory

GPU memory debug verbosity level.

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

◆ m_featureFocusOffsetFactor_y

float VisualTrackerConfigParams::m_featureFocusOffsetFactor_y

Vertical Hanning-window center offset relative to the feature height.

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

◆ m_featureImgSize

float VisualTrackerConfigParams::m_featureImgSize

Maximum template length in one dimension.

The maximum template area is m_featureImgSize squared, and the actual feature size is divided by m_hogCellSize.

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

◆ m_filterChannelWeightsLr

float VisualTrackerConfigParams::m_filterChannelWeightsLr

Learning rate for DCF filter channel weights in exponential moving average.

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

◆ m_filterLr

float VisualTrackerConfigParams::m_filterLr

Learning rate for DCF filter in exponential moving average.

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

◆ m_gaussianSigma

float VisualTrackerConfigParams::m_gaussianSigma

Sigma for Gaussian for desired response.

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

◆ m_generateTrackerVisualization

bool VisualTrackerConfigParams::m_generateTrackerVisualization

Enables tracker visualization generation.

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

◆ m_hogCellSize

int VisualTrackerConfigParams::m_hogCellSize

Cell size of HOG feature.

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

◆ m_isInit

bool VisualTrackerConfigParams::m_isInit = false

Indicates whether the parameters have been initialized.

Prevents changing static params in dynamic updates.

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

◆ m_lambda

float VisualTrackerConfigParams::m_lambda

Regularization factor used in DCF filter creation.

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

◆ m_minConfidence4SegmentationFilter

float VisualTrackerConfigParams::m_minConfidence4SegmentationFilter

Minimum confidence for using a segmentation mask during filter learning.

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

◆ m_modelMaskingWindowFactor

float VisualTrackerConfigParams::m_modelMaskingWindowFactor

Masking-window factor used for focused filter learning.

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

◆ m_peakCorrLr

float VisualTrackerConfigParams::m_peakCorrLr

Learning rate for peak correlation response in exponential moving average.

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

◆ m_showGpuTiming

int VisualTrackerConfigParams::m_showGpuTiming

Controls whether GPU timing is displayed.

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

◆ m_useColorNames

bool VisualTrackerConfigParams::m_useColorNames

Enables the ColorNames feature.

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

◆ m_useCpuBackends4VPI

bool VisualTrackerConfigParams::m_useCpuBackends4VPI

Enables CPU backends for VPI instead of CUDA.

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

◆ m_useGray

bool VisualTrackerConfigParams::m_useGray

Enables the grayscale pixel-intensity feature.

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

◆ m_useHighPrecisionFeature

bool VisualTrackerConfigParams::m_useHighPrecisionFeature

Enables high-precision 16-bit VPI output instead of low-precision 8-bit output.

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

◆ m_useHog

bool VisualTrackerConfigParams::m_useHog

Enables the HOG feature.

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

◆ m_useRgb

bool VisualTrackerConfigParams::m_useRgb

Enables the RGB feature.

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

◆ m_visualTrackerType

VISUAL_TRACKER_TYPES VisualTrackerConfigParams::m_visualTrackerType

The type of visual tracker.

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

Referenced by VisualTracker::getVisualTrackerType().

◆ m_vizDebugStreamId

int VisualTrackerConfigParams::m_vizDebugStreamId

Video stream ID selected for visualization debugging.

A negative ID such as -1 selects all streams.

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

Referenced by TrackerVizOutput::writeSrcImagePatchesWithCorrResp(), and TrackerVizOutput::writeSrcImagePatchesWithMaskFilter().

◆ m_vizJpegImageQuality

int VisualTrackerConfigParams::m_vizJpegImageQuality

JPEG output quality in the range [1, 100].

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

◆ m_vizOutDirectory

std::string VisualTrackerConfigParams::m_vizOutDirectory

The directory to write the outputs.

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

◆ m_vizWriteAllTrajectoriesOnEveryFrame

bool VisualTrackerConfigParams::m_vizWriteAllTrajectoriesOnEveryFrame

Write the whole frame with trajectories of all targets in the scene.

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

◆ m_vizWriteBirdsEyeView

bool VisualTrackerConfigParams::m_vizWriteBirdsEyeView

Write the bird's-eye view.

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

◆ m_vizWriteEachCompletedTrajectory

bool VisualTrackerConfigParams::m_vizWriteEachCompletedTrajectory

Write each completed trajectory.

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

◆ m_vizWriteSegMask

bool VisualTrackerConfigParams::m_vizWriteSegMask

Save the filter mask generated by the segmenter.

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

◆ m_vizWriteSrcImgPatchesAndCorrResp

bool VisualTrackerConfigParams::m_vizWriteSrcImgPatchesAndCorrResp

Write the cropped/scaled image patches and correlation response.

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

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

sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/VisualTracker.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

◆ VisualTrackerConfigParams() [1/6]

◆ VisualTrackerConfigParams() [2/6]

◆ VisualTrackerConfigParams() [3/6]

◆ VisualTrackerConfigParams() [4/6]

◆ VisualTrackerConfigParams() [5/6]

◆ VisualTrackerConfigParams() [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_cufftHandleQuantFactor

◆ m_debugParamFloat0

◆ m_debugParamFloat1

◆ m_debugParamFloat2

◆ m_debugParamInt0

◆ m_debugParamInt1

◆ m_debugParamInt2

◆ m_debugVerboseLevel

◆ m_debugVerboseLevel_cufft

◆ m_debugVerboseLevel_gpumemory

◆ m_featureFocusOffsetFactor_y

◆ m_featureImgSize

◆ m_filterChannelWeightsLr

◆ m_filterLr

◆ m_gaussianSigma

◆ m_generateTrackerVisualization

◆ m_hogCellSize

◆ m_isInit

◆ m_lambda

◆ m_minConfidence4SegmentationFilter

◆ m_modelMaskingWindowFactor

◆ m_peakCorrLr

◆ m_showGpuTiming

◆ m_useColorNames

◆ m_useCpuBackends4VPI

◆ m_useGray

◆ m_useHighPrecisionFeature

◆ m_useHog

◆ m_useRgb

◆ m_visualTrackerType

◆ m_vizDebugStreamId

◆ m_vizJpegImageQuality

◆ m_vizOutDirectory

◆ m_vizWriteAllTrajectoriesOnEveryFrame

◆ m_vizWriteBirdsEyeView

◆ m_vizWriteEachCompletedTrajectory

◆ m_vizWriteSegMask

◆ m_vizWriteSrcImgPatchesAndCorrResp