Detailed Description

Defines the interface for extracting and managing ReID features.

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

Inheritance diagram for IReID:

[legend]

Public Member Functions
virtual	~IReID ()
	Release resources owned by the IReID instance. More...

virtual void	initializeRuntime (const SourceFrameInfo &frameInfo, const uint maxTargetsPerStream, const std::shared_ptr< NvTrackedObjectManager > &targetManager)=0
	Initialize variables and allocate memories. More...

virtual void	initializeModel ()=0
	Create TensorRT inference engine; if engine does not exist, serialize from model file. More...

virtual void	queryParams (NvMOTQuery &paramsQuery)=0
	Populate the capabilities reported to the tracker. More...

virtual void	doInference (const std::map< NvMOTStreamId, NvMOTFrame * > &inputMeta, std::map< NvMOTStreamId, std::deque< DetectedObjInfo >> &detectedObjects, const bool isForReAssoc)=0
	Crop and rescale detected objects to create input batch to reid model. More...

virtual void	update ()=0
	Update ReID feature gallery after data association. More...

virtual void	removeStream (const NvMOTStreamId videoStreamId)=0
	Remove a stream's reid features. More...

virtual void	outputReIDTensor (NvDsReidTensorBatch &reidTensorBatch)=0
	Output the ReID tensor of a batch. More...

virtual int	outputTargetReIDInd (NvMOTStreamId streamId, uint targetInd)=0
	Output a target's ReID vector index in the batch tensor. More...

virtual void	outputTargetReIDObj (NvMOTStreamId streamId, uint targetInd, NvDsReidTensorBatch &reidTensorBatch, NvDsObjReid &reidObj)=0
	Output a target's ReID vector information. More...

virtual bool	isModelInitialized ()=0
	Report whether the inference model is initialized. More...

virtual bool	isRuntimeInitialized ()=0
	Report whether runtime resources are initialized. More...

virtual const REID_TYPES	getReIDType ()=0
	Get the configured ReID implementation type. More...

virtual	~IReID ()
	Release resources owned by the IReID instance. More...

virtual void	initializeRuntime (const SourceFrameInfo &frameInfo, const uint maxTargetsPerStream, const std::shared_ptr< NvTrackedObjectManager > &targetManager)=0
	Initialize variables and allocate memories. More...

virtual void	initializeModel ()=0
	Create TensorRT inference engine; if engine does not exist, serialize from model file. More...

virtual void	queryParams (NvMOTQuery &paramsQuery)=0
	Populate the capabilities reported to the tracker. More...

virtual void	doInference (const std::map< NvMOTStreamId, NvMOTFrame * > &inputMeta, std::map< NvMOTStreamId, std::deque< DetectedObjInfo >> &detectedObjects, const bool isForReAssoc)=0
	Crop and rescale detected objects to create input batch to reid model. More...

virtual void	update ()=0
	Update ReID feature gallery after data association. More...

virtual void	removeStream (const NvMOTStreamId videoStreamId)=0
	Remove a stream's reid features. More...

virtual void	outputReIDTensor (NvDsReidTensorBatch &reidTensorBatch)=0
	Output the ReID tensor of a batch. More...

virtual int	outputTargetReIDInd (NvMOTStreamId streamId, uint targetInd)=0
	Output a target's ReID vector index in the batch tensor. More...

virtual void	outputTargetReIDObj (NvMOTStreamId streamId, uint targetInd, NvDsReidTensorBatch &reidTensorBatch, NvDsObjReid &reidObj)=0
	Output a target's ReID vector information. More...

virtual bool	isModelInitialized ()=0
	Report whether the inference model is initialized. More...

virtual bool	isRuntimeInitialized ()=0
	Report whether runtime resources are initialized. More...

virtual const REID_TYPES	getReIDType ()=0
	Get the configured ReID implementation type. More...

Constructor & Destructor Documentation

◆ ~IReID() [1/2]

virtual IReID::~IReID ( )

inlinevirtual

Release resources owned by the IReID instance.

Definition at line 40 of file sources/libs/nvmultiobjecttracker/include/modules/ReID/IReID.hpp.

◆ ~IReID() [2/2]

