NVIDIA DeepStream SDK API Reference

9.2 Release
IBatchLocalizer Class Referenceabstract

Detailed Description

Defines batched multi-stream tracker operations.

Definition at line 30 of file sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/localizer.hpp.

Inheritance diagram for IBatchLocalizer:

Public Member Functions

 IBatchLocalizer ()
 Initialize the batch-localizer interface. More...
 
virtual ~IBatchLocalizer ()
 Release the batch-localizer interface. More...
 
virtual bool isInitialized ()=0
 Report whether the batch localizer is initialized. More...
 
virtual void initialize (const NvMotDataTypes::Size srcImgSize, const size_t srcImgPitch)=0
 Initialize the batch localizer for the tracker input surface. More...
 
virtual void queryParams (NvMOTQuery &paramsQuery)=0
 Populate tracker capability and memory requirement fields. More...
 
virtual void update (const std::map< NvMOTStreamId, NvMOTFrame * > &nvFramesInBatch, NvMOTTrackedObjBatch *&pTrackedObjectsBatch)=0
 Perform tracking. More...
 
virtual void outputPastFrameObjs (const std::set< NvMOTStreamId > videoStreamIdList, NvDsTargetMiscDataBatch *&pPastFrameObjBatch)=0
 Output past-frame tracking data and clear the corresponding buffers. More...
 
virtual void outputTerminatedObjs (const std::set< NvMOTStreamId > videoStreamIdList, NvDsTargetMiscDataBatch *&pPastFrameObjBatch)=0
 Output complete frame history for terminated tracks and clear the buffer. More...
 
virtual void outputShadowObj (const std::set< NvMOTStreamId > videoStreamIdList, NvDsTargetMiscDataBatch *&pShadowTracksBatch)=0
 Output the most recent frame for current shadow tracks and clear the buffer. More...
 
virtual void deleteRemovedStreamTrackers (const NvMOTStreamId videoStreamID)=0
 Delete trackers and per-stream resources when a stream is removed. More...
 
virtual void updateParams (const std::string &configStr)=0
 Apply supported runtime tracker configuration updates. More...
 
 IBatchLocalizer ()
 Initialize the batch-localizer interface. More...
 
virtual ~IBatchLocalizer ()
 Release the batch-localizer interface. More...
 
virtual bool isInitialized ()=0
 Report whether the batch localizer is initialized. More...
 
virtual void initialize (const NvMotDataTypes::Size srcImgSize, const size_t srcImgPitch)=0
 Initialize the batch localizer for the tracker input surface. More...
 
virtual void queryParams (NvMOTQuery &paramsQuery)=0
 Populate tracker capability and memory requirement fields. More...
 
virtual void update (const std::map< NvMOTStreamId, NvMOTFrame * > &nvFramesInBatch, NvMOTTrackedObjBatch *&pTrackedObjectsBatch)=0
 Perform tracking. More...
 
virtual void outputPastFrameObjs (const std::set< NvMOTStreamId > videoStreamIdList, NvDsTargetMiscDataBatch *&pPastFrameObjBatch)=0
 Output past-frame tracking data and clear the corresponding buffers. More...
 
virtual void outputTerminatedObjs (const std::set< NvMOTStreamId > videoStreamIdList, NvDsTargetMiscDataBatch *&pPastFrameObjBatch)=0
 Output complete frame history for terminated tracks and clear the buffer. More...
 
virtual void outputShadowObj (const std::set< NvMOTStreamId > videoStreamIdList, NvDsTargetMiscDataBatch *&pShadowTracksBatch)=0
 Output the most recent frame for current shadow tracks and clear the buffer. More...
 
virtual void deleteRemovedStreamTrackers (const NvMOTStreamId videoStreamID)=0
 Delete trackers and per-stream resources when a stream is removed. More...
 
virtual void updateParams (const std::string &configStr)=0
 Apply supported runtime tracker configuration updates. More...
 

Constructor & Destructor Documentation

◆ IBatchLocalizer() [1/2]

IBatchLocalizer::IBatchLocalizer ( )
inline

Initialize the batch-localizer interface.

Definition at line 34 of file sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/localizer.hpp.

◆ ~IBatchLocalizer() [1/2]

virtual IBatchLocalizer::~IBatchLocalizer ( )
inlinevirtual

Release the batch-localizer interface.

Definition at line 37 of file sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/localizer.hpp.

◆ IBatchLocalizer() [2/2]

IBatchLocalizer::IBatchLocalizer ( )
inline

Initialize the batch-localizer interface.

Definition at line 34 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/localizer.hpp.

◆ ~IBatchLocalizer() [2/2]

virtual IBatchLocalizer::~IBatchLocalizer ( )
inlinevirtual

Release the batch-localizer interface.

Definition at line 37 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/NvMultiObjectTracker/localizer.hpp.

Member Function Documentation

◆ deleteRemovedStreamTrackers() [1/2]

virtual void IBatchLocalizer::deleteRemovedStreamTrackers ( const NvMOTStreamId  videoStreamID)
pure virtual

Delete trackers and per-stream resources when a stream is removed.

Parameters
[in]videoStreamIDStream ID whose trackers are removed.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ deleteRemovedStreamTrackers() [2/2]

virtual void IBatchLocalizer::deleteRemovedStreamTrackers ( const NvMOTStreamId  videoStreamID)
pure virtual

Delete trackers and per-stream resources when a stream is removed.

Parameters
[in]videoStreamIDStream ID whose trackers are removed.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ initialize() [1/2]

virtual void IBatchLocalizer::initialize ( const NvMotDataTypes::Size  srcImgSize,
const size_t  srcImgPitch 
)
pure virtual

