Detailed Description

A class to handle user metadata for segmentation.

This class extends the UserMetadata class and provides additional functionality specific to segmentation metadata.

Definition at line 314 of file service-maker/includes/metadata.hpp.

Inheritance diagram for deepstream::SegmentationUserMetadata:

[legend]

Collaboration diagram for deepstream::SegmentationUserMetadata:

[legend]

Public Types
typedef std::unique_ptr< AbstractIterator< UserMetadata > >	Iterator

typedef std::unique_ptr< AbstractIterator< UserMetadata > >	Iterator

Public Member Functions
	SegmentationUserMetadata (void *data=nullptr)
	Constructor for SegmentationUserMetadata. More...

	SegmentationUserMetadata (const UserMetadata &other)
	Copy constructor for SegmentationUserMetadata. More...

virtual	~SegmentationUserMetadata ()
	Destructor for SegmentationUserMetadata. More...

unsigned int	uniqueId () const
	Get the unique identifier for this metadata. More...

unsigned int	getClasses () const
	Get the number of classes in the segmentation. More...

unsigned int	getWidth () const
	Get the width of the segmentation map. More...

unsigned int	getHeight () const
	Get the height of the segmentation map. More...

const int *	getClassMap () const
	Get the class map for the segmentation. More...

const float *	getClassProbabilitiesMap () const
	Get the class probabilities map for the segmentation. More...

	SegmentationUserMetadata (void *data=nullptr)
	Constructor for SegmentationUserMetadata. More...

	SegmentationUserMetadata (const UserMetadata &other)
	Copy constructor for SegmentationUserMetadata. More...

virtual	~SegmentationUserMetadata ()
	Destructor for SegmentationUserMetadata. More...

unsigned int	uniqueId () const
	Get the unique identifier for this metadata. More...

unsigned int	getClasses () const
	Get the number of classes in the segmentation. More...

unsigned int	getWidth () const
	Get the width of the segmentation map. More...

unsigned int	getHeight () const
	Get the height of the segmentation map. More...

const int *	getClassMap () const
	Get the class map for the segmentation. More...

const float *	getClassProbabilitiesMap () const
	Get the class probabilities map for the segmentation. More...

virtual	operator bool () override
	operator to check if a metadata is void More...

virtual	operator bool () override
	operator to check if a metadata is void More...

int	metaType () const
	Get the meta type. More...

int	metaType () const
	Get the meta type. More...

void	setMetaType (int type)
	Set the meta type. More...

void	setMetaType (int type)
	Set the meta type. More...

void *	userData () const
	Get the user data pointer. More...

void *	userData () const
	Get the user data pointer. More...

void	setUserData (void data, void (copy)(void , void ), void(release)(void , void ))
	Set user data with copy and release functions. More...

void	setUserData (void data, void (copy)(void , void ), void(release)(void , void ))
	Set user data with copy and release functions. More...

Protected Member Functions
void	get_ (void *&)

void	get_ (void *&)

Protected Attributes
void *	data_

Member Typedef Documentation

◆ Iterator [1/2]

typedef std::unique_ptr<AbstractIterator<UserMetadata> > deepstream::UserMetadata::Iterator

inherited

Definition at line 103 of file service-maker/includes/metadata.hpp.

◆ Iterator [2/2]

typedef std::unique_ptr<AbstractIterator<UserMetadata> > deepstream::UserMetadata::Iterator

inherited

Definition at line 103 of file 9.0/service-maker/includes/metadata.hpp.

Constructor & Destructor Documentation

◆ SegmentationUserMetadata() [1/4]

deepstream::SegmentationUserMetadata::SegmentationUserMetadata ( void * data = nullptr )

Constructor for SegmentationUserMetadata.

Parameters

data	Optional pointer to data. Defaults to nullptr.

◆ SegmentationUserMetadata() [2/4]

deepstream::SegmentationUserMetadata::SegmentationUserMetadata ( const UserMetadata & other )

Copy constructor for SegmentationUserMetadata.

◆ ~SegmentationUserMetadata() [1/2]

virtual deepstream::SegmentationUserMetadata::~SegmentationUserMetadata ( )

virtual

Destructor for SegmentationUserMetadata.

◆ SegmentationUserMetadata() [3/4]

deepstream::SegmentationUserMetadata::SegmentationUserMetadata ( void * data = nullptr )

Constructor for SegmentationUserMetadata.

Parameters

data	Optional pointer to data. Defaults to nullptr.

◆ SegmentationUserMetadata() [4/4]

deepstream::SegmentationUserMetadata::SegmentationUserMetadata ( const UserMetadata & other )

Copy constructor for SegmentationUserMetadata.

◆ ~SegmentationUserMetadata() [2/2]

virtual deepstream::SegmentationUserMetadata::~SegmentationUserMetadata ( )

virtual

Destructor for SegmentationUserMetadata.

Member Function Documentation

◆ get_() [1/2]

void deepstream::UserMetadata::get_ ( void *& )

protectedinherited

Referenced by deepstream::UserMetadataTemplate< C, N >::copy(), deepstream::UserMetadataTemplate< C, N >::free(), and deepstream::UserMetadataTemplate< C, N >::get().

◆ get_() [2/2]

void deepstream::UserMetadata::get_ ( void *& )

protectedinherited

◆ getClasses() [1/2]

unsigned int deepstream::SegmentationUserMetadata::getClasses ( ) const

