deepstream::SegmentationUserMetadata Class Reference

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 294 of file metadata.hpp.

Inheritance diagram for deepstream::SegmentationUserMetadata:

Collaboration diagram for deepstream::SegmentationUserMetadata:

Public Types
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...
virtual	operator bool () override
	operator to check if a metadata is void More...

Protected Member Functions
void	get_ (void *&)

Protected Attributes
void *	data_

Member Typedef Documentation

Iterator

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

inherited

Definition at line 103 of file metadata.hpp.

Constructor & Destructor Documentation

SegmentationUserMetadata() [1/2]

deepstream::SegmentationUserMetadata::SegmentationUserMetadata

(

void *

data = nullptr

)

Constructor for SegmentationUserMetadata.

Parameters

data	Optional pointer to data. Defaults to nullptr.

SegmentationUserMetadata() [2/2]

deepstream::SegmentationUserMetadata::SegmentationUserMetadata

(

const UserMetadata &

other

)

Copy constructor for SegmentationUserMetadata.

~SegmentationUserMetadata()

virtual deepstream::SegmentationUserMetadata::~SegmentationUserMetadata ( )

virtual

Destructor for SegmentationUserMetadata.

Member Function Documentation

get_()

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

protectedinherited

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

getClasses()

unsigned int deepstream::SegmentationUserMetadata::getClasses

(

)

const

Get the number of classes in the segmentation.

getClassMap()

const int* deepstream::SegmentationUserMetadata::getClassMap

(

)

const

Get the class map for the segmentation.

getClassProbabilitiesMap()

const float* deepstream::SegmentationUserMetadata::getClassProbabilitiesMap

(

)

const

Get the class probabilities map for the segmentation.

getHeight()

unsigned int deepstream::SegmentationUserMetadata::getHeight

(

)

const

Get the height of the segmentation map.

getWidth()

unsigned int deepstream::SegmentationUserMetadata::getWidth

(

)

const

Get the width of the segmentation map.

operator bool()

virtual deepstream::UserMetadata::operator bool ( )

inlineoverridevirtualinherited

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

Definition at line 116 of file metadata.hpp.

References deepstream::Metadata::data_.

uniqueId()

unsigned int deepstream::SegmentationUserMetadata::uniqueId

(

)

const

Get the unique identifier for this metadata.

Field Documentation

data_

void* deepstream::Metadata::data_

protectedinherited

Definition at line 54 of file metadata.hpp.

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

---

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

• metadata.hpp