NVIDIA DeepStream SDK API Reference

9.2 Release
IVisualTracker Class Referenceabstract

Detailed Description

Defines the interface implemented by visual trackers.

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

Inheritance diagram for IVisualTracker:

Public Member Functions

virtual ~IVisualTracker ()
 Destroy the visual tracker interface. More...
 
virtual void initialize (const SourceFrameInfo &frameInfo, const uint maxTargetsToTrack, const uint maxTargetsPerStream, const std::shared_ptr< NvTrackedObjectManager > &targetManager)=0
 Initialize variables and allocate memories. More...
 
virtual void queryParams (NvMOTQuery &paramsQuery)=0
 Populate the visual tracker's capability query. More...
 
virtual void localize (const std::map< NvMOTStreamId, NvMOTFrame * > inputMeta, const std::map< NvMOTStreamId, std::deque< DetectedObjInfo >> &detectedObjects)=0
 Localize tracked targets and evaluate nearby detections across an input batch. More...
 
virtual void update (const std::map< NvMOTStreamId, NvMOTFrame * > inputMeta)=0
 Update each target's visual model from an input batch. More...
 
virtual bool isInitialized ()=0
 Report whether tracker initialization completed. More...
 
virtual const VISUAL_TRACKER_TYPES getVisualTrackerType ()=0
 Return the configured visual tracker type. More...
 
virtual void updateParams (const YAML::Node &fn)=0
 Update runtime-configurable visual tracker parameters. More...
 
virtual ~IVisualTracker ()
 Destroy the visual tracker interface. More...
 
virtual void initialize (const SourceFrameInfo &frameInfo, const uint maxTargetsToTrack, const uint maxTargetsPerStream, const std::shared_ptr< NvTrackedObjectManager > &targetManager)=0
 Initialize variables and allocate memories. More...
 
virtual void queryParams (NvMOTQuery &paramsQuery)=0
 Populate the visual tracker's capability query. More...
 
virtual void localize (const std::map< NvMOTStreamId, NvMOTFrame * > inputMeta, const std::map< NvMOTStreamId, std::deque< DetectedObjInfo >> &detectedObjects)=0
 Localize tracked targets and evaluate nearby detections across an input batch. More...
 
virtual void update (const std::map< NvMOTStreamId, NvMOTFrame * > inputMeta)=0
 Update each target's visual model from an input batch. More...
 
virtual bool isInitialized ()=0
 Report whether tracker initialization completed. More...
 
virtual const VISUAL_TRACKER_TYPES getVisualTrackerType ()=0
 Return the configured visual tracker type. More...
 
virtual void updateParams (const YAML::Node &fn)=0
 Update runtime-configurable visual tracker parameters. More...
 

Constructor & Destructor Documentation

◆ ~IVisualTracker() [1/2]

virtual IVisualTracker::~IVisualTracker ( )
inlinevirtual

Destroy the visual tracker interface.

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

◆ ~IVisualTracker() [2/2]

virtual IVisualTracker::~IVisualTracker ( )
inlinevirtual

Destroy the visual tracker interface.

Definition at line 39 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/VisualTracker/IVisualTracker.hpp.

Member Function Documentation

◆ getVisualTrackerType() [1/2]

virtual const VISUAL_TRACKER_TYPES IVisualTracker::getVisualTrackerType ( )
pure virtual

Return the configured visual tracker type.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ getVisualTrackerType() [2/2]

virtual const VISUAL_TRACKER_TYPES IVisualTracker::getVisualTrackerType ( )
pure virtual

Return the configured visual tracker type.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ initialize() [1/2]

virtual void IVisualTracker::initialize ( const SourceFrameInfo &  frameInfo,
const uint  maxTargetsToTrack,
const uint  maxTargetsPerStream,
const std::shared_ptr< NvTrackedObjectManager > &  targetManager 
)
pure virtual

Initialize variables and allocate memories.

Parameters
[in]frameInfoMetadata about the source image (e.g., size, color).
[in]maxTargetsToTrackThe maximum number of targets to track.
[in]maxTargetsPerStreamThe maximum number of targets to track per stream.
[in]targetManagerThe target manager through which all the targets can be accessed.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ initialize() [2/2]

virtual void IVisualTracker::initialize ( const SourceFrameInfo &  frameInfo,
const uint  maxTargetsToTrack,
const uint  maxTargetsPerStream,
const std::shared_ptr< NvTrackedObjectManager > &  targetManager 
)
pure virtual

Initialize variables and allocate memories.

Parameters
[in]frameInfoMetadata about the source image (e.g., size, color).
[in]maxTargetsToTrackThe maximum number of targets to track.
[in]maxTargetsPerStreamThe maximum number of targets to track per stream.
[in]targetManagerThe target manager through which all the targets can be accessed.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ isInitialized() [1/2]

virtual bool IVisualTracker::isInitialized ( )
pure virtual

Report whether tracker initialization completed.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ isInitialized() [2/2]

virtual bool IVisualTracker::isInitialized ( )
pure virtual

Report whether tracker initialization completed.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ localize() [1/2]

virtual void IVisualTracker::localize ( const std::map< NvMOTStreamId, NvMOTFrame * >  inputMeta,
const std::map< NvMOTStreamId, std::deque< DetectedObjInfo >> &  detectedObjects 
)
pure virtual

Localize tracked targets and evaluate nearby detections across an input batch.

Parameters
[in]inputMetaA batch of input frames.
[in]detectedObjectsThe list of newly-detected objects.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ localize() [2/2]

virtual void IVisualTracker::localize ( const std::map< NvMOTStreamId, NvMOTFrame * >  inputMeta,
const std::map< NvMOTStreamId, std::deque< DetectedObjInfo >> &  detectedObjects 
)
pure virtual

Localize tracked targets and evaluate nearby detections across an input batch.

Parameters
[in]inputMetaA batch of input frames.
[in]detectedObjectsThe list of newly-detected objects.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ queryParams() [1/2]

virtual void IVisualTracker::queryParams ( NvMOTQuery &  paramsQuery)
pure virtual

Populate the visual tracker's capability query.

Parameters
[out]paramsQueryThe output query parameters.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ queryParams() [2/2]

virtual void IVisualTracker::queryParams ( NvMOTQuery &  paramsQuery)
pure virtual

Populate the visual tracker's capability query.

Parameters
[out]paramsQueryThe output query parameters.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ update() [1/2]

virtual void IVisualTracker::update ( const std::map< NvMOTStreamId, NvMOTFrame * >  inputMeta)
pure virtual

Update each target's visual model from an input batch.

Parameters
[in]inputMetaA batch of input frames.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ update() [2/2]

virtual void IVisualTracker::update ( const std::map< NvMOTStreamId, NvMOTFrame * >  inputMeta)
pure virtual

Update each target's visual model from an input batch.

Parameters
[in]inputMetaA batch of input frames.

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ updateParams() [1/2]

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

Update runtime-configurable visual tracker parameters.

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

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.

◆ updateParams() [2/2]

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

Update runtime-configurable visual tracker parameters.

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

Implemented in DCFTracker, DCFTracker, VisualTracker, VisualTracker, DummyVisualTracker, and DummyVisualTracker.


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