Get the number of classes in the segmentation.

◆ getClasses() [2/2]

unsigned int deepstream::SegmentationUserMetadata::getClasses ( ) const

Get the number of classes in the segmentation.

◆ getClassMap() [1/2]

const int* deepstream::SegmentationUserMetadata::getClassMap ( ) const

Get the class map for the segmentation.

◆ getClassMap() [2/2]

const int* deepstream::SegmentationUserMetadata::getClassMap ( ) const

Get the class map for the segmentation.

◆ getClassProbabilitiesMap() [1/2]

const float* deepstream::SegmentationUserMetadata::getClassProbabilitiesMap ( ) const

Get the class probabilities map for the segmentation.

◆ getClassProbabilitiesMap() [2/2]

const float* deepstream::SegmentationUserMetadata::getClassProbabilitiesMap ( ) const

Get the class probabilities map for the segmentation.

◆ getHeight() [1/2]

unsigned int deepstream::SegmentationUserMetadata::getHeight ( ) const

Get the height of the segmentation map.

◆ getHeight() [2/2]

unsigned int deepstream::SegmentationUserMetadata::getHeight ( ) const

Get the height of the segmentation map.

◆ getWidth() [1/2]

unsigned int deepstream::SegmentationUserMetadata::getWidth ( ) const

Get the width of the segmentation map.

◆ getWidth() [2/2]

unsigned int deepstream::SegmentationUserMetadata::getWidth ( ) const

Get the width of the segmentation map.

◆ metaType() [1/2]

int deepstream::UserMetadata::metaType ( ) const

inherited

Get the meta type.

◆ metaType() [2/2]

int deepstream::UserMetadata::metaType ( ) const

inherited

Get the meta type.

◆ operator bool() [1/2]

virtual deepstream::UserMetadata::operator bool ( )

inlineoverridevirtualinherited

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

Definition at line 116 of file 9.0/service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

◆ operator bool() [2/2]

virtual deepstream::UserMetadata::operator bool ( )

inlineoverridevirtualinherited

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

Definition at line 116 of file service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

◆ setMetaType() [1/2]

void deepstream::UserMetadata::setMetaType ( int type )

inherited

Set the meta type.

◆ setMetaType() [2/2]

void deepstream::UserMetadata::setMetaType ( int type )

inherited

Set the meta type.

◆ setUserData() [1/2]

void deepstream::UserMetadata::setUserData	(	void *	data,
		void ()(void , void )	copy,
		void()(void , void *)	release
	)

inherited

Set user data with copy and release functions.

Parameters

data	Pointer to user data
copy	Copy function for the user data (can be NULL)
release	Release function for the user data (can be NULL)

◆ setUserData() [2/2]

void deepstream::UserMetadata::setUserData	(	void *	data,
		void ()(void , void )	copy,
		void()(void , void *)	release
	)

inherited

Set user data with copy and release functions.

Parameters

data	Pointer to user data
copy	Copy function for the user data (can be NULL)
release	Release function for the user data (can be NULL)

◆ uniqueId() [1/2]

unsigned int deepstream::SegmentationUserMetadata::uniqueId ( ) const

Get the unique identifier for this metadata.

◆ uniqueId() [2/2]

unsigned int deepstream::SegmentationUserMetadata::uniqueId ( ) const

Get the unique identifier for this metadata.

◆ userData() [1/2]

void* deepstream::UserMetadata::userData ( ) const

inherited

Get the user data pointer.

◆ userData() [2/2]

void* deepstream::UserMetadata::userData ( ) const

inherited

Get the user data pointer.

Field Documentation

◆ data_

void * deepstream::Metadata::data_

protectedinherited

Definition at line 54 of file service-maker/includes/metadata.hpp.

Referenced by deepstream::Metadata::operator bool(), and deepstream::UserMetadata::operator bool().

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

service-maker/includes/metadata.hpp


NVIDIA DeepStream SDK API Reference	8.0 Release

NVIDIA DeepStream SDK API Reference

8.0 Release

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ Iterator [1/2]

◆ Iterator [2/2]

Constructor & Destructor Documentation

◆ SegmentationUserMetadata() [1/4]

◆ SegmentationUserMetadata() [2/4]

◆ ~SegmentationUserMetadata() [1/2]

◆ SegmentationUserMetadata() [3/4]

◆ SegmentationUserMetadata() [4/4]

◆ ~SegmentationUserMetadata() [2/2]

Member Function Documentation

◆ get_() [1/2]

◆ get_() [2/2]

◆ getClasses() [1/2]

◆ getClasses() [2/2]

◆ getClassMap() [1/2]

◆ getClassMap() [2/2]

◆ getClassProbabilitiesMap() [1/2]

◆ getClassProbabilitiesMap() [2/2]

◆ getHeight() [1/2]

◆ getHeight() [2/2]

◆ getWidth() [1/2]

◆ getWidth() [2/2]

◆ metaType() [1/2]

◆ metaType() [2/2]

◆ operator bool() [1/2]

◆ operator bool() [2/2]

◆ setMetaType() [1/2]

◆ setMetaType() [2/2]

◆ setUserData() [1/2]

◆ setUserData() [2/2]

◆ uniqueId() [1/2]

◆ uniqueId() [2/2]

◆ userData() [1/2]

◆ userData() [2/2]

Field Documentation

◆ data_