NVIDIA DeepStream SDK API Reference

9.2 Release
ReIDServiceConfigParams Class Reference

Detailed Description

Stores configuration for the remote ReID service.

Definition at line 27 of file sources/libs/nvmultiobjecttracker/include/modules/ReIDService/ReIDService.hpp.

Inheritance diagram for ReIDServiceConfigParams:
Collaboration diagram for ReIDServiceConfigParams:

Public Member Functions

 ReIDServiceConfigParams ()
 Construct a ReIDServiceConfigParams instance. More...
 
 ReIDServiceConfigParams (const std::string &configFilePath, const std::string moduleName)
 Construct a ReIDServiceConfigParams instance. More...
 
 ReIDServiceConfigParams (const YAML::Node &fn)
 Construct a ReIDServiceConfigParams instance. More...
 
void read (const YAML::Node &fn) override
 Load configuration values from a YAML node. More...
 
 ReIDServiceConfigParams ()
 Construct a ReIDServiceConfigParams instance. More...
 
 ReIDServiceConfigParams (const std::string &configFilePath, const std::string moduleName)
 Construct a ReIDServiceConfigParams instance. More...
 
 ReIDServiceConfigParams (const YAML::Node &fn)
 Construct a ReIDServiceConfigParams 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

REID_SERVICE_TYPES m_reidServiceType
 Type of reid service. More...
 
int m_debugVerboseLevel
 Debug message verbose mode level. More...
 
bool m_enableBlocking
 Whether to enable blocking mode. More...
 
float m_minTopClusterConfidence
 Minimum confidence for top cluster to be considered for reid service association. More...
 
float m_minSecondClusterConfidence
 Minimum confidence for second cluster to be considered for ambiguity checking. More...
 
float m_maxClusterVariance
 Maximum cluster variance to be considered for reid service association. More...
 
int m_topK
 Maximum number of object ids to be returned by reid service association. More...
 
int m_maxGroupCount
 Maximum number of vectors per object id to be considered for reid service association. More...
 
float m_minVisibility4ReidServiceQuery
 Minimum visibility for reid service association query. More...
 
std::string m_serviceAddress
 Address/hostname for the reid service. More...
 
int m_servicePort
 Port for the reid service. More...
 
std::vector< int > m_operateOnClassIds
 Class IDs used for ReID service association. An empty list enables association for all classes. More...
 
bool m_enableIDCorrection
 Whether to enable ID correction. More...
 
int m_minAssociationCount4IDCorrection
 Minimum number of successful associations for ID correction. More...
 
float m_maxIou4IDCorrection
 Maximum IOU for ID correction. More...
 
int m_maxInFlightRequests
 Maximum number of in-flight requests, requests beyond this are dropped. More...
 
int m_curlConnectTimeout
 CURL connect timeout in seconds. More...
 
int m_curlRequestTimeout
 CURL request timeout in seconds. More...
 

Constructor & Destructor Documentation

◆ ReIDServiceConfigParams() [1/6]

ReIDServiceConfigParams::ReIDServiceConfigParams ( )

Construct a ReIDServiceConfigParams instance.

◆ ReIDServiceConfigParams() [2/6]

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

Construct a ReIDServiceConfigParams instance.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]moduleNameConfiguration module name.

◆ ReIDServiceConfigParams() [3/6]

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

Construct a ReIDServiceConfigParams instance.

Parameters
[in]fnParsed YAML node.

◆ ReIDServiceConfigParams() [4/6]

ReIDServiceConfigParams::ReIDServiceConfigParams ( )

Construct a ReIDServiceConfigParams instance.

◆ ReIDServiceConfigParams() [5/6]

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

Construct a ReIDServiceConfigParams instance.

Parameters
[in]configFilePathPath to the tracker configuration file.
[in]moduleNameConfiguration module name.

◆ ReIDServiceConfigParams() [6/6]

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

Construct a ReIDServiceConfigParams instance.

Parameters
[in]fnParsed YAML node.

Member Function Documentation

◆ getConfigRoot() [1/2]

static const YAML::Node NvTrackerParams::getConfigRoot ( const std::string &  configFilePath,
const bool  printMessage = false 
)
inlinestaticinherited

◆ 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]configFilePathPath to the tracker configuration file.
[in]printMessageEnables 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 ReIDServiceConfigParams::read ( const YAML::Node &  fn)
overridevirtual

Load configuration values from a YAML node.

Parameters
[in]fnParsed YAML node.

Implements NvTrackerParams.

◆ read() [2/2]

void ReIDServiceConfigParams::read ( const YAML::Node &  fn)
overridevirtual

Load configuration values from a YAML node.

Parameters
[in]fnParsed 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]configFilePathPath to the tracker configuration file.
[in]filePathAbsolute 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]configFilePathPath to the tracker configuration file.
[in]filePathAbsolute 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_curlConnectTimeout

int ReIDServiceConfigParams::m_curlConnectTimeout

CURL connect timeout in seconds.

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

◆ m_curlRequestTimeout

int ReIDServiceConfigParams::m_curlRequestTimeout

CURL request timeout in seconds.

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

◆ m_debugVerboseLevel

int ReIDServiceConfigParams::m_debugVerboseLevel

Debug message verbose mode level.

Definition at line 53 of file sources/libs/nvmultiobjecttracker/include/modules/ReIDService/ReIDService.hpp.

◆ m_enableBlocking

bool ReIDServiceConfigParams::m_enableBlocking

Whether to enable blocking mode.

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

◆ m_enableIDCorrection

bool ReIDServiceConfigParams::m_enableIDCorrection

Whether to enable ID correction.

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

◆ m_maxClusterVariance

float ReIDServiceConfigParams::m_maxClusterVariance

Maximum cluster variance to be considered for reid service association.

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

◆ m_maxGroupCount

int ReIDServiceConfigParams::m_maxGroupCount

Maximum number of vectors per object id to be considered for reid service association.

Definition at line 59 of file sources/libs/nvmultiobjecttracker/include/modules/ReIDService/ReIDService.hpp.

◆ m_maxInFlightRequests

int ReIDServiceConfigParams::m_maxInFlightRequests

Maximum number of in-flight requests, requests beyond this are dropped.

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

◆ m_maxIou4IDCorrection

float ReIDServiceConfigParams::m_maxIou4IDCorrection

Maximum IOU for ID correction.

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

◆ m_minAssociationCount4IDCorrection

int ReIDServiceConfigParams::m_minAssociationCount4IDCorrection

Minimum number of successful associations for ID correction.

Definition at line 65 of file sources/libs/nvmultiobjecttracker/include/modules/ReIDService/ReIDService.hpp.

◆ m_minSecondClusterConfidence

float ReIDServiceConfigParams::m_minSecondClusterConfidence

Minimum confidence for second cluster to be considered for ambiguity checking.

Definition at line 56 of file sources/libs/nvmultiobjecttracker/include/modules/ReIDService/ReIDService.hpp.

◆ m_minTopClusterConfidence

float ReIDServiceConfigParams::m_minTopClusterConfidence

Minimum confidence for top cluster to be considered for reid service association.

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

◆ m_minVisibility4ReidServiceQuery

float ReIDServiceConfigParams::m_minVisibility4ReidServiceQuery

Minimum visibility for reid service association query.

Definition at line 60 of file sources/libs/nvmultiobjecttracker/include/modules/ReIDService/ReIDService.hpp.

◆ m_operateOnClassIds

std::vector< int > ReIDServiceConfigParams::m_operateOnClassIds

Class IDs used for ReID service association. An empty list enables association for all classes.

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

◆ m_reidServiceType

REID_SERVICE_TYPES ReIDServiceConfigParams::m_reidServiceType

◆ m_serviceAddress

std::string ReIDServiceConfigParams::m_serviceAddress

Address/hostname for the reid service.

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

◆ m_servicePort

int ReIDServiceConfigParams::m_servicePort

Port for the reid service.

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

◆ m_topK

int ReIDServiceConfigParams::m_topK

Maximum number of object ids to be returned by reid service association.

Definition at line 58 of file sources/libs/nvmultiobjecttracker/include/modules/ReIDService/ReIDService.hpp.


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