virtual IReID::~IReID ( )

inlinevirtual

Release resources owned by the IReID instance.

Definition at line 40 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/ReID/IReID.hpp.

Member Function Documentation

◆ doInference() [1/2]

virtual void IReID::doInference	(	const std::map< NvMOTStreamId, NvMOTFrame * > &	inputMeta,
		std::map< NvMOTStreamId, std::deque< DetectedObjInfo >> &	detectedObjects,
		const bool	isForReAssoc
	)

pure virtual

Crop and rescale detected objects to create input batch to reid model.

Parameters

[in]	inputMeta	A batch of input frames.
[in,out]	detectedObjects	Newly detected objects in each stream.
[in]	isForReAssoc	Whether this inference is for reassociation.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ doInference() [2/2]

virtual void IReID::doInference	(	const std::map< NvMOTStreamId, NvMOTFrame * > &	inputMeta,
		std::map< NvMOTStreamId, std::deque< DetectedObjInfo >> &	detectedObjects,
		const bool	isForReAssoc
	)

pure virtual

Crop and rescale detected objects to create input batch to reid model.

Parameters

[in]	inputMeta	A batch of input frames.
[in,out]	detectedObjects	Newly detected objects in each stream.
[in]	isForReAssoc	Whether this inference is for reassociation.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ getReIDType() [1/2]

virtual const REID_TYPES IReID::getReIDType ( )

pure virtual

Get the configured ReID implementation type.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ getReIDType() [2/2]

virtual const REID_TYPES IReID::getReIDType ( )

pure virtual

Get the configured ReID implementation type.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ initializeModel() [1/2]

virtual void IReID::initializeModel ( )

pure virtual

Create TensorRT inference engine; if engine does not exist, serialize from model file.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ initializeModel() [2/2]

virtual void IReID::initializeModel ( )

pure virtual

Create TensorRT inference engine; if engine does not exist, serialize from model file.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ initializeRuntime() [1/2]

virtual void IReID::initializeRuntime	(	const SourceFrameInfo &	frameInfo,
		const uint	maxTargetsPerStream,
		const std::shared_ptr< NvTrackedObjectManager > &	targetManager
	)

pure virtual

Initialize variables and allocate memories.

Parameters

[in]	frameInfo	Metadata about the source image, such as size and color.
[in]	maxTargetsPerStream	Maximum number of targets to track in each stream.
[in]	targetManager	Target manager of the tracked objects.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ initializeRuntime() [2/2]

virtual void IReID::initializeRuntime	(	const SourceFrameInfo &	frameInfo,
		const uint	maxTargetsPerStream,
		const std::shared_ptr< NvTrackedObjectManager > &	targetManager
	)

pure virtual

Initialize variables and allocate memories.

Parameters

[in]	frameInfo	Metadata about the source image, such as size and color.
[in]	maxTargetsPerStream	Maximum number of targets to track in each stream.
[in]	targetManager	Target manager of the tracked objects.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ isModelInitialized() [1/2]

virtual bool IReID::isModelInitialized ( )

pure virtual

Report whether the inference model is initialized.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ isModelInitialized() [2/2]

virtual bool IReID::isModelInitialized ( )

pure virtual

Report whether the inference model is initialized.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ isRuntimeInitialized() [1/2]

virtual bool IReID::isRuntimeInitialized ( )

pure virtual

Report whether runtime resources are initialized.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ isRuntimeInitialized() [2/2]

virtual bool IReID::isRuntimeInitialized ( )

pure virtual

Report whether runtime resources are initialized.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ outputReIDTensor() [1/2]

virtual void IReID::outputReIDTensor ( NvDsReidTensorBatch & reidTensorBatch )

pure virtual

Output the ReID tensor of a batch.

Parameters

[out] reidTensorBatch Batch reid tensor output to be filled.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ outputReIDTensor() [2/2]

virtual void IReID::outputReIDTensor ( NvDsReidTensorBatch & reidTensorBatch )

pure virtual

Output the ReID tensor of a batch.

Parameters

[out] reidTensorBatch Batch reid tensor output to be filled.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ outputTargetReIDInd() [1/2]

