Detailed Description
Holds information about a formed batch containingframes from different sources.
Iterable via iterators for FrameMetadata and UserMetadata. Support initiaizing sub-metadata including DisplayMetadata, FrameMetadata, ObjectMetadata, EventMessageUserMetadata via acquire method. The aquired metadata objects are set to the default state and the their lifecycle would be managed by the batch metadata automatically.
Definition at line 652 of file metadata.hpp.
Public Member Functions | |
| BatchMetadata (void *data=nullptr) | |
| Constructor through opaque data pointer. More... | |
| virtual | ~BatchMetadata () |
| Destructor. More... | |
| unsigned int | iterate (const std::function< void(const FrameMetadata &)> &func) const |
| Iterate the frame metadata within it. More... | |
| void | initiateIterator (FrameMetadata::Iterator &) const |
| Get the iterator for frame metadata within it. 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... | |
| bool | acquire (DisplayMetadata &) |
| Initialize an empty display metadata. More... | |
| bool | acquire (FrameMetadata &) |
| Initialize an empty frame metadata. More... | |
| bool | acquire (ObjectMetadata &) |
| Initialize an empty object metadata. More... | |
| bool | acquire (EventMessageUserMetadata &) |
| Initialize an empty event message user metadata. More... | |
| bool | acquire (PreprocessBatchUserMetadata &) |
| Initialize an empty preprocess batch user metadata. More... | |
| template<class C , int N> | |
| bool | acquire (UserMetadataTemplate< C, N > &user_meta) |
| Initialize an empty user metadata through template. More... | |
| void | append (const FrameMetadata &) |
| Append a frame metadata to the batch. More... | |
| void | append (const UserMetadata &) |
| Append a user metadata to the batch. More... | |
| unsigned int | nFrames () const |
| Number of frames in the batch. More... | |
| virtual | operator bool () |
| operator to check if a metadata is void More... | |
Protected Member Functions | |
| UserMetadata | acquireUserMetadata_ (void *data, unsigned int type, void *(*copy)(void *, void *), void(*free)(void *, void *)) |
Protected Attributes | |
| void * | data_ |
Constructor & Destructor Documentation
◆ BatchMetadata()
| deepstream::BatchMetadata::BatchMetadata | ( | void * | data = nullptr | ) |
Constructor through opaque data pointer.
By default an empty batch metadata object is created.
◆ ~BatchMetadata()
|
virtual |
Destructor.
Member Function Documentation
◆ acquire() [1/6]
| bool deepstream::BatchMetadata::acquire | ( | DisplayMetadata & | ) |
Initialize an empty display metadata.
Referenced by deepstream::CountMarker::handleData(), deepstream::MsgMetaGenerator::handleData(), and deepstream::TensorMetaParser::handleData().
◆ acquire() [2/6]
| bool deepstream::BatchMetadata::acquire | ( | EventMessageUserMetadata & | ) |
Initialize an empty event message user metadata.
◆ acquire() [3/6]
| bool deepstream::BatchMetadata::acquire | ( | FrameMetadata & | ) |
Initialize an empty frame metadata.
◆ acquire() [4/6]
| bool deepstream::BatchMetadata::acquire | ( | ObjectMetadata & | ) |
Initialize an empty object metadata.
◆ acquire() [5/6]
| bool deepstream::BatchMetadata::acquire | ( | PreprocessBatchUserMetadata & | ) |
Initialize an empty preprocess batch user metadata.
◆ acquire() [6/6]
|
inline |
Initialize an empty user metadata through template.
Definition at line 687 of file metadata.hpp.
References acquireUserMetadata_().
◆ acquireUserMetadata_()
|
protected |
Referenced by acquire().
◆ append() [1/2]
| void deepstream::BatchMetadata::append | ( | const FrameMetadata & | ) |
Append a frame metadata to the batch.
◆ append() [2/2]
| void deepstream::BatchMetadata::append | ( | const UserMetadata & | ) |
Append a user metadata to the batch.
◆ initiateIterator() [1/2]
| void deepstream::BatchMetadata::initiateIterator | ( | FrameMetadata::Iterator & | ) | const |
Get the iterator for frame metadata within it.
Referenced by deepstream::NvDsKittiDump::generateInferenceKittiDump(), deepstream::NvDsKittiDump::generateTrackerKittiDump(), deepstream::CountMarker::handleData(), deepstream::MsgMetaGenerator::handleData(), and deepstream::TensorMetaParser::handleData().
◆ initiateIterator() [2/2]
| void deepstream::BatchMetadata::initiateIterator | ( | UserMetadata::Iterator & | , |
| int | meta_type | ||
| ) | const |
Get the iterator for user metadata within it.
◆ iterate() [1/2]
| unsigned int deepstream::BatchMetadata::iterate | ( | const std::function< void(const FrameMetadata &)> & | func | ) | const |
Iterate the frame metadata within it.
Referenced by deepstream::ObjectCounter::consume(), deepstream::NvDsKittiDump::generateTrackerPastKittiDump(), and deepstream::FPSCounter::handleData().
◆ iterate() [2/2]
| unsigned int deepstream::BatchMetadata::iterate | ( | const std::function< void(const UserMetadata &)> & | func, |
| int | meta_type | ||
| ) | const |
Iterate the user metadata within it.
◆ nFrames()
| unsigned int deepstream::BatchMetadata::nFrames | ( | ) | const |
Number of frames in the batch.
◆ 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_.
Field Documentation
◆ 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: