Face Engine SDK
5.14.0
A face detection, recognition and tracking engine.
|
Descriptor batch interface. More...
#include <IDescriptor.h>
Public Types | |
enum | Error : uint32_t { Error::Ok, Error::InvalidInput, Error::BatchFull, Error::Incompatible, Error::Internal, Error::IoError, Error::OutOfRange } |
Descriptor batch error enumeration. More... | |
Public Types inherited from fsdk::ISerializableObject | |
enum | Error : uint32_t { Error::Ok, Error::Size, Error::Signature, Error::ArchiveRead, Error::InputArchive, Error::ArchiveWrite } |
Serialization nerror codes. More... | |
enum | Flags { Default = 0, NoSignature = 1 } |
Serialization flags. More... | |
Public Member Functions | |
virtual Result< Error > | add (IDescriptor *descriptor) noexcept=0 |
Add a descriptor to the batch. More... | |
virtual Result< Error > | add (IDescriptorBatch *batch, uint32_t offset=0) noexcept=0 |
Add a given descriptor batch content to the current batch. Descriptors to copy from the source batch are selected based on offset parameter. More... | |
virtual Result< Error > | add (IDescriptorBatch *batch, uint32_t offset, uint32_t count) noexcept=0 |
Add a descriptor batch content to the batch. Descriptors to copy from the source bath are selected based on count and offset parameters. More... | |
virtual Result< Error > | removeFast (uint32_t index) noexcept=0 |
Remove a descriptor from batch. More... | |
virtual Result< Error > | removeSlow (uint32_t index) noexcept=0 |
Remove a descriptor from batch. More... | |
virtual Result< MultiError < ISerializableObject::Error, Error > > | loadAndAdd (IArchive *archive)=0 |
Load a descriptor/descriptors from archive and add it to the batch. More... | |
virtual uint32_t | getMaxCount () const noexcept=0 |
Get maximum number of descriptors in this batch. More... | |
virtual uint32_t | getCount () const noexcept=0 |
Get actual number of descriptors in this batch. More... | |
virtual uint32_t | getModelVersion () const noexcept=0 |
Get algorithm model version the descriptors in this batch were created with. More... | |
virtual DescriptorType | getDescriptorType () const noexcept=0 |
Get type of descriptor. More... | |
virtual uint32_t | getDescriptorLength () const noexcept=0 |
Get length of one descriptor. Specified by version of descriptors in batch. More... | |
virtual ResultValue< FSDKError, IDescriptorPtr > | getDescriptorSlow (uint32_t index) const noexcept=0 |
Get descriptor from batch by index with copying. More... | |
virtual ResultValue< FSDKError, IDescriptorPtr > | getDescriptorFast (uint32_t index) noexcept=0 |
Get descriptor from batch by index without copying. More... | |
Public Member Functions inherited from fsdk::IDataStorageObject | |
virtual void | clear () noexcept=0 |
Clear object data. More... | |
virtual IRefCounted * | getParentObject () const noexcept=0 |
Get parent object (one that has created this). More... | |
Public Member Functions inherited from fsdk::ISerializableObject | |
virtual void | getSize (Sizer &sizer, uint32_t flags=Default) const noexcept=0 |
Estimate size of this object binary data. More... | |
virtual Result< Error > | load (IArchive *archive, uint32_t flags=Default)=0 |
Load object from archive. More... | |
virtual Result< Error > | save (IArchive *archive, uint32_t flags=Default) const =0 |
Save object to archive. More... | |
Public Member Functions inherited from fsdk::IRefCounted | |
virtual int32_t | retain () noexcept=0 |
Increase strong reference count. More... | |
virtual int32_t | retainLocked () noexcept=0 |
Increase strong reference count thread safely. More... | |
virtual int32_t | release () noexcept=0 |
Decrease strong reference count. More... | |
virtual int32_t | getRefCount () const noexcept=0 |
Get actual strong reference count. More... | |
virtual int32_t | retainWeak () noexcept=0 |
Increase weak reference count. More... | |
virtual int32_t | releaseWeak () noexcept=0 |
Decrease weak reference count. More... | |
virtual int32_t | getWeakRefCount () const noexcept=0 |
Get actual weak reference count. More... | |
Descriptor batch interface.
Used for matching large continous sets of descriptors.
A batch is created with a reserved memory for descriptors that can not be later extended. Thus descriptors can be add()'ed until the memory reservation is exceeded.
Memory reservation size can be obtained via getMaxCount() function. The batch me be reset via clear() function. It does not deallocate memory reservation. Instead, it resets internal counter allowing to re-populate the batch via add() again.
|
strong |
Descriptor batch error enumeration.
Used for descriptor batch related errors indication.
|
pure virtualnoexcept |
Add a descriptor to the batch.
[in] | descriptor | descriptor to add. Descriptor data is copied and to internal reference is held, thus it is safe to release the source descriptor object later. |
|
pure virtualnoexcept |
Add a given descriptor batch content to the current batch. Descriptors to copy from the source batch are selected based on offset parameter.
[in] | batch | batch to take content from. All descriptors from the input batch are copied to the buffer of the current batch. So it is safe to release the source descriptor batch object later. |
[in] | offset | offset of descriptors to copy. |
|
pure virtualnoexcept |
Add a descriptor batch content to the batch. Descriptors to copy from the source bath are selected based on count and offset parameters.
[in] | batch | batch to take content from. |
[in] | offset | offset of descriptors to copy. |
[in] | count | count of descriptors to copy. |
|
pure virtualnoexcept |
Get actual number of descriptors in this batch.
|
pure virtualnoexcept |
Get descriptor from batch by index without copying.
[in] | index | descriptor index in batch. |
|
pure virtualnoexcept |
Get length of one descriptor. Specified by version of descriptors in batch.
|
pure virtualnoexcept |
Get descriptor from batch by index with copying.
[in] | index | descriptor index in batch. |
|
pure virtualnoexcept |
Get type of descriptor.
|
pure virtualnoexcept |
Get maximum number of descriptors in this batch.
|
pure virtualnoexcept |
Get algorithm model version the descriptors in this batch were created with.
|
pure virtual |
Load a descriptor/descriptors from archive and add it to the batch.
[in] | archive | archive to read from. |