Initialize the batch localizer for the tracker input surface.

Parameters
[in]srcImgSizeSource image size.
[in]srcImgPitchSource image row pitch in bytes.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ initialize() [2/2]

virtual void IBatchLocalizer::initialize ( const NvMotDataTypes::Size  srcImgSize,
const size_t  srcImgPitch 
)
pure virtual

Initialize the batch localizer for the tracker input surface.

Parameters
[in]srcImgSizeSource image size.
[in]srcImgPitchSource image row pitch in bytes.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ isInitialized() [1/2]

virtual bool IBatchLocalizer::isInitialized ( )
pure virtual

Report whether the batch localizer is initialized.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ isInitialized() [2/2]

virtual bool IBatchLocalizer::isInitialized ( )
pure virtual

Report whether the batch localizer is initialized.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ outputPastFrameObjs() [1/2]

virtual void IBatchLocalizer::outputPastFrameObjs ( const std::set< NvMOTStreamId >  videoStreamIdList,
NvDsTargetMiscDataBatch *&  pPastFrameObjBatch 
)
pure virtual

Output past-frame tracking data and clear the corresponding buffers.

Parameters
[in]videoStreamIdListStream IDs whose past-frame tracking data is reported.
[in,out]pPastFrameObjBatchCaller-allocated batch that receives the past-frame objects.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ outputPastFrameObjs() [2/2]

virtual void IBatchLocalizer::outputPastFrameObjs ( const std::set< NvMOTStreamId >  videoStreamIdList,
NvDsTargetMiscDataBatch *&  pPastFrameObjBatch 
)
pure virtual

Output past-frame tracking data and clear the corresponding buffers.

Parameters
[in]videoStreamIdListStream IDs whose past-frame tracking data is reported.
[in,out]pPastFrameObjBatchCaller-allocated batch that receives the past-frame objects.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ outputShadowObj() [1/2]

virtual void IBatchLocalizer::outputShadowObj ( const std::set< NvMOTStreamId >  videoStreamIdList,
NvDsTargetMiscDataBatch *&  pShadowTracksBatch 
)
pure virtual

Output the most recent frame for current shadow tracks and clear the buffer.

Parameters
[in]videoStreamIdListStream IDs whose shadow tracks are reported.
[in,out]pShadowTracksBatchCaller-allocated batch that receives the latest shadow-track frame.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ outputShadowObj() [2/2]

virtual void IBatchLocalizer::outputShadowObj ( const std::set< NvMOTStreamId >  videoStreamIdList,
NvDsTargetMiscDataBatch *&  pShadowTracksBatch 
)
pure virtual

Output the most recent frame for current shadow tracks and clear the buffer.

Parameters
[in]videoStreamIdListStream IDs whose shadow tracks are reported.
[in,out]pShadowTracksBatchCaller-allocated batch that receives the latest shadow-track frame.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ outputTerminatedObjs() [1/2]

virtual void IBatchLocalizer::outputTerminatedObjs ( const std::set< NvMOTStreamId >  videoStreamIdList,
NvDsTargetMiscDataBatch *&  pPastFrameObjBatch 
)
pure virtual

Output complete frame history for terminated tracks and clear the buffer.

Parameters
[in]videoStreamIdListStream IDs whose terminated tracks are reported.
[in,out]pPastFrameObjBatchCaller-allocated batch that receives the terminated-track history.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ outputTerminatedObjs() [2/2]

virtual void IBatchLocalizer::outputTerminatedObjs ( const std::set< NvMOTStreamId >  videoStreamIdList,
NvDsTargetMiscDataBatch *&  pPastFrameObjBatch 
)
pure virtual

Output complete frame history for terminated tracks and clear the buffer.

Parameters
[in]videoStreamIdListStream IDs whose terminated tracks are reported.
[in,out]pPastFrameObjBatchCaller-allocated batch that receives the terminated-track history.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ queryParams() [1/2]

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

Populate tracker capability and memory requirement fields.

Parameters
[out]paramsQueryQuery structure populated with tracker requirements.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ queryParams() [2/2]

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

Populate tracker capability and memory requirement fields.

Parameters
[out]paramsQueryQuery structure populated with tracker requirements.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ update() [1/2]

virtual void IBatchLocalizer::update ( const std::map< NvMOTStreamId, NvMOTFrame * > &  nvFramesInBatch,
NvMOTTrackedObjBatch *&  pTrackedObjectsBatch 
)
pure virtual

Perform tracking.

Parameters
[in]nvFramesInBatchSource frames and detector bboxes keyed by video stream ID.
[in,out]pTrackedObjectsBatchCaller-allocated batch filled with tracked objects for this frame batch.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ update() [2/2]

virtual void IBatchLocalizer::update ( const std::map< NvMOTStreamId, NvMOTFrame * > &  nvFramesInBatch,
NvMOTTrackedObjBatch *&  pTrackedObjectsBatch 
)
pure virtual

Perform tracking.

Parameters
[in]nvFramesInBatchSource frames and detector bboxes keyed by video stream ID.
[in,out]pTrackedObjectsBatchCaller-allocated batch filled with tracked objects for this frame batch.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ updateParams() [1/2]

virtual void IBatchLocalizer::updateParams ( const std::string &  configStr)
pure virtual

Apply supported runtime tracker configuration updates.

Parameters
[in]configStrStringified YAML configuration parameters to update.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.

◆ updateParams() [2/2]

virtual void IBatchLocalizer::updateParams ( const std::string &  configStr)
pure virtual

Apply supported runtime tracker configuration updates.

Parameters
[in]configStrStringified YAML configuration parameters to update.

Implemented in NvMultiObjectTrackerBase, and NvMultiObjectTrackerBase.


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