NVIDIA DeepStream SDK API Reference

8.0 Release
deepstream::RoiMetadata Class Reference

Detailed Description

ROI metadata.

The metadata is for describing a region of interest

Definition at line 242 of file metadata.hpp.

Inheritance diagram for deepstream::RoiMetadata:
Collaboration diagram for deepstream::RoiMetadata:

Public Member Functions

 RoiMetadata (void *data=nullptr)
 
virtual ~RoiMetadata ()
 
NvOSD_RectParamsrectParams () const
 Get the region of interest. More...
 
FrameMetadata frameMetadata () const
 Get the frame metadata. More...
 
ObjectMetadata objectMetadata () const
 Get the object metadata. More...
 
unsigned int iterate (const std::function< void(const UserMetadata &)> &func, int meta_type) const
 Iterate the user metadata within it. More...
 
void initiateIterator (UserMetadata::Iterator &, int meta_type) const
 Get the iterator for user metadata within it. More...
 
unsigned int iterate (const std::function< void(const ClassifierMetadata &)> &func) const
 Get the classifier metadata within it. More...
 
void initiateIterator (ClassifierMetadata::Iterator &) const
 Get the iterator for classifier metadata within it. More...
 
virtual operator bool ()
 operator to check if a metadata is void More...
 

Protected Attributes

void * data_
 

Constructor & Destructor Documentation

◆ RoiMetadata()

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

◆ ~RoiMetadata()

virtual deepstream::RoiMetadata::~RoiMetadata ( )
virtual

Member Function Documentation

◆ frameMetadata()

FrameMetadata deepstream::RoiMetadata::frameMetadata ( ) const

Get the frame metadata.

◆ initiateIterator() [1/2]

void deepstream::RoiMetadata::initiateIterator ( ClassifierMetadata::Iterator ) const

Get the iterator for classifier metadata within it.

◆ initiateIterator() [2/2]

void deepstream::RoiMetadata::initiateIterator ( UserMetadata::Iterator ,
int  meta_type 
) const

Get the iterator for user metadata within it.

◆ iterate() [1/2]

unsigned int deepstream::RoiMetadata::iterate ( const std::function< void(const ClassifierMetadata &)> &  func) const

Get the classifier metadata within it.

◆ iterate() [2/2]

unsigned int deepstream::RoiMetadata::iterate ( const std::function< void(const UserMetadata &)> &  func,
int  meta_type 
) const

Iterate the user metadata within it.

◆ objectMetadata()

ObjectMetadata deepstream::RoiMetadata::objectMetadata ( ) const

Get the object metadata.

◆ operator bool()

virtual deepstream::Metadata::operator bool ( )
inlinevirtualinherited

operator to check if a metadata is void

Reimplemented in deepstream::UserMetadata.

Definition at line 51 of file metadata.hpp.

References deepstream::Metadata::data_.

◆ rectParams()

NvOSD_RectParams& deepstream::RoiMetadata::rectParams ( ) const

Get the region of interest.

Field Documentation

◆ data_

void* deepstream::Metadata::data_
protectedinherited

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