virtual int IReID::outputTargetReIDInd	(	NvMOTStreamId	streamId,
		uint	targetInd
	)

pure virtual

Output a target's ReID vector index in the batch tensor.

Parameters

[in]	streamId	Stream index.
[in]	targetInd	The target index.

Returns: The target's ReID vector index in the batch tensor, -1 means no reid feature.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ outputTargetReIDInd() [2/2]

virtual int IReID::outputTargetReIDInd	(	NvMOTStreamId	streamId,
		uint	targetInd
	)

pure virtual

Output a target's ReID vector index in the batch tensor.

Parameters

[in]	streamId	Stream index.
[in]	targetInd	The target index.

Returns: The target's ReID vector index in the batch tensor, -1 means no reid feature.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ outputTargetReIDObj() [1/2]

virtual void IReID::outputTargetReIDObj	(	NvMOTStreamId	streamId,
		uint	targetInd,
		NvDsReidTensorBatch &	reidTensorBatch,
		NvDsObjReid &	reidObj
	)

pure virtual

Output a target's ReID vector information.

Parameters

[in]	streamId	Stream index.
[in]	targetInd	The target index.
[in]	reidTensorBatch	Batch reid tensor to get the memory pointers.
[out]	reidObj	The target's ReID vector memory pointers and feature size.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ outputTargetReIDObj() [2/2]

virtual void IReID::outputTargetReIDObj	(	NvMOTStreamId	streamId,
		uint	targetInd,
		NvDsReidTensorBatch &	reidTensorBatch,
		NvDsObjReid &	reidObj
	)

pure virtual

Output a target's ReID vector information.

Parameters

[in]	streamId	Stream index.
[in]	targetInd	The target index.
[in]	reidTensorBatch	Batch reid tensor to get the memory pointers.
[out]	reidObj	The target's ReID vector memory pointers and feature size.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ queryParams() [1/2]

virtual void IReID::queryParams ( NvMOTQuery & paramsQuery )

pure virtual

Populate the capabilities reported to the tracker.

Parameters

[out] paramsQuery The output query parameters.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ queryParams() [2/2]

virtual void IReID::queryParams ( NvMOTQuery & paramsQuery )

pure virtual

Populate the capabilities reported to the tracker.

Parameters

[out] paramsQuery The output query parameters.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ removeStream() [1/2]

virtual void IReID::removeStream ( const NvMOTStreamId videoStreamId )

pure virtual

Remove a stream's reid features.

Parameters

[in] videoStreamId Video stream id.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ removeStream() [2/2]

virtual void IReID::removeStream ( const NvMOTStreamId videoStreamId )

pure virtual

Remove a stream's reid features.

Parameters

[in] videoStreamId Video stream id.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ update() [1/2]

virtual void IReID::update ( )

pure virtual

Update ReID feature gallery after data association.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

◆ update() [2/2]

virtual void IReID::update ( )

pure virtual

Update ReID feature gallery after data association.

Implemented in ReID, ReID, EnsembleReID, EnsembleReID, DummyReID, and DummyReID.

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

sources/libs/nvmultiobjecttracker/include/modules/ReID/IReID.hpp

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ ~IReID() [1/2]

◆ ~IReID() [2/2]

Member Function Documentation

◆ doInference() [1/2]

◆ doInference() [2/2]

◆ getReIDType() [1/2]

◆ getReIDType() [2/2]

◆ initializeModel() [1/2]

◆ initializeModel() [2/2]

◆ initializeRuntime() [1/2]

◆ initializeRuntime() [2/2]

◆ isModelInitialized() [1/2]

◆ isModelInitialized() [2/2]

◆ isRuntimeInitialized() [1/2]

◆ isRuntimeInitialized() [2/2]

◆ outputReIDTensor() [1/2]

◆ outputReIDTensor() [2/2]

◆ outputTargetReIDInd() [1/2]

◆ outputTargetReIDInd() [2/2]

◆ outputTargetReIDObj() [1/2]

◆ outputTargetReIDObj() [2/2]

◆ queryParams() [1/2]

◆ queryParams() [2/2]

◆ removeStream() [1/2]

◆ removeStream() [2/2]

◆ update() [1/2]

◆ update() [2/2]