Detailed Description

Defines the interface for target segmentation modules.

Definition at line 35 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/ISegmenter.hpp.

Inheritance diagram for ISegmenter:

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

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

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

virtual void	localize (const std::map< NvMOTStreamId, NvMOTFrame * > &inputMeta)=0
	Localize and segment target in a new frame. More...

virtual void	update (const std::map< NvMOTStreamId, NvMOTFrame * > &inputMeta)=0
	Update Segmenter after data association. More...

virtual void	outputMaskObj (const std::shared_ptr< NvTrackedObject > target, NvMOTMask &mask)=0
	Output segmentation mask of a target. More...

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

virtual bool	isInitialized ()=0
	Report whether the module is initialized. More...

virtual const SEGMENTER_TYPES	getSegmenterType ()=0
	Get the configured segmenter type. More...

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

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

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

virtual void	localize (const std::map< NvMOTStreamId, NvMOTFrame * > &inputMeta)=0
	Localize and segment target in a new frame. More...

virtual void	update (const std::map< NvMOTStreamId, NvMOTFrame * > &inputMeta)=0
	Update Segmenter after data association. More...

virtual void	outputMaskObj (const std::shared_ptr< NvTrackedObject > target, NvMOTMask &mask)=0
	Output segmentation mask of a target. More...

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

virtual bool	isInitialized ()=0
	Report whether the module is initialized. More...

virtual const SEGMENTER_TYPES	getSegmenterType ()=0
	Get the configured segmenter type. More...

Constructor & Destructor Documentation

◆ ~ISegmenter() [1/2]

virtual ISegmenter::~ISegmenter ( )

inlinevirtual

Release resources owned by the ISegmenter instance.

Definition at line 39 of file sources/libs/nvmultiobjecttracker/include/modules/Segmenter/ISegmenter.hpp.

◆ ~ISegmenter() [2/2]

virtual ISegmenter::~ISegmenter ( )

inlinevirtual

Release resources owned by the ISegmenter instance.

Definition at line 39 of file 9.2/sources/libs/nvmultiobjecttracker/include/modules/Segmenter/ISegmenter.hpp.

Member Function Documentation

◆ getSegmenterType() [1/2]

virtual const SEGMENTER_TYPES ISegmenter::getSegmenterType ( )

pure virtual

Get the configured segmenter type.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ getSegmenterType() [2/2]

virtual const SEGMENTER_TYPES ISegmenter::getSegmenterType ( )

pure virtual

Get the configured segmenter type.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ initialize() [1/2]

virtual void ISegmenter::initialize	(	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 Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ initialize() [2/2]

virtual void ISegmenter::initialize	(	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 Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ isInitialized() [1/2]

virtual bool ISegmenter::isInitialized ( )

pure virtual

Report whether the module is initialized.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ isInitialized() [2/2]

virtual bool ISegmenter::isInitialized ( )

pure virtual

Report whether the module is initialized.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ localize() [1/2]

virtual void ISegmenter::localize ( const std::map< NvMOTStreamId, NvMOTFrame * > & inputMeta )

pure virtual

Localize and segment target in a new frame.

Parameters

[in] inputMeta A batch of input frames.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ localize() [2/2]

virtual void ISegmenter::localize ( const std::map< NvMOTStreamId, NvMOTFrame * > & inputMeta )

pure virtual

Localize and segment target in a new frame.

Parameters

[in] inputMeta A batch of input frames.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ outputMaskObj() [1/2]

virtual void ISegmenter::outputMaskObj	(	const std::shared_ptr< NvTrackedObject >	target,
		NvMOTMask &	mask
	)

pure virtual

Output segmentation mask of a target.

Parameters

[in]	target	The target.
[out]	mask	The output mask.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ outputMaskObj() [2/2]

virtual void ISegmenter::outputMaskObj	(	const std::shared_ptr< NvTrackedObject >	target,
		NvMOTMask &	mask
	)

pure virtual

Output segmentation mask of a target.

Parameters

[in]	target	The target.
[out]	mask	The output mask.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ queryParams() [1/2]

virtual void ISegmenter::queryParams ( NvMOTQuery & paramsQuery )

pure virtual

Populate the capabilities reported to the tracker.

Parameters

[out] paramsQuery The output query parameters.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ queryParams() [2/2]

virtual void ISegmenter::queryParams ( NvMOTQuery & paramsQuery )

pure virtual

Populate the capabilities reported to the tracker.

Parameters

[out] paramsQuery The output query parameters.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ removeStream() [1/2]

virtual void ISegmenter::removeStream ( const NvMOTStreamId videoStreamId )

pure virtual

Remove a stream's Segmenter features.

Parameters

[in] videoStreamId Video stream id.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ removeStream() [2/2]

virtual void ISegmenter::removeStream ( const NvMOTStreamId videoStreamId )

pure virtual

Remove a stream's Segmenter features.

Parameters

[in] videoStreamId Video stream id.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ update() [1/2]

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

pure virtual

Update Segmenter after data association.

Parameters

[in] inputMeta A batch of input frames.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

◆ update() [2/2]

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

pure virtual

Update Segmenter after data association.

Parameters

[in] inputMeta A batch of input frames.

Implemented in Segmenter, Segmenter, DummySegmenter, and DummySegmenter.

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

sources/libs/nvmultiobjecttracker/include/modules/Segmenter/ISegmenter.hpp

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ ~ISegmenter() [1/2]

◆ ~ISegmenter() [2/2]

Member Function Documentation

◆ getSegmenterType() [1/2]

◆ getSegmenterType() [2/2]

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ isInitialized() [1/2]

◆ isInitialized() [2/2]

◆ localize() [1/2]

◆ localize() [2/2]

◆ outputMaskObj() [1/2]

◆ outputMaskObj() [2/2]

◆ queryParams() [1/2]

◆ queryParams() [2/2]

◆ removeStream() [1/2]

◆ removeStream() [2/2]

◆ update() [1/2]

◆ update() [2/2]