NVIDIA DeepStream SDK API Reference
9.2 Release
Public Member Functions
IDataAssociator Class Referenceabstract

Detailed Description

Define the interface for associating detections with tracked targets.

Definition at line 30 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/IDataAssociator.hpp.

Inheritance diagram for IDataAssociator:
Inheritance graph
[legend]

Public Member Functions

virtual ~IDataAssociator ()
 Destroy the data-associator interface. More...
 
virtual void initialize (const SourceFrameInfo &frameInfo, const uint32_t maxTargetsPerStream, const bool useVisualTracker=false, const bool useReid=false)=0
 Initialize the data associator. More...
 
virtual assocDataOut_t associatePerStream (const assocDataIn_t in)=0
 Associate detections with existing targets for one stream. More...
 
virtual bool isInitialized ()=0
 Return whether the data associator has been initialized. More...
 
virtual const DATA_ASSOCIATOR_TYPES getDataAssociatorType ()=0
 Return the configured data-associator type. More...
 
virtual void updateParams (const YAML::Node &fn)=0
 Update dynamic parameters during runtime. More...
 
virtual ~IDataAssociator ()
 Destroy the data-associator interface. More...
 
virtual void initialize (const SourceFrameInfo &frameInfo, const uint32_t maxTargetsPerStream, const bool useVisualTracker=false, const bool useReid=false)=0
 Initialize the data associator. More...
 
virtual assocDataOut_t associatePerStream (const assocDataIn_t in)=0
 Associate detections with existing targets for one stream. More...
 
virtual bool isInitialized ()=0
 Return whether the data associator has been initialized. More...
 
virtual const DATA_ASSOCIATOR_TYPES getDataAssociatorType ()=0
 Return the configured data-associator type. More...
 
virtual void updateParams (const YAML::Node &fn)=0
 Update dynamic parameters during runtime. More...
 

Constructor & Destructor Documentation

◆ ~IDataAssociator() [1/2]

virtual IDataAssociator::~IDataAssociator ( )
inlinevirtual

Destroy the data-associator interface.

Definition at line 34 of file sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/IDataAssociator.hpp.

◆ ~IDataAssociator() [2/2]

virtual IDataAssociator::~IDataAssociator ( )
inlinevirtual

Destroy the data-associator interface.

Definition at line 34 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/DataAssociator/IDataAssociator.hpp.

Member Function Documentation

◆ associatePerStream() [1/2]

virtual assocDataOut_t IDataAssociator::associatePerStream ( const assocDataIn_t  in)
pure virtual

Associate detections with existing targets for one stream.

Parameters
[in]inNewly detected object bounding boxes and existing targets.
Returns
(1) matched pairs, (2) unmatched detector bboxes, and (3) unmatched targets.

Implemented in DataAssociator, and DataAssociator.

◆ associatePerStream() [2/2]

virtual assocDataOut_t IDataAssociator::associatePerStream ( const assocDataIn_t  in)
pure virtual

Associate detections with existing targets for one stream.

Parameters
[in]inNewly detected object bounding boxes and existing targets.
Returns
(1) matched pairs, (2) unmatched detector bboxes, and (3) unmatched targets.

Implemented in DataAssociator, and DataAssociator.

◆ getDataAssociatorType() [1/2]

virtual const DATA_ASSOCIATOR_TYPES IDataAssociator::getDataAssociatorType ( )
pure virtual

Return the configured data-associator type.

Implemented in DataAssociator, and DataAssociator.

◆ getDataAssociatorType() [2/2]

virtual const DATA_ASSOCIATOR_TYPES IDataAssociator::getDataAssociatorType ( )
pure virtual

Return the configured data-associator type.

Implemented in DataAssociator, and DataAssociator.

◆ initialize() [1/2]

virtual void IDataAssociator::initialize ( const SourceFrameInfo &  frameInfo,
const uint32_t  maxTargetsPerStream,
const bool  useVisualTracker = false,
const bool  useReid = false 
)
pure virtual

Initialize the data associator.

Parameters
[in]frameInfoMetadata about the source image (e.g., size, color).
[in]maxTargetsPerStreamThe max number of targets to track per stream.
[in]useVisualTrackerWhether visual-tracker similarity is used.
[in]useReidWhether ReID similarity is used.

Implemented in DataAssociator, and DataAssociator.

◆ initialize() [2/2]

virtual void IDataAssociator::initialize ( const SourceFrameInfo &  frameInfo,
const uint32_t  maxTargetsPerStream,
const bool  useVisualTracker = false,
const bool  useReid = false 
)
pure virtual

Initialize the data associator.

Parameters
[in]frameInfoMetadata about the source image (e.g., size, color).
[in]maxTargetsPerStreamThe max number of targets to track per stream.
[in]useVisualTrackerWhether visual-tracker similarity is used.
[in]useReidWhether ReID similarity is used.

Implemented in DataAssociator, and DataAssociator.

◆ isInitialized() [1/2]

virtual bool IDataAssociator::isInitialized ( )
pure virtual

Return whether the data associator has been initialized.

Implemented in DataAssociator, and DataAssociator.

◆ isInitialized() [2/2]

virtual bool IDataAssociator::isInitialized ( )
pure virtual

Return whether the data associator has been initialized.

Implemented in DataAssociator, and DataAssociator.

◆ updateParams() [1/2]

virtual void IDataAssociator::updateParams ( const YAML::Node &  fn)
pure virtual

Update dynamic parameters during runtime.

Parameters
[in]fnParsed YAML structure of config to update.

Implemented in DataAssociator, and DataAssociator.

◆ updateParams() [2/2]

virtual void IDataAssociator::updateParams ( const YAML::Node &  fn)
pure virtual

Update dynamic parameters during runtime.

Parameters
[in]fnParsed YAML structure of config to update.

Implemented in DataAssociator, and DataAssociator.

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