diff --git a/.DS_Store b/.DS_Store
new file mode 100644
index 0000000..34c19f7
Binary files /dev/null and b/.DS_Store differ
diff --git a/.idea/.gitignore b/.idea/.gitignore
new file mode 100644
index 0000000..26d3352
--- /dev/null
+++ b/.idea/.gitignore
@@ -0,0 +1,3 @@
+# Default ignored files
+/shelf/
+/workspace.xml
diff --git a/QuickStartGuide.pdf b/QuickStartGuide.pdf
new file mode 100644
index 0000000..6496184
Binary files /dev/null and b/QuickStartGuide.pdf differ
diff --git a/data/FaceDet_v2_first_arm.plan b/data/FaceDet_v2_first_arm.plan
new file mode 100644
index 0000000..c76c25d
Binary files /dev/null and b/data/FaceDet_v2_first_arm.plan differ
diff --git a/data/FaceDet_v2_first_cpu.plan b/data/FaceDet_v2_first_cpu.plan
new file mode 100644
index 0000000..92e7fb1
Binary files /dev/null and b/data/FaceDet_v2_first_cpu.plan differ
diff --git a/data/FaceDet_v2_second_arm.plan b/data/FaceDet_v2_second_arm.plan
new file mode 100644
index 0000000..15731dd
Binary files /dev/null and b/data/FaceDet_v2_second_arm.plan differ
diff --git a/data/FaceDet_v2_second_cpu.plan b/data/FaceDet_v2_second_cpu.plan
new file mode 100644
index 0000000..e55fe9b
Binary files /dev/null and b/data/FaceDet_v2_second_cpu.plan differ
diff --git a/data/FaceDet_v2_third_arm.plan b/data/FaceDet_v2_third_arm.plan
new file mode 100644
index 0000000..9bc2ce6
Binary files /dev/null and b/data/FaceDet_v2_third_arm.plan differ
diff --git a/data/FaceDet_v2_third_cpu.plan b/data/FaceDet_v2_third_cpu.plan
new file mode 100644
index 0000000..21bffeb
Binary files /dev/null and b/data/FaceDet_v2_third_cpu.plan differ
diff --git a/data/ags_angle_estimation_flwr_arm.plan b/data/ags_angle_estimation_flwr_arm.plan
new file mode 100644
index 0000000..bcef235
Binary files /dev/null and b/data/ags_angle_estimation_flwr_arm.plan differ
diff --git a/data/ags_angle_estimation_flwr_cpu.plan b/data/ags_angle_estimation_flwr_cpu.plan
new file mode 100644
index 0000000..92f19dd
Binary files /dev/null and b/data/ags_angle_estimation_flwr_cpu.plan differ
diff --git a/data/ags_estimation_flwr_arm.plan b/data/ags_estimation_flwr_arm.plan
new file mode 100644
index 0000000..6c5ad8f
Binary files /dev/null and b/data/ags_estimation_flwr_arm.plan differ
diff --git a/data/ags_estimation_flwr_cpu.plan b/data/ags_estimation_flwr_cpu.plan
new file mode 100644
index 0000000..e5d921c
Binary files /dev/null and b/data/ags_estimation_flwr_cpu.plan differ
diff --git a/data/angle_estimation_flwr_arm.plan b/data/angle_estimation_flwr_arm.plan
new file mode 100644
index 0000000..82018f6
Binary files /dev/null and b/data/angle_estimation_flwr_arm.plan differ
diff --git a/data/angle_estimation_flwr_cpu.plan b/data/angle_estimation_flwr_cpu.plan
new file mode 100644
index 0000000..02bb5f6
Binary files /dev/null and b/data/angle_estimation_flwr_cpu.plan differ
diff --git a/data/bestshotmobile.conf b/data/bestshotmobile.conf
new file mode 100644
index 0000000..ccf89c7
--- /dev/null
+++ b/data/bestshotmobile.conf
@@ -0,0 +1,40 @@
+
+
Feature name and |
+ Required algorithms and used structures |
+ Best Shot |
+ Face Features |
+ Face |
+ |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+
+ The <device> placeholder shows that the model can be used with different devices (e. g., CPU, GPU). Example of table using - if user wants to find best shots in his application, he needs to look at the "Best Shot Selection" |
+ |||||||||||||||||||||||||||||
Face detection NN version 2 First, second and third NN should be launched consequently |
+
+
+ Structure(s): IDetector Plan(s): FaceDet_2_first_<device>.plan FaceDet_2_second_<device>.plan FaceDet_2_third_<device>.plan + | + | + | + | |||||||||||||||||||||||||
BestShotQuality estimation Performs head pose and AGS estimations |
+ Structure(s): IBestShotQualityEstimator Plan(s): ags_angle_estimation_flwr_<device>.plan |
+ + | + | + | |||||||||||||||||||||||||
Image quality estimation (light, dark, blur, etc.) |
+ Structure(s): IQualityEstimator Plan(s): model_subjective_quality_<version>_<device>.plan |
+ + | + | + | |||||||||||||||||||||||||
Image glasses estimation (light, dark, blur, etc.) |
+ Structure(s): IGlassesEstimator Plan(s): glasses_estimation_flwr_<version>_<device>.plan |
+ + | + | + | |||||||||||||||||||||||||
Head pose estimation (deprecated) | +Structure(s): IHeadPoseEstimator Plan(s): angle_estimation_flwr_<device>.plan |
+ + | + | + | |||||||||||||||||||||||||
AGS estimation (deprecated) | +Structure(s): IAGSEstimator Plan(s): ags_estimation_flwr_<device>.plan |
+ + | + | + | |||||||||||||||||||||||||
LivenessOneShotRGB estimation Predicts whether the person's face is real or fake (photo, printed image) |
+ Structure(s): ILivenessOneShotRGBEstimator Plan(s): oslm_v3_model_<version>_<device>.plan |
+ + | + | + | |||||||||||||||||||||||||
Extraction (NN version 54 mobilenet) (Available in Complete distribution package only!) |
+ Structure(s): IDescriptor, IDescriptorBatch, IDescriptorExtractor Plan(s): cnn54m_<device>.plan + | + | + | + | |||||||||||||||||||||||||
Eyes state estimation (eyes status and keypoints for irises and eyelids) |
+ Structure(s): IEyeEstimator Plan(s): eyes_estimation_flwr8_<device>.plan |
+ + | + | + | |||||||||||||||||||||||||
Eyes state (lightened version, returns eyes state only) |
+ Structure(s): IEyeEstimator Plan(s): eye_status_estimation_flwr_<device>. + | + | + | + |
Functionality |
+ Feature name and |
+ Required algorithms and used structures |
+ Face detection NN |
+ Face detection NN |
+
---|---|---|---|---|
MedicalMaskDetection | +Medical mask estimation | +Structure(s): IMedicalMaskEstimator Plan(s): mask_clf_<version>_<device>.plan |
+ + | + |
The table above includes separately licensed feature.
+Additional features required for the functionality utilization are shown in the columns to the right.
+ +![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
▼Nmobile | |
CBestShotInfo | |
CIBestShotMobile | IBestShotMobile interface class |
CIBestShotMobileObserver |
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
|
| IBestShotMobileObserver (mobile) | ||
BestShotInfo (mobile) | IBestShotMobile (mobile) | |||
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
▼ extern | |
▼ bestshotmobile | |
▼ inc | |
IBestShotMobile.h |
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
t |
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
This is the complete list of members for mobile::BestShotInfo, including all inherited members.
+![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
+Public Attributes | |
+BestShotState | state |
State of this frame. | |
+fsdk::Image | image |
Source image. | |
+fsdk::Detection | detection |
Detection with face. | |
+fsdk::Landmarks5 | landmarks |
Face landmarks. | |
fsdk::HeadPoseEstimation | headPoseEstimation |
float | agsEstimation |
+tsdk::FrameId | frameIndex |
Index of the frame. | |
+tsdk::TrackId | trackId |
Index of the track. | |
float mobile::BestShotInfo::agsEstimation | +
AGS estimation result. This parameter could help to show notification to the user in case of bad quality.
+ +fsdk::HeadPoseEstimation mobile::BestShotInfo::headPoseEstimation | +
Estimation of the head position. This parameter could help to show notification to the user in case of bad angles.
+ +![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
This is the complete list of members for mobile::IBestShotMobile, including all inherited members.
+getLivenessType()=0 | mobile::IBestShotMobile | pure virtual |
join()=0 | mobile::IBestShotMobile | pure virtual |
pushFrame(const fsdk::Image &frame, uint32_t frameId)=0 | mobile::IBestShotMobile | pure virtual |
setBestShotMobileObserver(IBestShotMobileObserver *observer)=0 | mobile::IBestShotMobile | pure virtual |
~IBestShotMobile()=default (defined in mobile::IBestShotMobile) | mobile::IBestShotMobile | virtual |
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
IBestShotMobile interface class. + More...
+ +#include <IBestShotMobile.h>
+Public Member Functions | |
virtual BESTSHOT_MOBILE_API bool | pushFrame (const fsdk::Image &frame, uint32_t frameId)=0 |
Pushes a single frame to the buffer. More... | |
virtual BESTSHOT_MOBILE_API void | setBestShotMobileObserver (IBestShotMobileObserver *observer)=0 |
Sets a bestshot observer. More... | |
virtual BESTSHOT_MOBILE_API void | join ()=0 |
Blocks current thread until all frames in this Stream will be handled and all callbacks will be executed. More... | |
virtual BESTSHOT_MOBILE_API LivenessType | getLivenessType ()=0 |
Returns current liveness type. More... | |
IBestShotMobile interface class.
+
+
|
+ +pure virtual | +
Returns current liveness type.
+
+
|
+ +pure virtual | +
Blocks current thread until all frames in this Stream will be handled and all callbacks will be executed.
+
+
|
+ +pure virtual | +
Pushes a single frame to the buffer.
+frame | input frame image. Format must be R8G8B8. |
frameId | unique identifier for frames sequence. |
data | is any additional data that a developer wants to receive in callbacks-realization. Do not use the delete-operator. The garbage collector is implemented inside for this param. |
+
|
+ +pure virtual | +
Sets a bestshot observer.
+observer | pointer to the observer object, |
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
This is the complete list of members for mobile::IBestShotMobileObserver, including all inherited members.
+bestShot(const BestShotInfo &bestShotInfo)=0 | mobile::IBestShotMobileObserver | pure virtual |
liveness(const LivenessState livenessState, const BestShotInfo &bestShotInfo)=0 | mobile::IBestShotMobileObserver | pure virtual |
trackEnd(const tsdk::TrackId &trackId)=0 | mobile::IBestShotMobileObserver | pure virtual |
![]() |
+
+ BestShotMobile
+
+ Bestshot making and liveness checking library
+ |
+
+Public Member Functions | |
virtual BESTSHOT_MOBILE_API void | bestShot (const BestShotInfo &bestShotInfo)=0 |
Bestshot notification. More... | |
virtual BESTSHOT_MOBILE_API void | liveness (const LivenessState livenessState, const BestShotInfo &bestShotInfo)=0 |
Liveness check notification. More... | |
virtual BESTSHOT_MOBILE_API void | trackEnd (const tsdk::TrackId &trackId)=0 |
End of a track notification. More... | |
+
|
+ +pure virtual | +
Bestshot notification.
+bestShotInfo | bestshot information, |
+
|
+ +pure virtual | +
Liveness check notification.
+state | liveness state for the bestshot. |
bestShotInfo | bestshot information, |
+
|
+ +pure virtual | +
End of a track notification.
+trackId | id of the track. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Common SDK definitions. +More...
+ +Go to the source code of this file.
++Macros | |
+#define | FSDK_DEPRECATED(msg) |
+#define | FSDK_API |
Dummy. | |
#define | ALIGN_UP(value, align) |
+#define | ALIGNED(x) __attribute__ ((aligned(x))) |
+#define | RESTRICT __restrict__ |
+#define | FORCE_INLINE inline __attribute__ ((always_inline)) |
+#define | DECLARE_SMARTPTR(X) struct X; using X##Ptr = fsdk::Ref<X> |
Smart ptr declaration helper macro. | |
+#define | STRINGIFY2(x) #x |
Stringification helper macro. | |
+#define | STRINGIFY(x) STRINGIFY2(x) |
Stringifies it's argument. | |
Common SDK definitions.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Common SDK error codes. +More...
+#include <fsdk/Types/Result.h>
Go to the source code of this file.
++Classes | |
struct | fsdk::ErrorTraits< FSDKError > |
Specialized for FSDKError. More... | |
+Namespaces | |
fsdk | |
SDK namespace. | |
Common SDK error codes.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Face detection, analyzing and recognition SDK interfaces, AIO public header. +More...
+#include <fsdk/IFaceEngineMobile.h>
Go to the source code of this file.
++Namespaces | |
fsdk | |
SDK namespace. | |
+Typedefs | |
+using | fsdk::FaceEngineType = IFaceEngineMobile |
+using | fsdk::FaceEnginePtrType = IFaceEngineMobilePtr |
Face detection, analyzing and recognition SDK interfaces, AIO public header.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Async context interface. +More...
+ +Go to the source code of this file.
++Classes | |
struct | fsdk::IAsyncContext |
Interface for running tasks asynchronously. More... | |
+Namespaces | |
fsdk | |
SDK namespace. | |
Async context interface.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Descriptor extractor and matcher interfaces. +More...
+#include "IObject.h"
#include "IDetector.h"
#include "FSDKError.h"
#include "Types.h"
#include <limits>
Go to the source code of this file.
++Classes | |
struct | fsdk::MatchingResult |
Result of descriptor matching. More... | |
struct | fsdk::IDescriptor |
Descriptor interface. More... | |
struct | fsdk::IDescriptorBatch |
Descriptor batch interface. More... | |
struct | fsdk::ErrorTraits< IDescriptorBatch::Error > |
Specialized for DescriptorBatchError. More... | |
struct | fsdk::IDescriptorExtractor |
Descriptor extractor interface. More... | |
struct | fsdk::IDescriptorMatcher |
Descriptor matcher interface. More... | |
+Namespaces | |
fsdk | |
SDK namespace. | |
+Enumerations | |
enum | fsdk::DescriptorType { fsdk::DT_FACE, +fsdk::DT_HUMAN + } |
Descriptor type enum. Determines which type of descriptor to use. More... | |
enum | fsdk::DescriptorVersion : uint32_t { fsdk::DV_MIN_FACE_DESCRIPTOR_VERSION = 46, +fsdk::DV_MIN_HUMAN_DESCRIPTOR_VERSION = 102 + } |
Minimum descriptor model version. Determines which minimum version of descriptor to use. More... | |
enum | fsdk::HumanDescriptorVersion : uint32_t { fsdk::HDV_TRACKER_HUMAN_DESCRIPTOR_VERSION = 102, +fsdk::HDV_PRECISE_HUMAN_DESCRIPTOR_VERSION = 103, +fsdk::HDV_REGULAR_HUMAN_DESCRIPTOR_VERSION = 104 + } |
Human descriptor model versions. Determines which version of human descriptor to use. More... | |
Descriptor extractor and matcher interfaces.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Face detector interfaces. +More...
+#include "FSDKError.h"
#include "IFaceDetectionBatch.h"
#include "IObject.h"
#include "Types.h"
#include "Types/Face.h"
#include <fsdk/vlc/future.h>
#include <functional>
Go to the source code of this file.
++Classes | |
class | fsdk::IDetectionComparer |
Interface of BestDetection comparer. Implement it if you want to use own BestDetection strategy. More... | |
class | fsdk::FunctionDetectionComparer |
Syntax sugar, allows you to use lambdas to define a BestDetection comparer. More... | |
struct | fsdk::IDetector |
face detector interface. More... | |
+Namespaces | |
fsdk | |
SDK namespace. | |
+Enumerations | |
enum | fsdk::SensorType { fsdk::SensorType::Visible = 0, +fsdk::SensorType::NIR + } |
Sensor type structure. Determines which type of camera sensor is used to perform face recognition. More... | |
enum | fsdk::ObjectDetectorClassType { + fsdk::FACE_DET_DEFAULT = 0, +fsdk::FACE_DET_V1 = 4, +fsdk::FACE_DET_V2 = 5, +fsdk::FACE_DET_V3 = 6, + + fsdk::FACE_DET_COUNT = 7 + + } |
Object detector type enumeration. More... | |
enum | fsdk::DetectionComparerType { + fsdk::DCT_CONFIDENCE = 0, +fsdk::DCT_CENTER, +fsdk::DCT_CENTER_AND_CONFIDENCE, +fsdk::DCT_SIZE, + + DCT_COUNT + + } |
Strategy of BestDetections comparer. More... | |
enum | fsdk::DetectionType { fsdk::DT_BBOX = 0, +fsdk::DT_LANDMARKS5 = 1<<0, +fsdk::DT_LANDMARKS68 = 1<<1, +fsdk::DT_ALL = 0xffff + } |
Detection type enumeration. More... | |
+Functions | |
+DetectionType | fsdk::operator| (DetectionType a, DetectionType b) |
Face detector interfaces.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Image warping base on Human detection. +More...
+#include <fsdk/FSDKError.h>
#include <fsdk/IRefCounted.h>
#include <fsdk/Types/Detection.h>
#include <fsdk/Types/Image.h>
#include <fsdk/Types/Span.h>
Go to the source code of this file.
++Classes | |
struct | fsdk::IHumanWarper |
Human detection area warper interface. More... | |
+Namespaces | |
fsdk | |
SDK namespace. | |
Image warping base on Human detection.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Object system types and interfaces. +More...
+ +Go to the source code of this file.
++Classes | |
struct | fsdk::IArchive |
Archive interface. More... | |
struct | fsdk::ISerializableObject |
Serializable object interface. More... | |
struct | fsdk::ErrorTraits< ISerializableObject::Error > |
Specialized for ISerializableObject::SerializationError. More... | |
struct | fsdk::IDataStorageObject |
Data storage object interface helper. More... | |
+Namespaces | |
fsdk | |
SDK namespace. | |
Object system types and interfaces.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Reference counted object interface. +More...
+#include <cstdint>
Go to the source code of this file.
++Classes | |
struct | fsdk::IRefCounted |
Base strong reference counted object interface. More... | |
+Namespaces | |
fsdk | |
SDK namespace. | |
Reference counted object interface.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Settings provider interface. +More...
+#include <fsdk/IObject.h>
#include <fsdk/Types.h>
#include "FSDKError.h"
#include <cstring>
#include <string>
Go to the source code of this file.
++Namespaces | |
fsdk | |
SDK namespace. | |
+Functions | |
FSDK_API ResultValue +< FSDKError, +ISettingsProviderPtr > | fsdk::createSettingsProvider (const char *path) noexcept |
Create a settings provider. More... | |
Settings provider interface.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Image and landmarks warping. +More...
+ +Go to the source code of this file.
++Classes | |
struct | fsdk::Transformation |
Transformation data structure, used for warping. More... | |
struct | fsdk::IWarper |
Face detection area warper interface. More... | |
+Namespaces | |
fsdk | |
SDK namespace. | |
Image and landmarks warping.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Log interfaces. +More...
+#include <fsdk/Def.h>
Go to the source code of this file.
++Namespaces | |
fsdk | |
SDK namespace. | |
+Typedefs | |
+using | fsdk::log::PrintFunction = void(*)(int severity, const char *message) |
Custom print function type. | |
+Functions | |
FSDK_API void | fsdk::log::setPrintFunction (PrintFunction function) noexcept |
Set print function pointer. Default function is made thread-safe with function-local mutex. It means that if you provide your custom print function it's your duty to make it thread safe or not thread safe. More... | |
FSDK_API PrintFunction | fsdk::log::getPrintFunction () noexcept |
Get print function pointer. More... | |
FSDK_API PrintFunction | fsdk::log::getDefaultPrintFunction () noexcept |
Get default print function pointer. Is thread-safe. More... | |
FSDK_API void | fsdk::log::restorePrintFunction () noexcept |
Helper function to restore default print function. This is equivalent to: More... | |
FSDK_API void | fsdk::log::setSeverityFilter (int severity) noexcept |
Sets severity logging filter. More... | |
FSDK_API int | fsdk::log::getSeverityFilter () noexcept |
Get log severity filter. More... | |
Log interfaces.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Common data types and structures. +More...
+#include "Types/Vector2.h"
#include "Types/Sizer.h"
#include "Types/Rect.h"
#include "Types/Format.h"
#include "Types/SubImage.h"
#include "Types/Image.h"
#include "Types/RefBase.h"
#include "Types/Ref.h"
#include "Types/WeakRef.h"
#include "Types/Result.h"
#include "Types/ResultValue.h"
#include "Types/Detection.h"
#include "Types/Landmarks.h"
#include "Types/MultiError.h"
#include "Types/Future.h"
#include "Types/Span.h"
Go to the source code of this file.
+Common data types and structures.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
SDK version information routines. +More...
+ +Go to the source code of this file.
++Classes | |
struct | fsdk::Version |
+Namespaces | |
fsdk | |
SDK namespace. | |
+Functions | |
bool | fsdk::operator< (Version lhs, Version rhs) noexcept |
Check if one version is less than another. More... | |
bool | fsdk::operator== (Version lhs, Version rhs) noexcept |
Check if versions are equal. More... | |
bool | fsdk::operator!= (Version lhs, Version rhs) noexcept |
Check if versions are not equal. More... | |
FSDK_API Version | fsdk::getVersion () noexcept |
Get FaceEngine version. More... | |
FSDK_API const char * | fsdk::getVersionHash () noexcept |
Get FaceEngine commit hash. More... | |
FSDK_API const char * | fsdk::getVersionString () noexcept |
Get FaceEngine version string. More... | |
FSDK_API const char * | fsdk::getBuildInfo () noexcept |
Get FaceEngine build description. The descripton contains used flags and compler settings. More... | |
SDK version information routines.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() ![]() | SDK namespace |
![]() ![]() ![]() | Approximate Garbage Score estimator interface |
![]() ![]() ![]() | BestShotQuality estimator interface |
![]() ![]() ![]() ![]() | BestShotQualityEstimator output structure |
![]() ![]() ![]() | Eyes estimation output |
![]() ![]() ![]() ![]() | Eyes attribute structure |
![]() ![]() ![]() | EyeCropper is a helper structure for IEyeEstimator interface Methods of this structure crop an input warped image and returns rectangle coordinates of each eye |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() | Eye estimator interface |
![]() ![]() ![]() | Glasses estimator interface |
![]() ![]() ![]() | Head pose estimation output |
![]() ![]() ![]() | Head pose angles estimator interface |
![]() ![]() ![]() | Liveness OneShotRGB estimation structure |
![]() ![]() ![]() | OneShot RGB Liveness estimator interface |
![]() ![]() ![]() | MedicalMask estimator output structure. This structure contains the result of estimation ( |
![]() ![]() ![]() | MedicalMask estimator output structure. This structure contains the result of estimation ( |
![]() ![]() ![]() | MedicalMask estimator interface |
![]() ![]() ![]() | Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: |
![]() ![]() ![]() | Subjective Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: |
![]() ![]() ![]() | Image quality estimator interface |
![]() ![]() ![]() | |
![]() ![]() ![]() | Specialized for FSDKError |
![]() ![]() ![]() | Interface for running tasks asynchronously |
![]() ![]() ![]() | Result of descriptor matching |
![]() ![]() ![]() | Descriptor interface |
![]() ![]() ![]() | Descriptor batch interface |
![]() ![]() ![]() | Specialized for DescriptorBatchError |
![]() ![]() ![]() | Descriptor extractor interface |
![]() ![]() ![]() | Descriptor matcher interface |
![]() ![]() ![]() | Interface of BestDetection comparer. Implement it if you want to use own BestDetection strategy |
![]() ![]() ![]() | Syntax sugar, allows you to use lambdas to define a BestDetection comparer |
![]() ![]() ![]() | Face detector interface |
![]() ![]() ![]() | Face detection result batch interface |
![]() ![]() ![]() | Root LUNA SDK object interface |
![]() ![]() ![]() | Human detection result batch interface |
![]() ![]() ![]() | Human body detector interface |
![]() ![]() ![]() | Human detection area warper interface |
![]() ![]() ![]() | Result of index search |
![]() ![]() ![]() | Static descriptor storage interface |
![]() ![]() ![]() | Dynamic descriptor storage interface |
![]() ![]() ![]() | Base index interface |
![]() ![]() ![]() | Dense (read only) index interface |
![]() ![]() ![]() | Dynamic index interface |
![]() ![]() ![]() | Progress tracker interface |
![]() ![]() ![]() | Index builder interface |
![]() ![]() ![]() | License objects interface |
![]() ![]() ![]() | Archive interface |
![]() ![]() ![]() | Serializable object interface |
![]() ![]() ![]() | Specialized for ISerializableObject::SerializationError |
![]() ![]() ![]() | Data storage object interface helper |
![]() ![]() ![]() | Base strong reference counted object interface |
![]() ![]() ![]() | |
![]() ![]() ![]() | SDK settings provider interface |
![]() ![]() ![]() ![]() | Configuration parameter description |
![]() ![]() ![]() ![]() | Configuration parameter entry |
![]() ![]() ![]() ![]() | Configuration parameter key |
![]() ![]() ![]() ![]() | Configuration parameter value |
![]() ![]() ![]() ![]() ![]() | Value data |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() | Specialized for ISettingsProvider::ParseError |
![]() ![]() ![]() | Transformation data structure, used for warping |
![]() ![]() ![]() | Face detection area warper interface |
![]() ![]() ![]() | LaunchOptions struct configures inference options on per-estimator/detector basis, giving user fine grained control over cpu/gpu utilisation |
![]() ![]() ![]() | Detection structure. Stores a detected bounding box within a source image rect |
![]() ![]() ![]() | |
![]() ![]() ![]() | Image format |
![]() ![]() ![]() | Helper class to block copy operator&constructor of its descendants |
![]() ![]() ![]() | Promise class to support asynchronous data retrieval Look into std::promise semantics to understand it |
![]() ![]() ![]() | Future class to support asynchronous data retrieval Look into std::future semantics to understand it |
![]() ![]() ![]() | Specialized for Future::Error |
![]() ![]() ![]() | Specialized for Promise::Error |
![]() ![]() ![]() | |
![]() ![]() ![]() | Human keypoints landmark structure |
![]() ![]() ![]() | Human keypoints landmarks template structure |
![]() ![]() ![]() | Image |
![]() ![]() ![]() | Specialized for Image::Error |
![]() ![]() ![]() | Face landmarks template structure |
![]() ![]() ![]() | Enumerates detected landmarks. Only valid for template with 5 landmarks |
![]() ![]() ![]() | An error structure designed for functions which can return errors from different enum classes |
![]() ![]() ![]() | Specialized for MultiError |
![]() ![]() ![]() | Rectangle |
![]() ![]() ![]() | Smart pointer for reference counted objects |
![]() ![]() ![]() | Generic base class of a pointer for reference counted objects |
![]() ![]() ![]() | |
![]() ![]() ![]() | A structure that encapsulates an action result enumeration |
![]() ![]() ![]() | Addon for Result to output some value aside the result. Specialization for copiable types |
![]() ![]() ![]() | |
![]() ![]() ![]() | Addon for Result to output some value aside the result. Specialization for non copiable types |
![]() ![]() ![]() | Helper entity to measure size of dynamic objects in memory |
![]() ![]() ![]() | Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objects |
![]() ![]() ![]() | Sub Image |
![]() ![]() ![]() | Generic 2D vector |
![]() ![]() ![]() |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::FunctionDetectionComparer, including all inherited members.
+compare(const Image &img, const Detection &a, const Detection &b) const (defined in fsdk::FunctionDetectionComparer) | fsdk::FunctionDetectionComparer | inlinevirtual |
Function typedef (defined in fsdk::FunctionDetectionComparer) | fsdk::FunctionDetectionComparer | |
FunctionDetectionComparer(const Function &function) (defined in fsdk::FunctionDetectionComparer) | fsdk::FunctionDetectionComparer | inlineexplicit |
~IDetectionComparer()=default (defined in fsdk::IDetectionComparer) | fsdk::IDetectionComparer | virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Syntax sugar, allows you to use lambdas to define a BestDetection comparer. + More...
+ +#include <IDetector.h>
+Public Types | |
+typedef std::function< bool(const +Image &img, const Detection +&, const Detection &)> | Function |
+Public Member Functions | |
+ | FunctionDetectionComparer (const Function &function) |
+bool | compare (const Image &img, const Detection &a, const Detection &b) const |
Syntax sugar, allows you to use lambdas to define a BestDetection comparer.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Future< T >, including all inherited members.
+cancel(const ExecutionPolicy policy) noexcept | fsdk::Future< T > | |
DataType typedef | fsdk::Future< T > | |
Error typedef | fsdk::Future< T > | |
Future() noexcept | fsdk::Future< T > | |
Future(Future &&mv) noexcept (defined in fsdk::Future< T >) | fsdk::Future< T > | |
Noncopyable()=default (defined in fsdk::Noncopyable) | fsdk::Noncopyable | private |
operator=(Future &&) noexcept (defined in fsdk::Future< T >) | fsdk::Future< T > | |
state() const noexcept | fsdk::Future< T > | |
swap(Future &first, Future &second) noexcept | fsdk::Future< T > | static |
takeInto(DataType &container) noexcept | fsdk::Future< T > | |
USec typedef | fsdk::Future< T > | |
wait() const noexcept | fsdk::Future< T > | |
waitFor(const USec usec) const noexcept | fsdk::Future< T > | |
~Future() (defined in fsdk::Future< T >) | fsdk::Future< T > | |
~Noncopyable()=default (defined in fsdk::Noncopyable) | fsdk::Noncopyable | private |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Future class to support asynchronous data retrieval Look into std::future semantics to understand it. + More...
+ +#include <Future.h>
+Public Types | |
+using | USec = int32_t |
Alias for micro seconds type. | |
+using | Error = FutureError |
Alias for associated error type. | |
+using | DataType = T |
Alias for stored data type. | |
+Public Member Functions | |
+ | Future () noexcept |
Constructor for empty useless shell of a future. | |
+ | Future (Future &&mv) noexcept |
+Future & | operator= (Future &&) noexcept |
Result< Error > | cancel (const ExecutionPolicy policy) noexcept |
Cancel method. Might be called on some heavy long running task that is not needed anymore. Only makes sense if underlying state is Promised. More... | |
FuturePromiseState | state () const noexcept |
Returns current state of future-promise pair. More... | |
Result< Error > | takeInto (DataType &container) noexcept |
Method to retrieve data out of fulfilled future. Only makes sense if current state is Fulfilled. More... | |
Result< Error > | wait () const noexcept |
Blocks called thread until internal state changes to Fulfilled, Canceled or Failed. More... | |
Result< Error > | waitFor (const USec usec) const noexcept |
Blocks called thread until internal state changes to Fulfilled, Canceled or Failed, OR passed time is over. More... | |
+Static Public Member Functions | |
+static void | swap (Future &first, Future &second) noexcept |
Static method that swaps internal data between two passed futures. | |
Future class to support asynchronous data retrieval Look into std::future semantics to understand it.
+T | data type to store. |
+
|
+ +noexcept | +
Cancel method. Might be called on some heavy long running task that is not needed anymore. Only makes sense if underlying state is Promised.
+policy | Policy on how to behave: block till state becomes Canceled or run async. |
+
|
+ +noexcept | +
Returns current state of future-promise pair.
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDetectionComparer, including all inherited members.
+compare(const Image &img, const Detection &a, const Detection &b) const =0 (defined in fsdk::IDetectionComparer) | fsdk::IDetectionComparer | pure virtual |
~IDetectionComparer()=default (defined in fsdk::IDetectionComparer) | fsdk::IDetectionComparer | virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Interface of BestDetection comparer. Implement it if you want to use own BestDetection strategy. + More...
+ +#include <IDetector.h>
+Public Member Functions | |
+virtual bool | compare (const Image &img, const Detection &a, const Detection &b) const =0 |
Interface of BestDetection comparer. Implement it if you want to use own BestDetection strategy.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Noncopyable, including all inherited members.
+Noncopyable()=default (defined in fsdk::Noncopyable) | fsdk::Noncopyable | protected |
~Noncopyable()=default (defined in fsdk::Noncopyable) | fsdk::Noncopyable | protected |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Helper class to block copy operator&constructor of its descendants. + More...
+ +#include <Future.h>
Helper class to block copy operator&constructor of its descendants.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Promise< T >, including all inherited members.
+cancel() noexcept | fsdk::Promise< T > | |
DataType typedef | fsdk::Promise< T > | |
Error typedef | fsdk::Promise< T > | |
fail() noexcept | fsdk::Promise< T > | |
fulfill(DataType &&promisedData) noexcept | fsdk::Promise< T > | |
future(Result< Error > &error) noexcept | fsdk::Promise< T > | |
Noncopyable()=default (defined in fsdk::Noncopyable) | fsdk::Noncopyable | private |
operator=(Promise &&) noexcept (defined in fsdk::Promise< T >) | fsdk::Promise< T > | |
Promise() noexcept | fsdk::Promise< T > | |
Promise(Promise &&) noexcept (defined in fsdk::Promise< T >) | fsdk::Promise< T > | |
state() const noexcept | fsdk::Promise< T > | |
swap(Promise &first, Promise &second) noexcept | fsdk::Promise< T > | static |
~Noncopyable()=default (defined in fsdk::Noncopyable) | fsdk::Noncopyable | private |
~Promise() (defined in fsdk::Promise< T >) | fsdk::Promise< T > |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Promise class to support asynchronous data retrieval Look into std::promise semantics to understand it. + More...
+ +#include <Future.h>
+Public Types | |
+using | Error = PromiseError |
Alias for associated error type. | |
+using | DataType = T |
Alias for stored data type. | |
+Public Member Functions | |
+ | Promise () noexcept |
Constructor for empty Promise. | |
+ | Promise (Promise &&) noexcept |
+Promise & | operator= (Promise &&) noexcept |
Result< Error > | cancel () noexcept |
Cancel method. Think of it as acceptance of cancel requested by. More... | |
Result< Error > | fail () noexcept |
Fail method. Think of it as valid failure to run some promised function. Only makes sense if underlying state is Promised. More... | |
Result< Error > | fulfill (DataType &&promisedData) noexcept |
Fulfill promise with data. Only makes sense if underlying state is Promised. More... | |
Future< DataType > | future (Result< Error > &error) noexcept |
Create tethered future object. Only makes sense if underlying state is Empty. More... | |
FuturePromiseState | state () const noexcept |
Returns current state of future-promise pair. More... | |
+Static Public Member Functions | |
+static void | swap (Promise &first, Promise &second) noexcept |
Static method that swaps internal data between two passed promises. | |
Promise class to support asynchronous data retrieval Look into std::promise semantics to understand it.
+T | data type to store. |
+
|
+ +noexcept | +
Cancel method. Think of it as acceptance of cancel requested by.
+
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Create tethered future object. Only makes sense if underlying state is Empty.
+error | Reference to error object to indicate of failure |
+
|
+ +noexcept | +
Returns current state of future-promise pair.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Span< T >, including all inherited members.
+begin() | fsdk::Span< T > | inline |
begin() const | fsdk::Span< T > | inline |
cbegin() const | fsdk::Span< T > | inline |
cend() const | fsdk::Span< T > | inline |
const_iterator typedef (defined in fsdk::Span< T >) | fsdk::Span< T > | |
const_pointer typedef (defined in fsdk::Span< T >) | fsdk::Span< T > | |
const_reference typedef (defined in fsdk::Span< T >) | fsdk::Span< T > | |
data() const | fsdk::Span< T > | inline |
element_type typedef (defined in fsdk::Span< T >) | fsdk::Span< T > | |
empty() const | fsdk::Span< T > | inline |
end() | fsdk::Span< T > | inline |
end() const | fsdk::Span< T > | inline |
getSize() const | fsdk::Span< T > | inline |
index_type typedef (defined in fsdk::Span< T >) | fsdk::Span< T > | |
iterator typedef (defined in fsdk::Span< T >) | fsdk::Span< T > | |
operator=(Span const &)=default (defined in fsdk::Span< T >) | fsdk::Span< T > | |
operator=(ContiguousContainer &&container) | fsdk::Span< T > | inline |
operator[](std::size_t index) | fsdk::Span< T > | inline |
operator[](std::size_t index) const | fsdk::Span< T > | inline |
pointer typedef (defined in fsdk::Span< T >) | fsdk::Span< T > | |
reference typedef (defined in fsdk::Span< T >) | fsdk::Span< T > | |
setSize(std::size_t size) | fsdk::Span< T > | inline |
size() const | fsdk::Span< T > | inline |
Span()=default (defined in fsdk::Span< T >) | fsdk::Span< T > | |
Span(Span const &)=default (defined in fsdk::Span< T >) | fsdk::Span< T > | |
Span(T *data, std::size_t size) | fsdk::Span< T > | inline |
Span(ContiguousContainer &&container) | fsdk::Span< T > | inline |
value_type typedef (defined in fsdk::Span< T >) | fsdk::Span< T > |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objects. + More...
+ +#include <Span.h>
+Public Types | |
+using | element_type = T |
+using | value_type = typename std::remove_const< T >::type |
+using | index_type = std::ptrdiff_t |
+using | pointer = T * |
+using | reference = T & |
+using | iterator = pointer |
+using | const_pointer = T const * |
+using | const_reference = T const & |
+using | const_iterator = const_pointer |
+Public Member Functions | |
+ | Span (Span const &)=default |
+Span & | operator= (Span const &)=default |
Span (T *data, std::size_t size) | |
Constructor by pointer and size. More... | |
template<class ContiguousContainer > | |
Span (ContiguousContainer &&container) | |
Constructor by contiguous container. More... | |
template<class ContiguousContainer > | |
Span & | operator= (ContiguousContainer &&container) |
Assignment operator with contiguous container. More... | |
+reference | operator[] (std::size_t index) |
Square brackets operator for convenient acces to underlying array; param index Array index. | |
+const_reference | operator[] (std::size_t index) const |
Non-modifying square brackets operator for convenient acces to underlying array; param index Array index. | |
+bool | empty () const |
Returns true if the span is empty. | |
+pointer | data () const |
Returns a pointer to the beginning of the span. | |
+std::size_t | size () const |
Returns the number of elements in the span. | |
+std::size_t | getSize () const |
Returns the number of elements in the span. | |
+void | setSize (std::size_t size) |
Sets the number of elements in the span. Because the span is not owning, this method will no construct or destroy element. This method will not allocate or free memory. | |
+iterator | begin () |
Returns an iterator to the beginning of the span. | |
+const_iterator | begin () const |
Returns an const iterator to the beginning of the span. | |
+const_iterator | cbegin () const |
Returns an iterator to the beginning of the span. | |
+iterator | end () |
Returns an iterator to one past the end of the span. | |
+const_iterator | end () const |
Returns an const iterator to one past the end of the span. | |
+const_iterator | cend () const |
Returns an const iterator to one past the end of the span. | |
Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objects.
+
+
|
+ +inline | +
Constructor by pointer and size.
+data | A pointer to the beginning of the range of elements |
size | The number of elements pointed to by data |
+
|
+ +inline | +
Constructor by contiguous container.
+container | The container to construct from |
+
|
+ +inline | +
Assignment operator with contiguous container.
+container | The container to assign from |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Files | |
file | Detection.h [code] |
file | Face.h [code] |
file | FaceEngineEdition.h [code] |
file | Format.h [code] |
file | Future.h [code] |
file | Human.h [code] |
file | HumanLandmarks.h [code] |
file | Image.h [code] |
file | Landmarks.h [code] |
file | MultiError.h [code] |
file | OrientationType.h [code] |
file | Rect.h [code] |
file | Ref.h [code] |
file | RefBase.h [code] |
file | Result.h [code] |
file | ResultValue.h [code] |
file | Sizer.h [code] |
file | Span.h [code] |
file | SubImage.h [code] |
file | Vector2.h [code] |
file | WeakRef.h [code] |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Files | |
file | IAGSEstimator.h [code] |
file | IBestShotQualityEstimator.h [code] |
file | IEyeEstimator.h [code] |
file | IGlassesEstimator.h [code] |
file | IHeadPoseEstimator.h [code] |
file | ILivenessOneShotRGBEstimator.h [code] |
file | IMedicalMaskEstimator.h [code] |
file | IQualityEstimator.h [code] |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Directories | |
directory | fsdk |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Directories | |
directory | Estimators |
directory | Types |
+Files | |
file | Def.h [code] |
Common SDK definitions. | |
file | Exception.h [code] |
file | FaceEngine.h [code] |
Face detection, analyzing and recognition SDK interfaces, AIO public header. | |
file | FSDKError.h [code] |
Common SDK error codes. | |
file | FSDKVersion.h [code] |
file | IAsyncContext.h [code] |
Async context interface. | |
file | IDescriptor.h [code] |
Descriptor extractor and matcher interfaces. | |
file | IDetector.h [code] |
Face detector interfaces. | |
file | IFaceDetectionBatch.h [code] |
file | IFaceEngineMobile.h [code] |
file | IHumanDetectionBatch.h [code] |
file | IHumanDetector.h [code] |
file | IHumanWarper.h [code] |
Image warping base on Human detection. | |
file | IIndex.h [code] |
file | ILicense.h [code] |
file | IObject.h [code] |
Object system types and interfaces. | |
file | IRefCounted.h [code] |
Reference counted object interface. | |
file | IResultBatch.h [code] |
file | ISettingsProvider.h [code] |
Settings provider interface. | |
file | IWarper.h [code] |
Image and landmarks warping. | |
file | LaunchOptions.h [code] |
file | Log.h [code] |
Log interfaces. | |
file | Optional.h [code] |
file | Types.h [code] |
Common data types and structures. | |
file | Version.h [code] |
SDK version information routines. | |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() ![]() | |
![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | Common SDK definitions |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | Face detection, analyzing and recognition SDK interfaces, AIO public header |
![]() ![]() ![]() ![]() | Common SDK error codes |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | Async context interface |
![]() ![]() ![]() ![]() | Descriptor extractor and matcher interfaces |
![]() ![]() ![]() ![]() | Face detector interfaces |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | Image warping base on Human detection |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | Object system types and interfaces |
![]() ![]() ![]() ![]() | Reference counted object interface |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | Settings provider interface |
![]() ![]() ![]() ![]() | Image and landmarks warping |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | Log interfaces |
![]() ![]() ![]() ![]() | |
![]() ![]() ![]() ![]() | Common data types and structures |
![]() ![]() ![]() ![]() | SDK version information routines |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Common interfaces and macros shared across all SDK objects. +More...
++Classes | |
struct | fsdk::IFaceEngineMobile |
Root LUNA SDK object interface. More... | |
struct | fsdk::IArchive |
Archive interface. More... | |
struct | fsdk::ISerializableObject |
Serializable object interface. More... | |
struct | fsdk::ErrorTraits< ISerializableObject::Error > |
Specialized for ISerializableObject::SerializationError. More... | |
struct | fsdk::IDataStorageObject |
Data storage object interface helper. More... | |
struct | fsdk::IRefCounted |
Base strong reference counted object interface. More... | |
struct | fsdk::ISettingsProvider |
SDK settings provider interface. More... | |
struct | fsdk::ErrorTraits< ISettingsProvider::Error > |
Specialized for ISettingsProvider::ParseError. More... | |
+Macros | |
#define | ALIGN_UP(value, align) |
+#define | ALIGNED(x) __attribute__ ((aligned(x))) |
+#define | RESTRICT __restrict__ |
+#define | FORCE_INLINE inline __attribute__ ((always_inline)) |
+#define | DECLARE_SMARTPTR(X) struct X; using X##Ptr = fsdk::Ref<X> |
Smart ptr declaration helper macro. | |
+#define | STRINGIFY2(x) #x |
Stringification helper macro. | |
+#define | STRINGIFY(x) STRINGIFY2(x) |
Stringifies it's argument. | |
+Functions | |
virtual ResultValue< FSDKError, +IDetectorPtr > | fsdk::IFaceEngineMobile::createDetector () noexcept=0 |
Creates a detector of given type. More... | |
virtual ResultValue< FSDKError, +IHeadPoseEstimatorPtr > | fsdk::IFaceEngineMobile::createHeadPoseEstimator () noexcept=0 |
Creates Head pose estimator. More... | |
virtual ResultValue< FSDKError, +IAGSEstimatorPtr > | fsdk::IFaceEngineMobile::createAGSEstimator () noexcept=0 |
Creates AGS estimator. More... | |
virtual ResultValue< FSDKError, +IEyeEstimatorPtr > | fsdk::IFaceEngineMobile::createEyeEstimator () noexcept=0 |
Creates Eye estimator. More... | |
virtual ResultValue< FSDKError, +IMedicalMaskEstimatorPtr > | fsdk::IFaceEngineMobile::createMedicalMaskEstimator () noexcept=0 |
Creates MedicalMask estimator. More... | |
virtual ResultValue< FSDKError, +IGlassesEstimatorPtr > | fsdk::IFaceEngineMobile::createGlassesEstimator () noexcept=0 |
Creates Glasses estimator. More... | |
virtual ResultValue< FSDKError, +IQualityEstimatorPtr > | fsdk::IFaceEngineMobile::createQualityEstimator () noexcept=0 |
Creates Quality estimator. More... | |
virtual ResultValue< FSDKError, +IBestShotQualityEstimatorPtr > | fsdk::IFaceEngineMobile::createBestShotQualityEstimator () noexcept=0 |
Creates BestShotQuality estimator. More... | |
virtual ResultValue< FSDKError, +ILivenessOneShotRGBEstimatorPtr > | fsdk::IFaceEngineMobile::createLivenessOneShotRGBEstimator () noexcept=0 |
Creates Liveness OneShot estimator. More... | |
virtual ResultValue< FSDKError, +IDescriptorPtr > | fsdk::IFaceEngineMobile::createDescriptor (uint32_t version=0) noexcept=0 |
Creates Descriptor. More... | |
virtual ResultValue< FSDKError, +IDescriptorPtr > | fsdk::IFaceEngineMobile::createDescriptor (IArchive *archive, uint32_t flags=0) noexcept=0 |
Creates and loads Descriptor from Archive. More... | |
virtual ResultValue< FSDKError, +IDescriptorBatchPtr > | fsdk::IFaceEngineMobile::createDescriptorBatch (int32_t size, uint32_t version=0) noexcept=0 |
Creates Batch of descriptors. More... | |
virtual ResultValue< FSDKError, +IDescriptorExtractorPtr > | fsdk::IFaceEngineMobile::createExtractor (uint32_t version=0) noexcept=0 |
Creates descriptor extractor. More... | |
virtual ResultValue< FSDKError, +IDescriptorMatcherPtr > | fsdk::IFaceEngineMobile::createMatcher (uint32_t version=0) noexcept=0 |
Creates descriptor matcher. More... | |
virtual ResultValue< FSDKError, +IWarperPtr > | fsdk::IFaceEngineMobile::createWarper () noexcept=0 |
Creates warper. More... | |
virtual FaceEngineEdition | fsdk::IFaceEngineMobile::getFaceEngineEdition () const noexcept=0 |
Get LUNA SDK ditribution edition. More... | |
virtual void | fsdk::IFaceEngineMobile::setDataDirectory (const char *path) noexcept=0 |
Sets data directory. More... | |
virtual const char * | fsdk::IFaceEngineMobile::getDataDirectory () const noexcept=0 |
Gets data directory. More... | |
virtual void | fsdk::IFaceEngineMobile::setSettingsProvider (ISettingsProvider *provider) noexcept=0 |
Sets settings provider. More... | |
virtual void | fsdk::IFaceEngineMobile::setRuntimeSettingsProvider (ISettingsProvider *provider) noexcept=0 |
Sets runtime settings provider. More... | |
virtual ISettingsProvider * | fsdk::IFaceEngineMobile::getSettingsProvider () const noexcept=0 |
Gets settings provider. More... | |
virtual ISettingsProvider * | fsdk::IFaceEngineMobile::getRuntimeSettingsProvider () const noexcept=0 |
Gets runtime settings provider. More... | |
virtual ILicense * | fsdk::IFaceEngineMobile::getLicense () const noexcept=0 |
Get current License object, which was set for FaceEngine object. More... | |
FSDK_API Result< FSDKError > | fsdk::activateLicense (ILicense *license, const char *configPath) noexcept |
Makes License activation with some platform specific manner. Network connection is required. More... | |
FSDK_API Result< FSDKError > | fsdk::activateLicense (ILicense *license, ISettingsProvider *settings) noexcept |
Makes License activation with some platform specific manner. Network connection is required. More... | |
FSDK_API ResultValue +< FSDKError, +IFaceEngineMobilePtr > | fsdk::createFaceEngineMobile (const char *dataPath=nullptr, const char *configPath=nullptr, const char *runtimePath=nullptr) noexcept |
Create the LUNA SDK root object. More... | |
FSDK_API ResultValue +< FSDKError, +ISettingsProviderPtr > | fsdk::createSettingsProvider (const char *path) noexcept |
Create a settings provider. More... | |
Common interfaces and macros shared across all SDK objects.
+#define ALIGN_UP | +( | ++ | value, | +
+ | + | + | align | +
+ | ) | ++ |
+
|
+ +noexcept | +
Makes License activation with some platform specific manner. Network connection is required.
+[in] | license | pointer to the license object which should be activated |
[in] | configPath | path to license.conf file with licensing settings. |
+
|
+ +noexcept | +
Makes License activation with some platform specific manner. Network connection is required.
+[in] | license | pointer to the license object which should be activated |
[in] | provider | settings provider. |
+
|
+ +pure virtualnoexcept | +
Creates AGS estimator.
+
+
|
+ +pure virtualnoexcept | +
Creates BestShotQuality estimator.
+
+
|
+ +pure virtualnoexcept | +
Creates Descriptor.
+[in] | version | descriptor version. |
face descriptor will created by default, to create human descriptor pass version, minimum version of human descriptor is DV_MIN_HUMAN_DESCRIPTOR_VERSION == 102
+
+
|
+ +pure virtualnoexcept | +
Creates and loads Descriptor from Archive.
+[in] | archive | Archive with descriptor. |
[in] | flags | Archive flag. |
+
|
+ +pure virtualnoexcept | +
Creates Batch of descriptors.
+face descriptor batch will be created by default, to create human descriptor batch you must pass version, minimum version of human descriptor is DV_MIN_HUMAN_DESCRIPTOR_VERSION == 102
+[in] | size | - amount of descriptors in batch. |
[in] | version | - descriptor version in batch. If 0 - use dafault version from config. |
+
|
+ +pure virtualnoexcept | +
Creates a detector of given type.
+
+
|
+ +pure virtualnoexcept | +
Creates descriptor extractor.
+[in] | version | descriptor version. |
face descriptor extractor will created by default, to create human descriptor extractor descriptor you must pass version, minimum version of human descriptor is DV_MIN_HUMAN_DESCRIPTOR_VERSION == 102
+
+
|
+ +pure virtualnoexcept | +
Creates Eye estimator.
+
+
|
+ +noexcept | +
Create the LUNA SDK root object.
+[in] | dataPath | [optional] path to folder with FSDK data. Default: ./data (on windows), /opt/visionlabs/data (on linux) |
[in] | configPath | [optional] path to faceengine.conf file. Default: <dataPath>/faceengine.cong |
[in] | runtimePath | [optional] path to runtime.conf file. Default: <dataPath>/runtime.cong |
+
|
+ +pure virtualnoexcept | +
Creates Glasses estimator.
+
+
|
+ +pure virtualnoexcept | +
Creates Head pose estimator.
+
+
|
+ +pure virtualnoexcept | +
Creates Liveness OneShot estimator.
+
+
|
+ +pure virtualnoexcept | +
Creates descriptor matcher.
+[in] | version | descriptor version. |
face descriptor matcher will created by default, to create human descriptor matcher you must pass version, minimum version of human descriptor is DV_MIN_HUMAN_DESCRIPTOR_VERSION == 102
+
+
|
+ +pure virtualnoexcept | +
Creates MedicalMask estimator.
+
+
|
+ +pure virtualnoexcept | +
Creates Quality estimator.
+
+
|
+ +noexcept | +
Create a settings provider.
+[in] | path | configuration file path. |
+
|
+ +pure virtualnoexcept | +
Creates warper.
+
+
|
+ +pure virtualnoexcept | +
Gets data directory.
+By default is set to "./data".
+
+
|
+ +pure virtualnoexcept | +
Get LUNA SDK ditribution edition.
+
+
|
+ +pure virtualnoexcept | +
Get current License object, which was set for FaceEngine object.
+
+
|
+ +pure virtualnoexcept | +
Gets runtime settings provider.
+
+
|
+ +pure virtualnoexcept | +
Gets settings provider.
+
+
|
+ +pure virtualnoexcept | +
Sets data directory.
+[in] | path | path to data directory. |
+
|
+ +pure virtualnoexcept | +
Sets runtime settings provider.
+[in] | provider | runtime settings provider. |
+
|
+ +pure virtualnoexcept | +
Sets settings provider.
+[in] | provider | settings provider. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Descriptor extractor public interfaces and related types and structures. +More...
++Classes | |
struct | fsdk::MatchingResult |
Result of descriptor matching. More... | |
struct | fsdk::IDescriptor |
Descriptor interface. More... | |
struct | fsdk::IDescriptorBatch |
Descriptor batch interface. More... | |
struct | fsdk::ErrorTraits< IDescriptorBatch::Error > |
Specialized for DescriptorBatchError. More... | |
struct | fsdk::IDescriptorExtractor |
Descriptor extractor interface. More... | |
struct | fsdk::IDescriptorMatcher |
Descriptor matcher interface. More... | |
+Enumerations | |
enum | fsdk::DescriptorType { fsdk::DT_FACE, +fsdk::DT_HUMAN + } |
Descriptor type enum. Determines which type of descriptor to use. More... | |
enum | fsdk::DescriptorVersion : uint32_t { fsdk::DV_MIN_FACE_DESCRIPTOR_VERSION = 46, +fsdk::DV_MIN_HUMAN_DESCRIPTOR_VERSION = 102 + } |
Minimum descriptor model version. Determines which minimum version of descriptor to use. More... | |
enum | fsdk::HumanDescriptorVersion : uint32_t { fsdk::HDV_TRACKER_HUMAN_DESCRIPTOR_VERSION = 102, +fsdk::HDV_PRECISE_HUMAN_DESCRIPTOR_VERSION = 103, +fsdk::HDV_REGULAR_HUMAN_DESCRIPTOR_VERSION = 104 + } |
Human descriptor model versions. Determines which version of human descriptor to use. More... | |
Descriptor extractor public interfaces and related types and structures.
+enum fsdk::DescriptorType | +
enum fsdk::DescriptorVersion : uint32_t | +
enum fsdk::HumanDescriptorVersion : uint32_t | +
Human descriptor model versions. Determines which version of human descriptor to use.
+Enumerator | |
---|---|
HDV_TRACKER_HUMAN_DESCRIPTOR_VERSION |
+ human descriptor for tracking of people, light and fast version. + |
HDV_PRECISE_HUMAN_DESCRIPTOR_VERSION |
+ precise human descriptor, heavy and slow. + |
HDV_REGULAR_HUMAN_DESCRIPTOR_VERSION |
+ regular human descriptor. + |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Face detector public interfaces and related types and structures. +More...
++Classes | |
class | fsdk::IDetectionComparer |
Interface of BestDetection comparer. Implement it if you want to use own BestDetection strategy. More... | |
class | fsdk::FunctionDetectionComparer |
Syntax sugar, allows you to use lambdas to define a BestDetection comparer. More... | |
struct | fsdk::IDetector |
face detector interface. More... | |
struct | fsdk::IHumanDetector |
human body detector interface. More... | |
+Enumerations | |
enum | fsdk::ObjectDetectorClassType { + fsdk::FACE_DET_DEFAULT = 0, +fsdk::FACE_DET_V1 = 4, +fsdk::FACE_DET_V2 = 5, +fsdk::FACE_DET_V3 = 6, + + fsdk::FACE_DET_COUNT = 7 + + } |
Object detector type enumeration. More... | |
enum | fsdk::DetectionComparerType { + fsdk::DCT_CONFIDENCE = 0, +fsdk::DCT_CENTER, +fsdk::DCT_CENTER_AND_CONFIDENCE, +fsdk::DCT_SIZE, + + DCT_COUNT + + } |
Strategy of BestDetections comparer. More... | |
enum | fsdk::DetectionType { fsdk::DT_BBOX = 0, +fsdk::DT_LANDMARKS5 = 1<<0, +fsdk::DT_LANDMARKS68 = 1<<1, +fsdk::DT_ALL = 0xffff + } |
Detection type enumeration. More... | |
enum | fsdk::HumanDetectionType { fsdk::HDT_BOX = 0, +fsdk::HDT_POINTS = 1<<0, +fsdk::HDT_ALL = 0xffff + } |
Human detection type enumeration. More... | |
+Functions | |
+DetectionType | fsdk::operator| (DetectionType a, DetectionType b) |
+HumanDetectionType | fsdk::operator| (HumanDetectionType a, HumanDetectionType b) |
Face detector public interfaces and related types and structures.
+Human detector public interfaces and related types and structures.
+enum fsdk::DetectionComparerType | +
Strategy of BestDetections comparer.
+Enumerator | |
---|---|
DCT_CONFIDENCE |
+ BestDetection - detections with highest score. + |
DCT_CENTER |
+ BestDetection - most centered detection. + |
DCT_CENTER_AND_CONFIDENCE |
+ bestDetection - most centered with high score. + |
DCT_SIZE |
+ bestDetection - the largest detection. + |
enum fsdk::DetectionType | +
Detection type enumeration.
+Enumerator | |
---|---|
DT_BBOX |
+ Get bounding boxes of faces. + |
DT_LANDMARKS5 |
+ Get bounding boxes and 5 facial landmarks. + |
DT_LANDMARKS68 |
+ Get bounding boxes and 68 facial landmarks. + |
DT_ALL |
+ Get all supported parameters. + |
enum fsdk::HumanDetectionType | +
Human detection type enumeration.
+Enumerator | |
---|---|
HDT_BOX |
+ Get bounding boxes of human bodies. + |
HDT_POINTS |
+ Get 17 keypoints of human, with score for each one. + |
HDT_ALL |
+ Get all supported parameters. + |
enum fsdk::ObjectDetectorClassType | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
SDK Build type and version info. +More...
++Classes | |
struct | fsdk::Version |
+Functions | |
bool | fsdk::operator< (Version lhs, Version rhs) noexcept |
Check if one version is less than another. More... | |
bool | fsdk::operator== (Version lhs, Version rhs) noexcept |
Check if versions are equal. More... | |
bool | fsdk::operator!= (Version lhs, Version rhs) noexcept |
Check if versions are not equal. More... | |
FSDK_API Version | fsdk::getVersion () noexcept |
Get FaceEngine version. More... | |
FSDK_API const char * | fsdk::getVersionHash () noexcept |
Get FaceEngine commit hash. More... | |
FSDK_API const char * | fsdk::getVersionString () noexcept |
Get FaceEngine version string. More... | |
FSDK_API const char * | fsdk::getBuildInfo () noexcept |
Get FaceEngine build description. The descripton contains used flags and compler settings. More... | |
SDK Build type and version info.
+
+
|
+ +noexcept | +
Get FaceEngine build description. The descripton contains used flags and compler settings.
+
+
|
+ +noexcept | +
Get FaceEngine version.
+
+
|
+ +noexcept | +
Get FaceEngine commit hash.
+
+
|
+ +noexcept | +
Get FaceEngine version string.
+
+
|
+ +inlinenoexcept | +
Check if versions are not equal.
+lhs | first version |
rhs | second version |
+
|
+ +inlinenoexcept | +
Check if one version is less than another.
+lhs | first version |
rhs | second version |
+
|
+ +inlinenoexcept | +
Check if versions are equal.
+lhs | first version |
rhs | second version |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() ![]() | Rectangle |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | Value data |
![]() ![]() | Configuration parameter description |
![]() ![]() | Detection structure. Stores a detected bounding box within a source image rect |
![]() ![]() | Configuration parameter entry |
![]() ![]() | |
![]() ![]() | Specialized for FSDKError |
![]() ![]() | Specialized for Future::Error |
![]() ![]() | Specialized for DescriptorBatchError |
![]() ![]() | Specialized for Image::Error |
![]() ![]() | Specialized for ISerializableObject::SerializationError |
![]() ![]() | Specialized for ISettingsProvider::ParseError |
![]() ![]() | Specialized for MultiError |
![]() ![]() | Specialized for Promise::Error |
![]() ![]() | BestShotQualityEstimator output structure |
![]() ![]() | |
![]() ![]() | Eyes attribute structure |
![]() ![]() | EyeCropper is a helper structure for IEyeEstimator interface Methods of this structure crop an input warped image and returns rectangle coordinates of each eye |
![]() ![]() | Eyes estimation output |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | Image format |
![]() ![]() | Head pose estimation output |
![]() ![]() | |
![]() ![]() | Human keypoints landmark structure |
![]() ![]() | Human keypoints landmarks template structure |
![]() ![]() | Archive interface |
![]() ![]() | Interface of BestDetection comparer. Implement it if you want to use own BestDetection strategy |
![]() ![]() ![]() | Syntax sugar, allows you to use lambdas to define a BestDetection comparer |
![]() ![]() | Image |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | Progress tracker interface |
![]() ![]() | Base strong reference counted object interface |
![]() ![]() ![]() | Approximate Garbage Score estimator interface |
![]() ![]() ![]() | Interface for running tasks asynchronously |
![]() ![]() ![]() | BestShotQuality estimator interface |
![]() ![]() ![]() | Descriptor extractor interface |
![]() ![]() ![]() | Descriptor matcher interface |
![]() ![]() ![]() | Face detector interface |
![]() ![]() ![]() | Eye estimator interface |
![]() ![]() ![]() | Face detection result batch interface |
![]() ![]() ![]() | Root LUNA SDK object interface |
![]() ![]() ![]() | Glasses estimator interface |
![]() ![]() ![]() | Head pose angles estimator interface |
![]() ![]() ![]() | Human detection result batch interface |
![]() ![]() ![]() | Human body detector interface |
![]() ![]() ![]() | Human detection area warper interface |
![]() ![]() ![]() | Base index interface |
![]() ![]() ![]() ![]() | Dense (read only) index interface |
![]() ![]() ![]() ![]() | Dynamic index interface |
![]() ![]() ![]() | Index builder interface |
![]() ![]() ![]() | License objects interface |
![]() ![]() ![]() | OneShot RGB Liveness estimator interface |
![]() ![]() ![]() | MedicalMask estimator interface |
![]() ![]() ![]() | Image quality estimator interface |
![]() ![]() ![]() | |
![]() ![]() ![]() | Serializable object interface |
![]() ![]() ![]() ![]() | Data storage object interface helper |
![]() ![]() ![]() ![]() ![]() | Descriptor interface |
![]() ![]() ![]() ![]() ![]() | Descriptor batch interface |
![]() ![]() ![]() | SDK settings provider interface |
![]() ![]() ![]() | Face detection area warper interface |
![]() ![]() | Static descriptor storage interface |
![]() ![]() ![]() | Dense (read only) index interface |
![]() ![]() ![]() | Dynamic descriptor storage interface |
![]() ![]() ![]() ![]() | Dynamic index interface |
![]() ![]() ![]() ![]() | Index builder interface |
![]() ![]() | Configuration parameter key |
![]() ![]() | Face landmarks template structure |
![]() ![]() | Enumerates detected landmarks. Only valid for template with 5 landmarks |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | LaunchOptions struct configures inference options on per-estimator/detector basis, giving user fine grained control over cpu/gpu utilisation |
![]() ![]() | Liveness OneShotRGB estimation structure |
![]() ![]() | Result of descriptor matching |
![]() ![]() ![]() | Result of index search |
![]() ![]() | MedicalMask estimator output structure. This structure contains the result of estimation ( |
![]() ![]() | MedicalMask estimator output structure. This structure contains the result of estimation ( |
![]() ![]() | An error structure designed for functions which can return errors from different enum classes |
![]() ![]() | Helper class to block copy operator&constructor of its descendants |
![]() ![]() ![]() | Future class to support asynchronous data retrieval Look into std::future semantics to understand it |
![]() ![]() ![]() | Promise class to support asynchronous data retrieval Look into std::promise semantics to understand it |
![]() ![]() | Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: |
![]() ![]() | Generic base class of a pointer for reference counted objects |
![]() ![]() ![]() | Smart pointer for reference counted objects |
![]() ![]() | A structure that encapsulates an action result enumeration |
![]() ![]() | |
![]() ![]() ![]() | Addon for Result to output some value aside the result. Specialization for copiable types |
![]() ![]() ![]() | |
![]() ![]() ![]() | Addon for Result to output some value aside the result. Specialization for non copiable types |
![]() ![]() | Helper entity to measure size of dynamic objects in memory |
![]() ![]() | Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objects |
![]() ![]() | |
![]() ![]() | Sub Image |
![]() ![]() | Subjective Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: |
![]() ![]() | Transformation data structure, used for warping |
![]() ![]() | Configuration parameter value |
![]() ![]() | Generic 2D vector |
![]() ![]() | |
![]() ![]() | |
![]() ![]() |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Welcome to the FaceEngine reference manual! This documentations covers all public interfaces and types.
+Advanced usage Advanced usage is covered in the Face Engine handbook. Please contact us via e-mail: info@.nosp@m.visi.nosp@m.onlab.nosp@m.s.ru if you haven't got one.
+Example code Examples located at /examples folder of LUNA SDK package.
+LUNA SDK consists of the following modules:
+t |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() | Descriptor extractor public interfaces and related types and structures |
![]() | Face detector public interfaces and related types and structures |
![]() | Common interfaces and macros shared across all SDK objects |
![]() | SDK Build type and version info |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
SDK namespace. +More...
++Classes | |
struct | IAGSEstimator |
Approximate Garbage Score estimator interface. More... | |
struct | IBestShotQualityEstimator |
BestShotQuality estimator interface. More... | |
struct | EyesEstimation |
Eyes estimation output. More... | |
struct | EyeCropper |
EyeCropper is a helper structure for IEyeEstimator interface Methods of this structure crop an input warped image and returns rectangle coordinates of each eye. More... | |
struct | IEyeEstimator |
Eye estimator interface. More... | |
struct | IGlassesEstimator |
Glasses estimator interface. More... | |
struct | HeadPoseEstimation |
Head pose estimation output. More... | |
struct | IHeadPoseEstimator |
Head pose angles estimator interface. More... | |
struct | LivenessOneShotRGBEstimation |
Liveness OneShotRGB estimation structure. More... | |
struct | ILivenessOneShotRGBEstimator |
OneShot RGB Liveness estimator interface. More... | |
struct | MedicalMaskEstimation |
MedicalMask estimator output structure. This structure contains the result of estimation (. More... | |
struct | MedicalMaskEstimationExtended |
MedicalMask estimator output structure. This structure contains the result of estimation (. More... | |
struct | IMedicalMaskEstimator |
MedicalMask estimator interface. More... | |
struct | Quality |
Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: More... | |
struct | SubjectiveQuality |
Subjective Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: More... | |
struct | IQualityEstimator |
Image quality estimator interface. More... | |
struct | Exception |
struct | ErrorTraits< FSDKError > |
Specialized for FSDKError. More... | |
struct | IAsyncContext |
Interface for running tasks asynchronously. More... | |
struct | MatchingResult |
Result of descriptor matching. More... | |
struct | IDescriptor |
Descriptor interface. More... | |
struct | IDescriptorBatch |
Descriptor batch interface. More... | |
struct | ErrorTraits< IDescriptorBatch::Error > |
Specialized for DescriptorBatchError. More... | |
struct | IDescriptorExtractor |
Descriptor extractor interface. More... | |
struct | IDescriptorMatcher |
Descriptor matcher interface. More... | |
class | IDetectionComparer |
Interface of BestDetection comparer. Implement it if you want to use own BestDetection strategy. More... | |
class | FunctionDetectionComparer |
Syntax sugar, allows you to use lambdas to define a BestDetection comparer. More... | |
struct | IDetector |
face detector interface. More... | |
struct | IFaceDetectionBatch |
Face detection result batch interface. More... | |
struct | IFaceEngineMobile |
Root LUNA SDK object interface. More... | |
struct | IHumanDetectionBatch |
Human detection result batch interface. More... | |
struct | IHumanDetector |
human body detector interface. More... | |
struct | IHumanWarper |
Human detection area warper interface. More... | |
struct | SearchResult |
Result of index search. More... | |
struct | IStaticDescriptorStorage |
Static descriptor storage interface. More... | |
struct | IDynamicDescriptorStorage |
Dynamic descriptor storage interface. More... | |
struct | IIndex |
Base index interface. More... | |
struct | IDenseIndex |
Dense (read only) index interface. More... | |
struct | IDynamicIndex |
Dynamic index interface. More... | |
struct | IProgressTracker |
Progress tracker interface. More... | |
struct | IIndexBuilder |
Index builder interface. More... | |
struct | ILicense |
License objects interface. More... | |
struct | IArchive |
Archive interface. More... | |
struct | ISerializableObject |
Serializable object interface. More... | |
struct | ErrorTraits< ISerializableObject::Error > |
Specialized for ISerializableObject::SerializationError. More... | |
struct | IDataStorageObject |
Data storage object interface helper. More... | |
struct | IRefCounted |
Base strong reference counted object interface. More... | |
struct | IResultBatch |
struct | ISettingsProvider |
SDK settings provider interface. More... | |
struct | ErrorTraits< ISettingsProvider::Error > |
Specialized for ISettingsProvider::ParseError. More... | |
struct | Transformation |
Transformation data structure, used for warping. More... | |
struct | IWarper |
Face detection area warper interface. More... | |
struct | LaunchOptions |
LaunchOptions struct configures inference options on per-estimator/detector basis, giving user fine grained control over cpu/gpu utilisation. More... | |
struct | Detection |
Detection structure. Stores a detected bounding box within a source image rect. More... | |
struct | Face |
struct | Format |
Image format. More... | |
class | Noncopyable |
Helper class to block copy operator&constructor of its descendants. More... | |
class | Promise |
Promise class to support asynchronous data retrieval Look into std::promise semantics to understand it. More... | |
class | Future |
Future class to support asynchronous data retrieval Look into std::future semantics to understand it. More... | |
struct | ErrorTraits< FutureError > |
Specialized for Future::Error. More... | |
struct | ErrorTraits< PromiseError > |
Specialized for Promise::Error. More... | |
struct | Human |
struct | HumanLandmark |
Human keypoints landmark structure. More... | |
struct | HumanLandmarks |
Human keypoints landmarks template structure. More... | |
struct | Image |
Image. More... | |
struct | ErrorTraits< Image::Error > |
Specialized for Image::Error. More... | |
struct | Landmarks |
Face landmarks template structure. More... | |
struct | Landmarks5Indexes |
Enumerates detected landmarks. Only valid for template with 5 landmarks. More... | |
struct | MultiError |
An error structure designed for functions which can return errors from different enum classes. More... | |
struct | ErrorTraits< MultiError< E0, E1 > > |
Specialized for MultiError. More... | |
struct | BaseRect |
Rectangle. More... | |
struct | Ref |
Smart pointer for reference counted objects. More... | |
struct | RefBase |
Generic base class of a pointer for reference counted objects. More... | |
struct | ErrorTraits |
struct | Result |
A structure that encapsulates an action result enumeration. More... | |
struct | ResultValue |
Addon for Result to output some value aside the result. Specialization for copiable types. More... | |
struct | ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > |
struct | ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > |
Addon for Result to output some value aside the result. Specialization for non copiable types. More... | |
struct | Sizer |
Helper entity to measure size of dynamic objects in memory. More... | |
class | Span |
Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objects. More... | |
struct | SubImage |
Sub Image. More... | |
struct | Vector2 |
Generic 2D vector. More... | |
struct | Version |
+Typedefs | |
+using | FaceEngineType = IFaceEngineMobile |
+using | FaceEnginePtrType = IFaceEngineMobilePtr |
+using | DescriptorId = size_t |
Intergral type used as identification of descriptor in internal storage. | |
+template<typename T > | |
using | Optional = optional< T > |
+using | HumanLandmarks17 = HumanLandmarks< 17 > |
alias for structure with 17 landmarks | |
+using | ImageType = Image::Type |
Convenient type aliases for fsdk::Image enum classes. | |
+using | ImageError = Image::Error |
+using | TargetDevice = Image::TargetDevice |
+using | ImageCompression = Image::ImageCompression |
+typedef Vector2< float > | Landmark |
Landmark floating point coordinates type. | |
+using | Landmarks5 = Landmarks< 5 > |
alias for structure with 5 landmarks | |
+using | Landmarks68 = Landmarks< 68 > |
alias for structure with 68 landmarks | |
+using | Rect = BaseRect< int > |
+using | FloatRect = BaseRect< float > |
typedef Vector2< float > | Point2f |
typedef Vector2< double > | Point2d |
typedef Vector2< int > | Point2i |
typedef Vector2< unsigned int > | Point2u |
typedef Vector2< unsigned short > | Point2us |
typedef Vector2< int > | Size |
+Enumerations | |
enum | GlassesEstimation : uint8_t { GlassesEstimation::NoGlasses, +GlassesEstimation::EyeGlasses, +GlassesEstimation::SunGlasses, +GlassesEstimation::EstimationError + } |
Glasses estimation enum. More... | |
enum | MedicalMask { MedicalMask::Mask = 0, +MedicalMask::NoMask, +MedicalMask::OccludedFace + } |
MedicalMask estimator output enum. This enum contains all possible estimation results. More... | |
enum | MedicalMaskExtended { MedicalMaskExtended::Mask = 0, +MedicalMaskExtended::NoMask, +MedicalMaskExtended::MaskNotInPlace, +MedicalMaskExtended::OccludedFace + } |
MedicalMask estimator output enum. This enum contains all possible extended estimation results. More... | |
enum | DetailedMaskType { + DetailedMaskType::CorrectMask = 0, +DetailedMaskType::MouthCoveredWithMask, +DetailedMaskType::ClearFace, +DetailedMaskType::ClearFaceWithMaskUnderChin, + + DetailedMaskType::PartlyCoveredFace, +DetailedMaskType::FullMask, +Count + + } |
MedicalMask estimator output enum. This enum contains all type of DetailedMaskType results. More... | |
enum | FSDKError : uint32_t { + FSDKError::Ok, +FSDKError::Internal, +FSDKError::InvalidInput, +FSDKError::InvalidImage, + + FSDKError::InvalidRect, +FSDKError::InvalidImageFormat, +FSDKError::InvalidImageSize, +FSDKError::InvalidDetection, + + FSDKError::InvalidLandmarks5, +FSDKError::InvalidLandmarks68, +FSDKError::InvalidTransformation, +FSDKError::InvalidDescriptor, + + FSDKError::InvalidDescriptorBatch, +FSDKError::InvalidSettingsProvider, +FSDKError::InvalidDescriptorId, +FSDKError::InvalidPath, + + FSDKError::InvalidSerializedObject, +FSDKError::ModuleNotInitialized, +FSDKError::ModuleNotReady, +FSDKError::LicenseError, + + FSDKError::BufferIsNull, +FSDKError::BufferIsFull, +FSDKError::BufferIsEmpty, +FSDKError::InvalidBufferSize, + + FSDKError::InvalidSpanSize, +FSDKError::InvalidBatch, +FSDKError::IncompatibleDescriptors, +FSDKError::EnableJustInBetaMode, + + FSDKError::FiltredAggregationError, +FSDKError::BatchedInternalError, +UnsupportedFunctionality, +HighMemoryUsage, + + FSDKError::IncompatibleModelVersions, +FSDKError::ModelNotLoaded, +FSDKError::InvalidConfig, +FSDKError::LicenseIsNotActivated, + + FSDKError::FeatureNotAvailable, +FSDKError::FeatureExpired, +FSDKError::FingerprintError, +FSDKError::ValidationFailed, + + FSDKError::NotImplemented + + } |
Common SDK error codes. More... | |
enum | DescriptorType { DT_FACE, +DT_HUMAN + } |
Descriptor type enum. Determines which type of descriptor to use. More... | |
enum | DescriptorVersion : uint32_t { DV_MIN_FACE_DESCRIPTOR_VERSION = 46, +DV_MIN_HUMAN_DESCRIPTOR_VERSION = 102 + } |
Minimum descriptor model version. Determines which minimum version of descriptor to use. More... | |
enum | HumanDescriptorVersion : uint32_t { HDV_TRACKER_HUMAN_DESCRIPTOR_VERSION = 102, +HDV_PRECISE_HUMAN_DESCRIPTOR_VERSION = 103, +HDV_REGULAR_HUMAN_DESCRIPTOR_VERSION = 104 + } |
Human descriptor model versions. Determines which version of human descriptor to use. More... | |
enum | SensorType { SensorType::Visible = 0, +SensorType::NIR + } |
Sensor type structure. Determines which type of camera sensor is used to perform face recognition. More... | |
enum | ObjectDetectorClassType { + FACE_DET_DEFAULT = 0, +FACE_DET_V1 = 4, +FACE_DET_V2 = 5, +FACE_DET_V3 = 6, + + FACE_DET_COUNT = 7 + + } |
Object detector type enumeration. More... | |
enum | DetectionComparerType { + DCT_CONFIDENCE = 0, +DCT_CENTER, +DCT_CENTER_AND_CONFIDENCE, +DCT_SIZE, + + DCT_COUNT + + } |
Strategy of BestDetections comparer. More... | |
enum | DetectionType { DT_BBOX = 0, +DT_LANDMARKS5 = 1<<0, +DT_LANDMARKS68 = 1<<1, +DT_ALL = 0xffff + } |
Detection type enumeration. More... | |
enum | HumanDetectionType { HDT_BOX = 0, +HDT_POINTS = 1<<0, +HDT_ALL = 0xffff + } |
Human detection type enumeration. More... | |
enum | LicenseFeature : uint32_t { + Detection = 1, +BestShot = 2, +Attributes = 3, +Emotions = 4, + + FaceFeatures = 5, +Liveness = 6, +Descriptor = 7, +DescriptorIndex = 8, + + LivenessEngine = 9, +TrackEngine = 10, +HumanDetection = 11, +PPEDetection = 17, + + MobileLiveness = 18, +MedicalMaskDetection = 19, +ReIdDescriptor = 20, +ISOCheck = 21 + + } |
License features. | |
enum | DeviceClass : int32_t { + CPU = 0, +GPU = 1, +CPU_ARM = 2, +CPU_AVX2, + + GPU_INT8, +CPU_ARM_INT8, +GPU_MOBILE, +NPU_ASCEND, + + Invalid = -1 + + } |
DeviceClass specifies which device/instruction set to use for cnn inference. | |
enum | FaceEngineEdition { FrontEndEdition, +CompleteEdition + } |
enum | ExecutionPolicy : uint8_t { ExecutionPolicy::Sync, +ExecutionPolicy::Async + } |
Enum to tell some method how to behave. More... | |
enum | FuturePromiseState : uint8_t { + FuturePromiseState::Empty, +FuturePromiseState::Promised, +FuturePromiseState::Fulfilled, +FuturePromiseState::CancelRequested, + + FuturePromiseState::Canceled, +FuturePromiseState::Failed, +FuturePromiseState::Broken + + } |
Enumeration of possible future or promise states. More... | |
enum | FutureError : uint8_t { + FutureError::Ok, +FutureError::InvalidInput, +FutureError::NotPromised, +FutureError::NotFulfilled, + + FutureError::NonWaitable, +FutureError::Timeout, +FutureError::Internal + + } |
Enumeration of possible Future errors. More... | |
enum | PromiseError : uint8_t { + PromiseError::Ok, +PromiseError::Internal, +PromiseError::StateNotCancelable, +PromiseError::StateNotFailable, + + PromiseError::StateNotFulfillable, +PromiseError::StateDoesntAllowFutureCreation + + } |
Enumeration of possible Promise errors. More... | |
enum | OrientationType : uint32_t { OT_NORMAL = 0, +OT_LEFT = 1, +OT_UPSIDE_DOWN = 2, +OT_RIGHT = 3 + } |
Estimation of image orientation. More... | |
+Functions | |
+IBestShotQualityEstimator::EstimationRequest | operator| (IBestShotQualityEstimator::EstimationRequest first, IBestShotQualityEstimator::EstimationRequest second) |
+DetectionType | operator| (DetectionType a, DetectionType b) |
FSDK_API Result< FSDKError > | activateLicense (ILicense *license, const char *configPath) noexcept |
Makes License activation with some platform specific manner. Network connection is required. More... | |
FSDK_API Result< FSDKError > | activateLicense (ILicense *license, ISettingsProvider *settings) noexcept |
Makes License activation with some platform specific manner. Network connection is required. More... | |
FSDK_API ResultValue +< FSDKError, +IFaceEngineMobilePtr > | createFaceEngineMobile (const char *dataPath=nullptr, const char *configPath=nullptr, const char *runtimePath=nullptr) noexcept |
Create the LUNA SDK root object. More... | |
FSDK_API ResultValue +< FSDKError, +ISettingsProviderPtr > | createSettingsProvider (const char *path) noexcept |
Create a settings provider. More... | |
+HumanDetectionType | operator| (HumanDetectionType a, HumanDetectionType b) |
Landmarks5 FSDK_API | convert (const Landmarks68 &landmarks) |
convert landmarks68 into landmarks5 More... | |
+template<typename E0 , typename E1 > | |
Result< MultiError< E0, E1 > > | makeMultiResult (E0 error0, E1 error1) |
template<typename Type > | |
BaseRect< Type > | centerScale (const BaseRect< Type > &in, float scaleFactor) noexcept |
scale rect out of center More... | |
template<typename T > | |
Ref< T > | make_ref (T *ptr) noexcept |
Make smart reference to a IRefCounted based object without acquiring ownership. More... | |
template<typename S , typename T > | |
Ref< S > | make_ref_as (T *ptr) noexcept |
Make smart reference to a IRefCounted based object without acquiring ownership. More... | |
template<typename T > | |
Ref< T > | acquire (T *ptr) noexcept |
Acquire ownership of IRefCounted based object. More... | |
template<typename S , typename T > | |
Ref< S > | acquire_as (T *ptr) noexcept |
Acquire ownership of IRefCounted based object with a cast to a given type. More... | |
+template<typename E > | |
Result< E > | makeResult (E error) noexcept |
template<typename R , typename V > | |
ResultValue< R, typename +std::remove_const< typename +std::remove_reference< V > +::type >::type > | makeResultValue (R result, V &&value) noexcept |
Addon for Result to output some value aside the result. More... | |
bool | operator< (Version lhs, Version rhs) noexcept |
Check if one version is less than another. More... | |
bool | operator== (Version lhs, Version rhs) noexcept |
Check if versions are equal. More... | |
bool | operator!= (Version lhs, Version rhs) noexcept |
Check if versions are not equal. More... | |
FSDK_API Version | getVersion () noexcept |
Get FaceEngine version. More... | |
FSDK_API const char * | getVersionHash () noexcept |
Get FaceEngine commit hash. More... | |
FSDK_API const char * | getVersionString () noexcept |
Get FaceEngine version string. More... | |
FSDK_API const char * | getBuildInfo () noexcept |
Get FaceEngine build description. The descripton contains used flags and compler settings. More... | |
SDK namespace.
+typedef Vector2<double> fsdk::Point2d | +
Double precision floating point 2-dimensional point
+ +typedef Vector2<float> fsdk::Point2f | +
Single precision floating point 2-dimensional point
+ +typedef Vector2<int> fsdk::Point2i | +
Integer 2-dimensional point
+ +typedef Vector2<unsigned int> fsdk::Point2u | +
Integer 2-dimensional point
+ +typedef Vector2<unsigned short> fsdk::Point2us | +
Integer 2-dimensional point
+ +typedef Vector2<int> fsdk::Size | +
2-dimensional size type
+ +
+
|
+ +strong | +
MedicalMask estimator output enum. This enum contains all type of DetailedMaskType results.
+Enumerator | |
---|---|
CorrectMask |
+ correct mask on the face (mouth and nose are covered correctly) + |
MouthCoveredWithMask |
+ mask covers only a mouth + |
ClearFace |
+ clear face - no mask on the face + |
ClearFaceWithMaskUnderChin |
+ clear face with a mask around of a chin, mask does not cover anything in the face region (from mouth to eyes) + |
PartlyCoveredFace |
+ face is covered with not a medical mask or a full mask + |
FullMask |
+ face is covered with a full mask (such as balaclava, sky mask, etc.) + |
+
|
+ +strong | +
+
|
+ +strong | +
Common SDK error codes.
+Enumerator | |
---|---|
Ok |
+ Ok. + |
Internal |
+ Internal error. + |
InvalidInput |
+ Invalid input. + |
InvalidImage |
+ Invalid image. + |
InvalidRect |
+ Invalid rectangle. + |
InvalidImageFormat |
+ Invalid image format. + |
InvalidImageSize |
+ Invalid image size. + |
InvalidDetection |
+ Invalid detection. + |
InvalidLandmarks5 |
+ Invalid landmarks 5. + |
InvalidLandmarks68 |
+ Invalid landmarks 68. + |
InvalidTransformation |
+ Invalid transformation. + |
InvalidDescriptor |
+ Invalid descriptor. + |
InvalidDescriptorBatch |
+ Invalid descriptor batch. + |
InvalidSettingsProvider |
+ Invalid settings provider. + |
InvalidDescriptorId |
+ Invalid descriptor id. + |
InvalidPath |
+ Invalid path to object. + |
InvalidSerializedObject |
+ Invalid serialized object. + |
ModuleNotInitialized |
+ Module is not initialized. + |
ModuleNotReady |
+ Module is not ready. + |
LicenseError |
+ Licensing issue (expired license or unavailable feature). + |
BufferIsNull |
+ Buffer is null. + |
BufferIsFull |
+ Buffer is full. + |
BufferIsEmpty |
+ Buffer is empty. + |
InvalidBufferSize |
+ Invalid buffer size. + |
InvalidSpanSize |
+ Invalid span size. + |
InvalidBatch |
+ Invalid batch. + |
IncompatibleDescriptors |
+ Matching attempt with incompatible descriptors. + |
EnableJustInBetaMode |
+ Attempt to create feature while betaMode is turned off. + |
FiltredAggregationError |
+ Cant aggregate descriptors - all images'a GSs are less the threashold. + |
BatchedInternalError |
+ Something gone wrong in batched query. See batch with error codes to each input image for details. + |
IncompatibleModelVersions |
+ Incompatible model versions. + |
ModelNotLoaded |
+ Model not loaded. + |
InvalidConfig |
+ Invalid config. + |
LicenseIsNotActivated |
+ License is not activated. + |
FeatureNotAvailable |
+ Requested Feature not available. + |
FeatureExpired |
+ Feature expired. + |
FingerprintError |
+ Failed to get device fingerprint. + |
ValidationFailed |
+ Failed validation. + |
NotImplemented |
+ Not implemented error. + |
+
|
+ +strong | +
Enumeration of possible Future errors.
+Enumerator | |
---|---|
Ok |
+ All good. + |
InvalidInput |
+ Invalid data is given as input to some method. + |
NotPromised |
+ Error if you call. +
|
NotFulfilled |
+ Error if you call. +
|
NonWaitable |
+ Error if you try to. +
|
Timeout |
+ Error if your. +
|
Internal |
+ Some internal error. + |
+
|
+ +strong | +
Enumeration of possible future or promise states.
+Enumerator | |
---|---|
Empty |
+ Lack of internal state: on promise creation and emptying Future. +
|
Promised |
+ State right after future is created from promise. + |
Fulfilled |
+ State possible after Promised if promise' method. +
|
CancelRequested |
+ State possible if. +
|
Canceled |
+ State possible if during CancelRequested. +
|
Failed |
+ State possible if during Promised. +
|
Broken |
+ State indicating some internal error. + |
+
|
+ +strong | +
Glasses estimation enum.
+noglasses:
checks whether person is wearing glasses or not. true - no glasses, false - with glasses; eyeglasses:
checks whether person is wearing eyeglasses or not. true - eyeglasses, false - not eyeglasses; sunglasses:
checks whether person is wearing sunglasses or not. true - sunglasses, false - not sunglasses. Enumerator | |
---|---|
NoGlasses |
+ Person is not wearing glasses. + |
EyeGlasses |
+ Person is wearing eyeglasses. + |
SunGlasses |
+ Person is wearing sunglasses. + |
EstimationError |
+ failed to estimate + |
+
|
+ +strong | +
+
|
+ +strong | +
enum fsdk::OrientationType : uint32_t | +
+
|
+ +strong | +
Enumeration of possible Promise errors.
+Enumerator | |
---|---|
Ok |
+ All good. + |
Internal |
+ Internal error. + |
StateNotCancelable |
+ Error if you call. +
|
StateNotFailable |
+ Error if you call. +
|
StateNotFulfillable |
+ Error if you call. +
|
StateDoesntAllowFutureCreation |
+ Error if you call. +
|
+
|
+ +strong | +
+
|
+ +inlinenoexcept | +
Acquire ownership of IRefCounted based object.
+T | object interface (must be derived from IRefCounted). |
[in] | ptr | raw pointer. |
+
|
+ +inlinenoexcept | +
Acquire ownership of IRefCounted based object with a cast to a given type.
+S | target interface (must be relative to T). |
T | source interface (must be derived from IRefCounted). |
[in] | ptr | raw pointer. |
+
|
+ +noexcept | +
scale rect out of center
+[in] | input | rect |
[in] | scaleFactor | to scale rect |
Landmarks5 FSDK_API fsdk::convert | +( | +const Landmarks68 & | +landmarks | ) | ++ |
convert landmarks68 into landmarks5
+landmarks | landmarks68 |
+
|
+ +inlinenoexcept | +
Make smart reference to a IRefCounted based object without acquiring ownership.
+T | object interface (must be derived from IRefCounted). |
[in] | ptr | raw pointer. |
+
|
+ +inlinenoexcept | +
Make smart reference to a IRefCounted based object without acquiring ownership.
+S | target interface (must be relative to T). |
T | object interface (must be derived from IRefCounted). |
[in] | ptr | raw pointer. |
+
|
+ +inlinenoexcept | +
Addon for Result to output some value aside the result.
+R | result enumeration type. |
V | result value type. |
result | the result. |
value | the value. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
![]() ![]() | SDK namespace |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::BaseRect< Type >, including all inherited members.
+adjust(Type dx, Type dy, Type dw, Type dh) noexcept | fsdk::BaseRect< Type > | inline |
adjusted(Type dx, Type dy, Type dw, Type dh) const noexcept | fsdk::BaseRect< Type > | inline |
BaseRect() noexcept | fsdk::BaseRect< Type > | inline |
BaseRect(Type x_, Type y_, Type w_, Type h_) noexcept | fsdk::BaseRect< Type > | inline |
BaseRect(const Vector2< Type > &topLeft, const Vector2< Type > &bottomRight) noexcept | fsdk::BaseRect< Type > | inline |
BaseRect(const BaseRect &other) noexcept | fsdk::BaseRect< Type > | inline |
BaseRect(const BaseRect< OtherType > &other) noexcept (defined in fsdk::BaseRect< Type >) | fsdk::BaseRect< Type > | inline |
bottom() const noexcept | fsdk::BaseRect< Type > | inline |
bottomRight() const noexcept | fsdk::BaseRect< Type > | inline |
center() const noexcept | fsdk::BaseRect< Type > | inline |
coords(Type x0, Type y0, Type x1, Type y1) noexcept | fsdk::BaseRect< Type > | inlinestatic |
ElementType typedef (defined in fsdk::BaseRect< Type >) | fsdk::BaseRect< Type > | |
getArea() const noexcept | fsdk::BaseRect< Type > | inline |
height | fsdk::BaseRect< Type > | |
inside(const BaseRect &other) const noexcept | fsdk::BaseRect< Type > | inline |
intersectionOverFirstRect(const BaseRect &rect1, const BaseRect &rect2) | fsdk::BaseRect< Type > | inlinestatic |
intersectionOverUnion(const BaseRect &rect1, const BaseRect &rect2) | fsdk::BaseRect< Type > | inlinestatic |
isValid() const noexcept | fsdk::BaseRect< Type > | inline |
left() const noexcept | fsdk::BaseRect< Type > | inline |
operator!=(const BaseRect< OtherType > &other) const noexcept | fsdk::BaseRect< Type > | inline |
operator&(const BaseRect &other) const noexcept | fsdk::BaseRect< Type > | inline |
operator&=(const BaseRect &other) noexcept | fsdk::BaseRect< Type > | inline |
operator*(float scaleFactor) const noexcept | fsdk::BaseRect< Type > | inline |
operator+(Vector2< typename BaseRect::ElementType > vec) (defined in fsdk::BaseRect< Type >) | fsdk::BaseRect< Type > | inline |
operator-(Vector2< typename BaseRect::ElementType > vec) (defined in fsdk::BaseRect< Type >) | fsdk::BaseRect< Type > | inline |
operator/(float scaleFactor) const noexcept | fsdk::BaseRect< Type > | inline |
operator=(const BaseRect< OtherType > &other) noexcept | fsdk::BaseRect< Type > | inline |
operator==(const BaseRect< OtherType > &other) const noexcept | fsdk::BaseRect< Type > | inline |
operator|(const BaseRect &other) const noexcept | fsdk::BaseRect< Type > | inline |
operator|=(const BaseRect &other) noexcept | fsdk::BaseRect< Type > | inline |
right() const noexcept | fsdk::BaseRect< Type > | inline |
set(const Vector2< Type > &topLeft, const Vector2< Type > &bottomRight) noexcept | fsdk::BaseRect< Type > | inline |
setBottom(Type b) noexcept | fsdk::BaseRect< Type > | inline |
setLeft(Type l) noexcept | fsdk::BaseRect< Type > | inline |
setRight(Type r) noexcept | fsdk::BaseRect< Type > | inline |
setTop(Type t) noexcept | fsdk::BaseRect< Type > | inline |
size() const noexcept | fsdk::BaseRect< Type > | inline |
top() const noexcept | fsdk::BaseRect< Type > | inline |
topLeft() const noexcept | fsdk::BaseRect< Type > | inline |
width | fsdk::BaseRect< Type > | |
x | fsdk::BaseRect< Type > | |
y | fsdk::BaseRect< Type > |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Rectangle. + More...
+ +#include <Rect.h>
+Public Types | |
+typedef Type | ElementType |
+Public Member Functions | |
+ | BaseRect () noexcept |
Initializes a default invalid rectangle. | |
BaseRect (Type x_, Type y_, Type w_, Type h_) noexcept | |
Initializes a rectangle with given values. More... | |
BaseRect (const Vector2< Type > &topLeft, const Vector2< Type > &bottomRight) noexcept | |
Initializes a rectangle with given values. More... | |
BaseRect (const BaseRect &other) noexcept | |
Copies another rect. More... | |
+template<typename OtherType > | |
BaseRect (const BaseRect< OtherType > &other) noexcept | |
void | setLeft (Type l) noexcept |
Set rect left. More... | |
void | setTop (Type t) noexcept |
Set rect top. More... | |
void | setRight (Type r) noexcept |
Set rect right. More... | |
void | setBottom (Type b) noexcept |
Set rect bottom. More... | |
template<typename OtherType > | |
BaseRect & | operator= (const BaseRect< OtherType > &other) noexcept |
Copies another rect. More... | |
template<typename OtherType > | |
bool | operator== (const BaseRect< OtherType > &other) const noexcept |
Checks whether two rects are equal. More... | |
template<typename OtherType > | |
bool | operator!= (const BaseRect< OtherType > &other) const noexcept |
Checks whether two rects are not equal. More... | |
BaseRect | operator& (const BaseRect &other) const noexcept |
Returns rect that is intersection of rects. More... | |
BaseRect | operator&= (const BaseRect &other) noexcept |
Returns rect that is intersection of rects. More... | |
BaseRect | operator| (const BaseRect &other) const noexcept |
Returns minimum area rectangle containing both rects. More... | |
BaseRect | operator|= (const BaseRect &other) noexcept |
Returns minimum area rectangle containing both rects. More... | |
BaseRect | operator* (float scaleFactor) const noexcept |
Multiplicates Rect scale by specified scale factor. More... | |
BaseRect | operator/ (float scaleFactor) const noexcept |
Divides Rect scale by specified scale factor. More... | |
+BaseRect | operator+ (Vector2< typename BaseRect::ElementType > vec) |
+BaseRect | operator- (Vector2< typename BaseRect::ElementType > vec) |
Vector2< Type > | size () const noexcept |
Gets rect size (width, height). More... | |
Vector2< Type > | topLeft () const noexcept |
Gets rect top-left corner coordinates. More... | |
Vector2< Type > | center () const noexcept |
Gets rect center coordinates. More... | |
Vector2< Type > | bottomRight () const noexcept |
Gets rect bottom-right corner coordinates. More... | |
Type | top () const noexcept |
Gets rect top y coordinate. More... | |
Type | bottom () const noexcept |
Gets rect bottom y coordinate. More... | |
Type | left () const noexcept |
Gets rect left x coordinate. More... | |
Type | right () const noexcept |
Gets rect right x coordinate. More... | |
void | set (const Vector2< Type > &topLeft, const Vector2< Type > &bottomRight) noexcept |
Sets rect corner coordinates. More... | |
void | adjust (Type dx, Type dy, Type dw, Type dh) noexcept |
Adjusts the rect by given amounts. More... | |
BaseRect | adjusted (Type dx, Type dy, Type dw, Type dh) const noexcept |
Copies and adjusts the rect by given amounts. More... | |
Type | getArea () const noexcept |
Computes rect area (width x height). More... | |
bool | inside (const BaseRect &other) const noexcept |
Checks whether this rect is inside of another rect. More... | |
bool | isValid () const noexcept |
Checks whether a rect is valid. More... | |
+Static Public Member Functions | |
static BaseRect | coords (Type x0, Type y0, Type x1, Type y1) noexcept |
Create new Rect by coordinates. More... | |
static float | intersectionOverFirstRect (const BaseRect &rect1, const BaseRect &rect2) |
Calculates rects intersection rate over first rect. More... | |
static float | intersectionOverUnion (const BaseRect &rect1, const BaseRect &rect2) |
Calculates rects intersection rate over union. More... | |
+Public Attributes | |
+Type | x |
Upper left corner x-coordinate. | |
+Type | y |
Upper left corner y-coordinate. | |
+Type | width |
Rectangle width. | |
+Type | height |
Rectangle height. | |
Rectangle.
+
+
|
+ +inlinenoexcept | +
Initializes a rectangle with given values.
+[in] | x_ | upper left corner x coordinate. |
[in] | y_ | upper left corner y coordinate. |
[in] | w_ | width. |
[in] | h_ | height. |
+
|
+ +inlinenoexcept | +
Initializes a rectangle with given values.
+[in] | topLeft | top-left corner point. |
[in] | bottomRight | bottom-right corner point. |
+
|
+ +inlinenoexcept | +
Copies another rect.
+[in] | other | another rect. |
+
|
+ +inlinenoexcept | +
Adjusts the rect by given amounts.
+[in] | dx | adjustment for upper left corner x coordinate. |
[in] | dy | adjustment for upper left corner y coordinate. |
[in] | dw | adjustment for width. |
[in] | dh | adjustment for height. |
+
|
+ +inlinenoexcept | +
Copies and adjusts the rect by given amounts.
+[in] | dx | adjustment for upper left corner x coordinate. |
[in] | dy | adjustment for upper left corner y coordinate. |
[in] | dw | adjustment for width. |
[in] | dh | adjustment for height. |
+
|
+ +inlinenoexcept | +
Gets rect bottom y coordinate.
+
+
|
+ +inlinenoexcept | +
Gets rect bottom-right corner coordinates.
+
+
|
+ +inlinenoexcept | +
Gets rect center coordinates.
+
+
|
+ +inlinestaticnoexcept | +
Create new Rect by coordinates.
+[in] | left | coord. |
[in] | top | coord. |
[in] | right | coord. |
[in] | bottom | coord. |
+
|
+ +inlinenoexcept | +
Computes rect area (width x height).
+
+
|
+ +inlinenoexcept | +
Checks whether this rect is inside of another rect.
+[in] | other | rect to check against. |
+
|
+ +inlinestatic | +
Calculates rects intersection rate over first rect.
+[in] | rect1 | first rect |
[in] | rect2 | second rect |
+
|
+ +inlinestatic | +
Calculates rects intersection rate over union.
+[in] | rect1 | first rect |
[in] | rect2 | second rect |
+
|
+ +inlinenoexcept | +
Checks whether a rect is valid.
+A rect is considered valid if it has positive width and weight.
+
+
|
+ +inlinenoexcept | +
Gets rect left x coordinate.
+
+
|
+ +inlinenoexcept | +
Checks whether two rects are not equal.
+[in] | other | another rect. |
+
|
+ +inlinenoexcept | +
Returns rect that is intersection of rects.
+[in] | other | rectangle |
+
|
+ +inlinenoexcept | +
Returns rect that is intersection of rects.
+[in] | other | rectangle |
+
|
+ +inlinenoexcept | +
Multiplicates Rect scale by specified scale factor.
+[in] | scaleFactor | to scale rect |
+
|
+ +inlinenoexcept | +
Divides Rect scale by specified scale factor.
+[in] | scaleFactor | to scale rect |
+
|
+ +inlinenoexcept | +
Copies another rect.
+[in] | other | another rect. |
+
|
+ +inlinenoexcept | +
Checks whether two rects are equal.
+[in] | other | another rect. |
+
|
+ +inlinenoexcept | +
Returns minimum area rectangle containing both rects.
+[in] | other | rectangle |
+
|
+ +inlinenoexcept | +
Returns minimum area rectangle containing both rects.
+[in] | other | rectangle |
+
|
+ +inlinenoexcept | +
Gets rect right x coordinate.
+
+
|
+ +inlinenoexcept | +
Sets rect corner coordinates.
+[in] | topLeft | top-left corner point. |
[in] | bottomRight | bottom-right corner point. |
+
|
+ +inlinenoexcept | +
Set rect bottom.
+b | bottom. |
+
|
+ +inlinenoexcept | +
Set rect left.
+l | left. |
+
|
+ +inlinenoexcept | +
Set rect right.
+r | right. |
+
|
+ +inlinenoexcept | +
Set rect top.
+t | top. |
+
|
+ +inlinenoexcept | +
Gets rect size (width, height).
+
+
|
+ +inlinenoexcept | +
Gets rect top y coordinate.
+
+
|
+ +inlinenoexcept | +
Gets rect top-left corner coordinates.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Detection, including all inherited members.
+Detection() noexcept | fsdk::Detection | inline |
Detection(FloatRect rect, float score=1.f) noexcept | fsdk::Detection | inline |
Detection(FloatRect rect, int width, int height, float score=1.f) noexcept | fsdk::Detection | inline |
Detection(FloatRect rect, Rect imageRect, float score=1.f) noexcept | fsdk::Detection | inline |
Detection(const Detection &rhs) noexcept (defined in fsdk::Detection) | fsdk::Detection | inline |
getRawRect() const noexcept | fsdk::Detection | inline |
getRect() const noexcept | fsdk::Detection | inline |
getScore() const noexcept (defined in fsdk::Detection) | fsdk::Detection | inline |
isValid() const noexcept | fsdk::Detection | inline |
operator=(const Detection &rhs) noexcept (defined in fsdk::Detection) | fsdk::Detection | inline |
setRawRect(fsdk::FloatRect rect) noexcept | fsdk::Detection | inline |
setScore(float score) noexcept | fsdk::Detection | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Detection structure. Stores a detected bounding box within a source image rect. + More...
+ +#include <Detection.h>
+Public Member Functions | |
+ | Detection () noexcept |
Default constructor. Creates an invalid Detection with zeroed rect and score. | |
Detection (FloatRect rect, float score=1.f) noexcept | |
Special constructor based on raw rect and score only. More... | |
Detection (FloatRect rect, int width, int height, float score=1.f) noexcept | |
Constructor base on the raw rect, bounding width and height. More... | |
Detection (FloatRect rect, Rect imageRect, float score=1.f) noexcept | |
Constructor base on the raw rect, bounding width and height. More... | |
+ | Detection (const Detection &rhs) noexcept |
+Detection & | operator= (const Detection &rhs) noexcept |
Rect | getRect () const noexcept |
Returns a detection rect. More... | |
FloatRect | getRawRect () const noexcept |
Returns a raw detection bounding box. More... | |
void | setRawRect (fsdk::FloatRect rect) noexcept |
Sets a detection rect. More... | |
+float | getScore () const noexcept |
void | setScore (float score) noexcept |
Sets a detection score. More... | |
bool | isValid () const noexcept |
Checks whether a detection is valid. More... | |
Detection structure. Stores a detected bounding box within a source image rect.
+
+
|
+ +inlinenoexcept | +
Special constructor based on raw rect and score only.
+[in] | rect | raw detection rect. |
[in] | score | detection score. |
+
|
+ +inlinenoexcept | +
Constructor base on the raw rect, bounding width and height.
+[in] | rect | raw detection rect. |
[in] | width | bounding source image rect width. |
[in] | height | bounding source image rect height. |
[in] | score | detection score. |
+
|
+ +inlinenoexcept | +
Constructor base on the raw rect, bounding width and height.
+[in] | rect | raw detection rect. |
[in] | rect | bounding source image rect. |
+
|
+ +inlinenoexcept | +
Returns a raw detection bounding box.
+
+
|
+ +inlinenoexcept | +
Returns a detection rect.
+
+
|
+ +inlinenoexcept | +
Checks whether a detection is valid.
+A detection is considered valid if it has a valid rect and score in [0..1] range.
+
+
|
+ +inlinenoexcept | +
Sets a detection rect.
+
+
|
+ +inlinenoexcept | +
Sets a detection score.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< E >, including all inherited members.
+isOk(E) noexcept (defined in fsdk::ErrorTraits< E >) | fsdk::ErrorTraits< E > | inlinestatic |
toString(E) noexcept (defined in fsdk::ErrorTraits< E >) | fsdk::ErrorTraits< E > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Static Public Member Functions | |
+static bool | isOk (E) noexcept |
+static const char * | toString (E) noexcept |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< FSDKError >, including all inherited members.
+isOk(FSDKError error) noexcept (defined in fsdk::ErrorTraits< FSDKError >) | fsdk::ErrorTraits< FSDKError > | inlinestatic |
toString(FSDKError error) noexcept (defined in fsdk::ErrorTraits< FSDKError >) | fsdk::ErrorTraits< FSDKError > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Specialized for FSDKError. + More...
+ +#include <FSDKError.h>
+Static Public Member Functions | |
+static bool | isOk (FSDKError error) noexcept |
+static const char * | toString (FSDKError error) noexcept |
Specialized for FSDKError.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< FutureError >, including all inherited members.
+isOk(const FutureError error) noexcept (defined in fsdk::ErrorTraits< FutureError >) | fsdk::ErrorTraits< FutureError > | inlinestatic |
toString(const FutureError error) noexcept (defined in fsdk::ErrorTraits< FutureError >) | fsdk::ErrorTraits< FutureError > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Specialized for Future::Error. + More...
+ +#include <Future.h>
+Static Public Member Functions | |
+static bool | isOk (const FutureError error) noexcept |
+static const char * | toString (const FutureError error) noexcept |
Specialized for Future::Error.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< IDescriptorBatch::Error >, including all inherited members.
+isOk(IDescriptorBatch::Error error) noexcept (defined in fsdk::ErrorTraits< IDescriptorBatch::Error >) | fsdk::ErrorTraits< IDescriptorBatch::Error > | inlinestatic |
toString(IDescriptorBatch::Error error) noexcept (defined in fsdk::ErrorTraits< IDescriptorBatch::Error >) | fsdk::ErrorTraits< IDescriptorBatch::Error > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Specialized for DescriptorBatchError. + More...
+ +#include <IDescriptor.h>
+Static Public Member Functions | |
+static bool | isOk (IDescriptorBatch::Error error) noexcept |
+static const char * | toString (IDescriptorBatch::Error error) noexcept |
Specialized for DescriptorBatchError.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< ISerializableObject::Error >, including all inherited members.
+isOk(ISerializableObject::Error error) noexcept (defined in fsdk::ErrorTraits< ISerializableObject::Error >) | fsdk::ErrorTraits< ISerializableObject::Error > | inlinestatic |
toString(ISerializableObject::Error error) noexcept (defined in fsdk::ErrorTraits< ISerializableObject::Error >) | fsdk::ErrorTraits< ISerializableObject::Error > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Specialized for ISerializableObject::SerializationError. + More...
+ +#include <IObject.h>
+Static Public Member Functions | |
+static bool | isOk (ISerializableObject::Error error) noexcept |
+static const char * | toString (ISerializableObject::Error error) noexcept |
Specialized for ISerializableObject::SerializationError.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< ISettingsProvider::Error >, including all inherited members.
+isOk(ISettingsProvider::Error error) noexcept (defined in fsdk::ErrorTraits< ISettingsProvider::Error >) | fsdk::ErrorTraits< ISettingsProvider::Error > | inlinestatic |
toString(ISettingsProvider::Error error) noexcept (defined in fsdk::ErrorTraits< ISettingsProvider::Error >) | fsdk::ErrorTraits< ISettingsProvider::Error > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Specialized for ISettingsProvider::ParseError. + More...
+ +#include <ISettingsProvider.h>
+Static Public Member Functions | |
+static bool | isOk (ISettingsProvider::Error error) noexcept |
+static const char * | toString (ISettingsProvider::Error error) noexcept |
Specialized for ISettingsProvider::ParseError.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< Image::Error >, including all inherited members.
+isOk(Image::Error error) noexcept (defined in fsdk::ErrorTraits< Image::Error >) | fsdk::ErrorTraits< Image::Error > | inlinestatic |
toString(Image::Error error) noexcept (defined in fsdk::ErrorTraits< Image::Error >) | fsdk::ErrorTraits< Image::Error > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Specialized for Image::Error. + More...
+ +#include <Image.h>
+Static Public Member Functions | |
+static bool | isOk (Image::Error error) noexcept |
+static const char * | toString (Image::Error error) noexcept |
Specialized for Image::Error.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< MultiError< E0, E1 > >, including all inherited members.
+E0Traits typedef (defined in fsdk::ErrorTraits< MultiError< E0, E1 > >) | fsdk::ErrorTraits< MultiError< E0, E1 > > | |
E1Traits typedef (defined in fsdk::ErrorTraits< MultiError< E0, E1 > >) | fsdk::ErrorTraits< MultiError< E0, E1 > > | |
ErrorType typedef (defined in fsdk::ErrorTraits< MultiError< E0, E1 > >) | fsdk::ErrorTraits< MultiError< E0, E1 > > | |
isOk(ErrorType e) (defined in fsdk::ErrorTraits< MultiError< E0, E1 > >) | fsdk::ErrorTraits< MultiError< E0, E1 > > | inlinestatic |
toString(ErrorType e) (defined in fsdk::ErrorTraits< MultiError< E0, E1 > >) | fsdk::ErrorTraits< MultiError< E0, E1 > > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Specialized for MultiError. + More...
+ +#include <MultiError.h>
+Public Types | |
+using | ErrorType = MultiError< E0, E1 > |
+using | E0Traits = ErrorTraits< typename ErrorType::E0Type > |
+using | E1Traits = ErrorTraits< typename ErrorType::E1Type > |
+Static Public Member Functions | |
+static bool | isOk (ErrorType e) |
+static const char * | toString (ErrorType e) |
Specialized for MultiError.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ErrorTraits< PromiseError >, including all inherited members.
+isOk(const PromiseError error) noexcept (defined in fsdk::ErrorTraits< PromiseError >) | fsdk::ErrorTraits< PromiseError > | inlinestatic |
toString(const PromiseError error) noexcept (defined in fsdk::ErrorTraits< PromiseError >) | fsdk::ErrorTraits< PromiseError > | inlinestatic |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Specialized for Promise::Error. + More...
+ +#include <Future.h>
+Static Public Member Functions | |
+static bool | isOk (const PromiseError error) noexcept |
+static const char * | toString (const PromiseError error) noexcept |
Specialized for Promise::Error.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Exception, including all inherited members.
+Exception(fsdk::FSDKError err) noexcept (defined in fsdk::Exception) | fsdk::Exception | explicit |
getError() const noexcept (defined in fsdk::Exception) | fsdk::Exception | |
what() const noexcept (defined in fsdk::Exception) | fsdk::Exception |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Member Functions | |
+ | Exception (fsdk::FSDKError err) noexcept |
+const char * | what () const noexcept |
+fsdk::FSDKError | getError () const noexcept |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::EyeCropper, including all inherited members.
+cropByLandmarks5(const Image &warp, const Landmarks5 &landmarks5) (defined in fsdk::EyeCropper) | fsdk::EyeCropper | |
cropByLandmarks68(const Image &warp, const Landmarks68 &landmarks68) (defined in fsdk::EyeCropper) | fsdk::EyeCropper |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
EyeCropper is a helper structure for IEyeEstimator interface Methods of this structure crop an input warped image and returns rectangle coordinates of each eye. + More...
+ +#include <IEyeEstimator.h>
+Classes | |
struct | EyesRects |
+Public Member Functions | |
+EyesRects | cropByLandmarks5 (const Image &warp, const Landmarks5 &landmarks5) |
+EyeCropper::EyesRects | cropByLandmarks68 (const Image &warp, const Landmarks68 &landmarks68) |
EyeCropper is a helper structure for IEyeEstimator interface Methods of this structure crop an input warped image and returns rectangle coordinates of each eye.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::EyeCropper::EyesRects, including all inherited members.
+leftEyeRect (defined in fsdk::EyeCropper::EyesRects) | fsdk::EyeCropper::EyesRects | |
rightEyeRect (defined in fsdk::EyeCropper::EyesRects) | fsdk::EyeCropper::EyesRects |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+Rect | leftEyeRect |
+Rect | rightEyeRect |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::EyesEstimation, including all inherited members.
+leftEye | fsdk::EyesEstimation | |
rightEye | fsdk::EyesEstimation |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Eyes estimation output. + More...
+ +#include <IEyeEstimator.h>
+Classes | |
struct | EyeAttributes |
Eyes attribute structure. More... | |
+Public Attributes | |
+EyeAttributes | leftEye |
Left eye attributes. | |
+EyeAttributes | rightEye |
Right eye attributes. | |
Eyes estimation output.
+These values are produced by IEyeEstimator object.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::EyesEstimation::EyeAttributes, including all inherited members.
+eyelid | fsdk::EyesEstimation::EyeAttributes | |
EyelidLandmarks typedef | fsdk::EyesEstimation::EyeAttributes | |
eyelidLandmarksCount | fsdk::EyesEstimation::EyeAttributes | static |
iris | fsdk::EyesEstimation::EyeAttributes | |
IrisLandmarks typedef | fsdk::EyesEstimation::EyeAttributes | |
irisLandmarksCount | fsdk::EyesEstimation::EyeAttributes | static |
state | fsdk::EyesEstimation::EyeAttributes | |
State enum name | fsdk::EyesEstimation::EyeAttributes |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Eyes attribute structure. + More...
+ +#include <IEyeEstimator.h>
+Public Types | |
enum | State : uint8_t { State::Closed, +State::Open, +State::Occluded + } |
Enumeration of possible eye states. More... | |
using | IrisLandmarks = Landmarks< irisLandmarksCount > |
alias for More... | |
using | EyelidLandmarks = Landmarks< eyelidLandmarksCount > |
alias for More... | |
+Public Attributes | |
+State | state |
State of an eye. | |
+IrisLandmarks | iris |
Iris landmarks. | |
+EyelidLandmarks | eyelid |
Eyelid landmarks. | |
+Static Public Attributes | |
+static constexpr uint64_t | irisLandmarksCount = 32 |
Iris landmarks amount. | |
+static constexpr uint64_t | eyelidLandmarksCount = 6 |
Eyelid landmarks amount. | |
Eyes attribute structure.
+using fsdk::EyesEstimation::EyeAttributes::EyelidLandmarks = Landmarks<eyelidLandmarksCount> | +
alias for
+using fsdk::EyesEstimation::EyeAttributes::IrisLandmarks = Landmarks<irisLandmarksCount> | +
alias for
+
+
|
+ +strong | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Face, including all inherited members.
+detection (defined in fsdk::Face) | fsdk::Face | |
ElementType typedef (defined in fsdk::Face) | fsdk::Face | |
Face()=default (defined in fsdk::Face) | fsdk::Face | explicit |
Face(const fsdk::Image &image) (defined in fsdk::Face) | fsdk::Face | inlineexplicit |
Face(const fsdk::Image &image, const fsdk::Detection &detection) (defined in fsdk::Face) | fsdk::Face | inlineexplicit |
img (defined in fsdk::Face) | fsdk::Face | |
isValid() const (defined in fsdk::Face) | fsdk::Face | inline |
landmarks5 (defined in fsdk::Face) | fsdk::Face | |
landmarks68 (defined in fsdk::Face) | fsdk::Face |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Types | |
+typedef float | ElementType |
+Public Member Functions | |
+bool | isValid () const |
+ | Face (const fsdk::Image &image) |
+ | Face (const fsdk::Image &image, const fsdk::Detection &detection) |
+Public Attributes | |
+fsdk::Image | img |
+fsdk::Detection | detection |
+Optional< fsdk::Landmarks5 > | landmarks5 |
+Optional< fsdk::Landmarks68 > | landmarks68 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Format, including all inherited members.
+B8G8R8 enum value | fsdk::Format | |
B8G8R8X8 enum value | fsdk::Format | |
computePitch(int rowWidth) const noexcept | fsdk::Format | inline |
Format() noexcept | fsdk::Format | inline |
Format(Type type) noexcept | fsdk::Format | inline |
getBitDepth() const noexcept | fsdk::Format | inline |
getByteDepth() const noexcept | fsdk::Format | inline |
getChannelCount() const noexcept | fsdk::Format | inline |
getChannelSize() const noexcept | fsdk::Format | inline |
getChannelStep() const noexcept | fsdk::Format | inline |
IR_X8X8X8 enum value | fsdk::Format | |
isBGR() const noexcept | fsdk::Format | inline |
isBlock() const noexcept | fsdk::Format | inline |
isPadded() const noexcept | fsdk::Format | inline |
isValid() const noexcept | fsdk::Format | inline |
isYUV() const noexcept | fsdk::Format | inline |
m_type | fsdk::Format | protected |
operator Type() const noexcept | fsdk::Format | inline |
R16 enum value | fsdk::Format | |
R8 enum value | fsdk::Format | |
R8G8B8 enum value | fsdk::Format | |
R8G8B8X8 enum value | fsdk::Format | |
Type enum name | fsdk::Format | |
Unknown enum value | fsdk::Format | |
YUV_NV12 enum value | fsdk::Format | |
YUV_NV21 enum value | fsdk::Format |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
#include <Format.h>
+Public Types | |
enum | Type { + Unknown, +B8G8R8X8, +R8G8B8X8, +B8G8R8, + + R8G8B8, +R8, +R16, +IR_X8X8X8, + + YUV_NV21, +YUV_NV12 + + } |
Format type enumeration. More... | |
+Public Member Functions | |
int | getChannelCount () const noexcept |
Get color channel count. More... | |
int | getChannelStep () const noexcept |
Get channel step. More... | |
int | getChannelSize () const noexcept |
Get color channel size in bits. More... | |
int | getBitDepth () const noexcept |
Get number of bits per pixel. More... | |
int | getByteDepth () const noexcept |
Get number of bytes per pixel. More... | |
int | computePitch (int rowWidth) const noexcept |
Compute row size in bytes. More... | |
bool | isPadded () const noexcept |
bool | isBGR () const noexcept |
bool | isYUV () const noexcept |
bool | isBlock () const noexcept |
bool | isValid () const noexcept |
Format () noexcept | |
Initializes format structure. More... | |
Format (Type type) noexcept | |
Initializes format structure. More... | |
+ | operator Type () const noexcept |
Implicit cast to Type. | |
+Protected Attributes | |
+Type | m_type |
Format type. | |
Image format.
+enum fsdk::Format::Type | +
Format type enumeration.
+Enumerator | |
---|---|
Unknown |
+ unknown format. + |
B8G8R8X8 |
+ 3 channel, 8 bit per channel, B-G-R color order format with 8 bit padding before next pixel; + |
R8G8B8X8 |
+ 3 channel, 8 bit per channel, R-G-B color order format with 8 bit padding before next pixel; + |
B8G8R8 |
+ 3 channel, 8 bit per channel, B-G-R color order format; + |
R8G8B8 |
+ 3 channel, 8 bit per channel, R-G-B color order format; + |
R8 |
+ 1 channel, 8 bit per channel format; + |
R16 |
+ 1 channel, 16 bit per channel format; + |
IR_X8X8X8 |
+ 3 channel, 8 bit per channel format with InfraRed semantics; + |
YUV_NV21 |
+ 4:2:0 planar format with a plane of 8-bit Y samples followed by interleaved 2x2 subsampled V/U 8-bit chroma samples(YYYYYYYYVUVU); + |
YUV_NV12 |
+ 4:2:0 planar format with a plane of 8-bit Y samples followed by interleaved 2x2 subsampled U/V 8-bit chroma samples(YYYYYYYYUVUV). + |
+
|
+ +inlinenoexcept | +
Initializes format structure.
+Sets format type to Unknown.
+ +
+
|
+ +inlinenoexcept | +
Initializes format structure.
+[in] | type | type value to set. |
+
|
+ +inlinenoexcept | +
Compute row size in bytes.
+[in] | rowWidth | row width in pixels. |
+
|
+ +inlinenoexcept | +
Get number of bits per pixel.
+
+
|
+ +inlinenoexcept | +
Get number of bytes per pixel.
+
+
|
+ +inlinenoexcept | +
Get color channel count.
+
+
|
+ +inlinenoexcept | +
Get color channel size in bits.
+
+
|
+ +inlinenoexcept | +
Get channel step.
+
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::HeadPoseEstimation, including all inherited members.
+FrontalFaceType enum name | fsdk::HeadPoseEstimation | |
getFrontalFaceType() const | fsdk::HeadPoseEstimation | inline |
Good enum value | fsdk::HeadPoseEstimation | |
ISO enum value | fsdk::HeadPoseEstimation | |
Non enum value | fsdk::HeadPoseEstimation | |
pitch | fsdk::HeadPoseEstimation | |
roll | fsdk::HeadPoseEstimation | |
yaw | fsdk::HeadPoseEstimation |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Head pose estimation output. + More...
+ +#include <IHeadPoseEstimator.h>
+Public Types | |
enum | FrontalFaceType { Non = 0, +Good, +ISO + } |
+Public Member Functions | |
+FrontalFaceType | getFrontalFaceType () const |
Returns type of face frontality. | |
+Public Attributes | |
+float | pitch |
Pitch angle estimation. | |
+float | yaw |
Yaw angle estimation. | |
+float | roll |
Roll angle estimation. | |
Head pose estimation output.
+These values are produced by IHeadPoseEstimator object. Each angle is measured in degrees and in [-180, 180] range.
+enum fsdk::HeadPoseEstimation::FrontalFaceType | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Human, including all inherited members.
+detection (defined in fsdk::Human) | fsdk::Human | |
ElementType typedef (defined in fsdk::Human) | fsdk::Human | |
Human()=default (defined in fsdk::Human) | fsdk::Human | explicit |
img (defined in fsdk::Human) | fsdk::Human | |
isValid() const (defined in fsdk::Human) | fsdk::Human | inline |
landmarks17 (defined in fsdk::Human) | fsdk::Human |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Types | |
+typedef float | ElementType |
+Public Member Functions | |
+bool | isValid () const |
+Public Attributes | |
+fsdk::Image | img |
+fsdk::Detection | detection |
+Optional< fsdk::HumanLandmarks17 > | landmarks17 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::HumanLandmark, including all inherited members.
+HumanLandmark()=default (defined in fsdk::HumanLandmark) | fsdk::HumanLandmark | |
HumanLandmark(float s, const fsdk::Point2f &p) (defined in fsdk::HumanLandmark) | fsdk::HumanLandmark | inlineexplicit |
point | fsdk::HumanLandmark | |
score | fsdk::HumanLandmark | |
visible | fsdk::HumanLandmark |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Human keypoints landmark structure. + More...
+ +#include <HumanLandmarks.h>
+Public Member Functions | |
+ | HumanLandmark (float s, const fsdk::Point2f &p) |
+Public Attributes | |
+float | score { 0.0f } |
Point score. Do not use it untill you really need it. | |
fsdk::Point2f | point { 0.0f, 0.0f } |
+bool | visible = false |
true if the current point is visible and point member contains valid coordinates. | |
Human keypoints landmark structure.
+fsdk::Point2f fsdk::HumanLandmark::point { 0.0f, 0.0f } | +
Point coordinates.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::HumanLandmarks< numOfLandmarks >, including all inherited members.
+landmarks (defined in fsdk::HumanLandmarks< numOfLandmarks >) | fsdk::HumanLandmarks< numOfLandmarks > | |
landmarksCount (defined in fsdk::HumanLandmarks< numOfLandmarks >) | fsdk::HumanLandmarks< numOfLandmarks > | static |
operator[](int idx) const noexcept (defined in fsdk::HumanLandmarks< numOfLandmarks >) | fsdk::HumanLandmarks< numOfLandmarks > | inline |
operator[](int idx) noexcept (defined in fsdk::HumanLandmarks< numOfLandmarks >) | fsdk::HumanLandmarks< numOfLandmarks > | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Human keypoints landmarks template structure. + More...
+ +#include <HumanLandmarks.h>
+Public Member Functions | |
+const HumanLandmark & | operator[] (int idx) const noexcept |
+HumanLandmark & | operator[] (int idx) noexcept |
+Public Attributes | |
+HumanLandmark | landmarks [landmarksCount] |
+Static Public Attributes | |
+static constexpr size_t | landmarksCount = numOfLandmarks |
Human keypoints landmarks template structure.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IAGSEstimator, including all inherited members.
+estimate(const Image &image, const Detection &detection) const noexcept=0 | fsdk::IAGSEstimator | pure virtual |
estimate(Span< const Image > images, Span< const Detection > detections, Span< float > out) const noexcept=0 | fsdk::IAGSEstimator | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IAGSEstimator | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Approximate Garbage Score estimator interface. + More...
+ +#include <IAGSEstimator.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +float > | estimate (const Image &image, const Detection &detection) const noexcept=0 |
Estimate the ags. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > images, Span< const Detection > detections, Span< float > out) const noexcept=0 |
Estimate ags of multiple frames in a single estimate function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
Approximate Garbage Score estimator interface.
+ +
+
|
+ +pure virtualnoexcept | +
Estimate the ags.
+[in] | image | source image. |
[in] | detection | detection coordinates in image space. |
+
|
+ +pure virtualnoexcept | +
Estimate ags of multiple frames in a single estimate function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[out] | out | output span of scores for each image. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IArchive, including all inherited members.
+read(void *data, size_t size)=0 | fsdk::IArchive | pure virtual |
setSizeHint(size_t hint) | fsdk::IArchive | inlinevirtual |
write(const void *data, size_t size)=0 | fsdk::IArchive | pure virtual |
~IArchive()=default (defined in fsdk::IArchive) | fsdk::IArchive | virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Archive interface. + More...
+ +#include <IObject.h>
+Public Member Functions | |
virtual bool | write (const void *data, size_t size)=0 |
Write bytes to archive. More... | |
virtual bool | read (void *data, size_t size)=0 |
Read bytes from archive. More... | |
virtual void | setSizeHint (size_t hint) |
Set size hint. More... | |
Archive interface.
+Archives abstract data storage and IO operations.
+
+
|
+ +pure virtual | +
Read bytes from archive.
+[in] | data | pointer to memory to read to. |
[in] | size | data size. |
+
|
+ +inlinevirtual | +
Set size hint.
+[in] | hint | size hint. |
+
|
+ +pure virtual | +
Write bytes to archive.
+[in] | data | pointer to memory to write. |
[in] | size | data size. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IAsyncContext, including all inherited members.
+clearTaskQueue() noexcept=0 | fsdk::IAsyncContext | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
resize(const int8_t newThreadCount) noexcept=0 | fsdk::IAsyncContext | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
stop() noexcept=0 | fsdk::IAsyncContext | pure virtual |
threads() const noexcept=0 | fsdk::IAsyncContext | pure virtual |
valid() const noexcept=0 | fsdk::IAsyncContext | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Interface for running tasks asynchronously. + More...
+ +#include <IAsyncContext.h>
+Public Member Functions | |
virtual int8_t | threads () const noexcept=0 |
Returns size of underlying thread pool. More... | |
virtual bool | valid () const noexcept=0 |
Tells validness of internal state. More... | |
virtual bool | clearTaskQueue () noexcept=0 |
Clears tasks not yet taken by any thread. More... | |
virtual bool | resize (const int8_t newThreadCount) noexcept=0 |
Resizes internal thread pool to some new size param newThreadCount New size of thread pool. Should not be less than 1. More... | |
virtual bool | stop () noexcept=0 |
Waits for all already running tasks to complete, then stops every thread. Do not use threadpool afterwards. Is called on destruction. More... | |
![]() | |
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... | |
Interface for running tasks asynchronously.
+Contains thread pool under hood.
+
+
|
+ +pure virtualnoexcept | +
Clears tasks not yet taken by any thread.
+
+
|
+ +pure virtualnoexcept | +
Resizes internal thread pool to some new size param newThreadCount New size of thread pool. Should not be less than 1.
+
+
|
+ +pure virtualnoexcept | +
Waits for all already running tasks to complete, then stops every thread. Do not use threadpool afterwards. Is called on destruction.
+
+
|
+ +pure virtualnoexcept | +
Returns size of underlying thread pool.
+
+
|
+ +pure virtualnoexcept | +
Tells validness of internal state.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IBestShotQualityEstimator, including all inherited members.
+estimate(const Image &image, const Detection &detection, const EstimationRequest request, EstimationResult &result) const noexcept=0 | fsdk::IBestShotQualityEstimator | pure virtual |
estimate(Span< const Image > images, Span< const Detection > detections, const EstimationRequest request, Span< EstimationResult > results) const noexcept=0 | fsdk::IBestShotQualityEstimator | pure virtual |
estimateAGS enum value | fsdk::IBestShotQualityEstimator | |
estimateAll enum value | fsdk::IBestShotQualityEstimator | |
estimateAsync(Span< const Image > images, Span< const Detection > detections, const EstimationRequest request) const =0 | fsdk::IBestShotQualityEstimator | pure virtual |
estimateHeadPose enum value | fsdk::IBestShotQualityEstimator | |
EstimationBatch typedef | fsdk::IBestShotQualityEstimator | |
EstimationBatchFuture typedef (defined in fsdk::IBestShotQualityEstimator) | fsdk::IBestShotQualityEstimator | |
EstimationRequest enum name | fsdk::IBestShotQualityEstimator | |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > images, Span< const Detection > detections, const EstimationRequest request, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IBestShotQualityEstimator | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
BestShotQuality estimator interface. + More...
+ +#include <IBestShotQualityEstimator.h>
+Classes | |
struct | EstimationResult |
BestShotQualityEstimator output structure. More... | |
+Public Types | |
enum | EstimationRequest { estimateAGS = 1 << 0, +estimateHeadPose = 1 << 1, +estimateAll = 0xffff + } |
EstimationRequest lists all possible estimation attributes that BestShotQuality estimator is able to estimate. More... | |
+using | EstimationBatch = std::vector< EstimationResult > |
Common aliases for BestShotQuality asynchronous interface. | |
+using | EstimationBatchFuture = vlc::future< EstimationBatch > |
+Public Member Functions | |
virtual Result< FSDKError > | estimate (const Image &image, const Detection &detection, const EstimationRequest request, EstimationResult &result) const noexcept=0 |
Estimate unified AGS and HeadPose attributes. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > images, Span< const Detection > detections, const EstimationRequest request, Span< EstimationResult > results) const noexcept=0 |
Estimate unified AGS and HeadPose attributes of multiple frames in a single estimate function call. More... | |
virtual EstimationBatchFuture | estimateAsync (Span< const Image > images, Span< const Detection > detections, const EstimationRequest request) const =0 |
Asynchronously estimate unified AGS and HeadPose attributes of multiple frames in a single estimate function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< const Detection > detections, const EstimationRequest request, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
BestShotQuality estimator interface.
+enum fsdk::IBestShotQualityEstimator::EstimationRequest | +
+
|
+ +pure virtualnoexcept | +
Estimate unified AGS and HeadPose attributes.
+[in] | image | source image; |
[in] | detection | detection coordinates in image space; |
[in] | request | EstimationRequest structure; |
[out] | result | output estimation. |
+
|
+ +pure virtualnoexcept | +
Estimate unified AGS and HeadPose attributes of multiple frames in a single estimate function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[in] | request | EstimationRequest structure. |
[out] | results | span of estimations. |
+
|
+ +pure virtual | +
Asynchronously estimate unified AGS and HeadPose attributes of multiple frames in a single estimate function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[in] | request | EstimationRequest structure. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[in] | request | EstimationRequest structure. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IBestShotQualityEstimator::EstimationResult, including all inherited members.
+ags | fsdk::IBestShotQualityEstimator::EstimationResult | |
headPose | fsdk::IBestShotQualityEstimator::EstimationResult |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
BestShotQualityEstimator output structure. + More...
+ +#include <IBestShotQualityEstimator.h>
+Public Attributes | |
+Optional< HeadPoseEstimation > | headPose |
HeadPose estimation if was requested, empty otherwise. | |
+Optional< float > | ags |
AGS estimation if was requested, empty otherwise. | |
BestShotQualityEstimator output structure.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDataStorageObject, including all inherited members.
+clear() noexcept=0 | fsdk::IDataStorageObject | pure virtual |
Default enum value | fsdk::ISerializableObject | |
Error enum name | fsdk::ISerializableObject | |
Flags enum name | fsdk::ISerializableObject | |
getParentObject() const noexcept=0 | fsdk::IDataStorageObject | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getSize(Sizer &sizer, uint32_t flags=Default) const noexcept=0 | fsdk::ISerializableObject | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
load(IArchive *archive, uint32_t flags=Default)=0 | fsdk::ISerializableObject | pure virtual |
NoSignature enum value | fsdk::ISerializableObject | |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
save(IArchive *archive, uint32_t flags=Default) const =0 | fsdk::ISerializableObject | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Data storage object interface helper. + More...
+ +#include <IObject.h>
+Public Member Functions | |
virtual void | clear () noexcept=0 |
Clear object data. More... | |
virtual IRefCounted * | getParentObject () const noexcept=0 |
Get parent object (one that has created this). More... | |
![]() | |
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... | |
![]() | |
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... | |
+Additional Inherited Members | |
![]() | |
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... | |
Data storage object interface helper.
+
+
|
+ +pure virtualnoexcept | +
Clear object data.
+
+
|
+ +pure virtualnoexcept | +
Get parent object (one that has created this).
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDenseIndex, including all inherited members.
+descriptorByIndex(const DescriptorId index, IDescriptor *descriptor) const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
getDescriptorVersion() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
search(const IDescriptor *reference, int maxResultsCount, SearchResult *results) const noexcept=0 | fsdk::IIndex | pure virtual |
size() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Dense (read only) index interface. + More...
+ +#include <IIndex.h>
+Additional Inherited Members | |
![]() | |
virtual Result< FSDKError > | descriptorByIndex (const DescriptorId index, IDescriptor *descriptor) const noexcept=0 |
Requests descriptor data out of internal storage. More... | |
virtual uint32_t | getDescriptorVersion () const noexcept=0 |
Return version of stored descriptors. More... | |
virtual uint64_t | size () const noexcept=0 |
Return size of internal storage. More... | |
![]() | |
virtual ResultValue< FSDKError, +int > | search (const IDescriptor *reference, int maxResultsCount, SearchResult *results) const noexcept=0 |
Search for descriptors with the shorter distance to passed descriptor. More... | |
![]() | |
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... | |
Dense (read only) index interface.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDescriptor, including all inherited members.
+clear() noexcept=0 | fsdk::IDataStorageObject | pure virtual |
Default enum value | fsdk::ISerializableObject | |
Error enum name | fsdk::ISerializableObject | |
Flags enum name | fsdk::ISerializableObject | |
getDescriptor(uint8_t *buffer) const noexcept=0 | fsdk::IDescriptor | pure virtual |
getDescriptorLength() const noexcept=0 | fsdk::IDescriptor | pure virtual |
getDescriptorType() const noexcept=0 | fsdk::IDescriptor | pure virtual |
getModelVersion() const noexcept=0 | fsdk::IDescriptor | pure virtual |
getParentObject() const noexcept=0 | fsdk::IDataStorageObject | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getSize(Sizer &sizer, uint32_t flags=Default) const noexcept=0 | fsdk::ISerializableObject | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
load(IArchive *archive, uint32_t flags=Default)=0 | fsdk::ISerializableObject | pure virtual |
NoSignature enum value | fsdk::ISerializableObject | |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
save(IArchive *archive, uint32_t flags=Default) const =0 | fsdk::ISerializableObject | pure virtual |
setDescriptor(const uint8_t *buffer) noexcept=0 | fsdk::IDescriptor | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Descriptor interface. + More...
+ +#include <IDescriptor.h>
+Public Member Functions | |
virtual uint32_t | getModelVersion () const noexcept=0 |
Get algorithm model version this descriptor was created with. More... | |
virtual DescriptorType | getDescriptorType () const noexcept=0 |
Get type of descriptor. More... | |
virtual uint32_t | getDescriptorLength () const noexcept=0 |
return size of descriptor in bytes. More... | |
virtual bool | getDescriptor (uint8_t *buffer) const noexcept=0 |
Copy descriptor data to user provided buffer. More... | |
virtual void | setDescriptor (const uint8_t *buffer) noexcept=0 |
Copy descriptor from user providedbuffer. More... | |
![]() | |
virtual void | clear () noexcept=0 |
Clear object data. More... | |
virtual IRefCounted * | getParentObject () const noexcept=0 |
Get parent object (one that has created this). More... | |
![]() | |
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... | |
![]() | |
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... | |
+Additional Inherited Members | |
![]() | |
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... | |
Descriptor interface.
+Used for matching.
+
+
|
+ +pure virtualnoexcept | +
Copy descriptor data to user provided buffer.
+[out] | buffer | user provided buffer. |
+
|
+ +pure virtualnoexcept | +
return size of descriptor in bytes.
+
+
|
+ +pure virtualnoexcept | +
+
|
+ +pure virtualnoexcept | +
Get algorithm model version this descriptor was created with.
+
+
|
+ +pure virtualnoexcept | +
Copy descriptor from user providedbuffer.
+[in] | buffer | user provided buffer. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDescriptorBatch, including all inherited members.
+add(IDescriptor *descriptor) noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
add(IDescriptorBatch *batch, uint32_t offset=0) noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
add(IDescriptorBatch *batch, uint32_t offset, uint32_t count) noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
clear() noexcept=0 | fsdk::IDataStorageObject | pure virtual |
Default enum value | fsdk::ISerializableObject | |
Error enum name | fsdk::IDescriptorBatch | |
Flags enum name | fsdk::ISerializableObject | |
getCount() const noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
getDescriptorFast(uint32_t index) noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
getDescriptorLength() const noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
getDescriptorSlow(uint32_t index) const noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
getDescriptorType() const noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
getMaxCount() const noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
getModelVersion() const noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
getParentObject() const noexcept=0 | fsdk::IDataStorageObject | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getSize(Sizer &sizer, uint32_t flags=Default) const noexcept=0 | fsdk::ISerializableObject | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
load(IArchive *archive, uint32_t flags=Default)=0 | fsdk::ISerializableObject | pure virtual |
loadAndAdd(IArchive *archive)=0 | fsdk::IDescriptorBatch | pure virtual |
NoSignature enum value | fsdk::ISerializableObject | |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
removeFast(uint32_t index) noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
removeSlow(uint32_t index) noexcept=0 | fsdk::IDescriptorBatch | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
save(IArchive *archive, uint32_t flags=Default) const =0 | fsdk::ISerializableObject | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.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... | |
![]() | |
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... | |
![]() | |
virtual void | clear () noexcept=0 |
Clear object data. More... | |
virtual IRefCounted * | getParentObject () const noexcept=0 |
Get parent object (one that has created this). More... | |
![]() | |
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... | |
![]() | |
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.
+Enumerator | |
---|---|
Ok |
+ No error. + |
InvalidInput |
+ Invalid input (Ex: null pointer while a valid object is expected). + |
BatchFull |
+ Batch is full. + |
Incompatible |
+ Trying to add an incompatible descriptor. + |
Internal |
+ An internal processing error (Ex: memopry allocation or misalignment). + |
IoError |
+ Error while trying open/read/write file. + |
OutOfRange |
+ Error while accessing descriptor out of range. + |
+
|
+ +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. |
+
|
+ +pure virtualnoexcept | +
Remove a descriptor from batch.
+Remove descriptor by swapping it with the last descriptor in batch. This breaks descriptor order.
+[in] | index | descriptor index. |
+
|
+ +pure virtualnoexcept | +
Remove a descriptor from batch.
+Remove descriptor by shifting all the following descriptors back. This preserves descriptor order.
+[in] | index | descriptor index. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDescriptorExtractor, including all inherited members.
+extractFromWarpedImage(const Image &warp, IDescriptor *descriptor) const noexcept=0 | fsdk::IDescriptorExtractor | pure virtual |
extractFromWarpedImageBatch(Span< const Image > warps, IDescriptorBatch *descriptorBatch, IDescriptor *aggregation, Span< float > garbageScoreBatch) const noexcept=0 | fsdk::IDescriptorExtractor | pure virtual |
extractFromWarpedImageBatch(Span< const Image > warps, IDescriptorBatch *descriptorBatch, Span< float > garbageScoreBatch) const noexcept=0 | fsdk::IDescriptorExtractor | pure virtual |
extractFromWarpedImageBatchAsync(Span< const Image > warps, IDescriptorBatch *descriptorBatch, IDescriptor *aggregation, Span< float > garbageScoreBatch) const =0 | fsdk::IDescriptorExtractor | pure virtual |
FutureResult typedef | fsdk::IDescriptorExtractor | |
getDescriptorType() const noexcept=0 | fsdk::IDescriptorExtractor | pure virtual |
getModelVersion() const noexcept=0 | fsdk::IDescriptorExtractor | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IDescriptorExtractor | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Descriptor extractor interface. + More...
+ +#include <IDescriptor.h>
+Public Types | |
+using | FutureResult = vlc::future< float > |
Common aliases for BestShotQuality asynchronous interface. | |
+Public Member Functions | |
virtual ResultValue< FSDKError, +float > | extractFromWarpedImage (const Image &warp, IDescriptor *descriptor) const noexcept=0 |
Extract descriptor from a warped image. More... | |
virtual ResultValue< FSDKError, +float > | extractFromWarpedImageBatch (Span< const Image > warps, IDescriptorBatch *descriptorBatch, IDescriptor *aggregation, Span< float > garbageScoreBatch) const noexcept=0 |
Extract batch of descriptors from a batch of images and perform aggregation. More... | |
virtual Result< FSDKError > | extractFromWarpedImageBatch (Span< const Image > warps, IDescriptorBatch *descriptorBatch, Span< float > garbageScoreBatch) const noexcept=0 |
Extract batch of descriptors from a batch of images. More... | |
virtual Result< FSDKError > | validate (Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
virtual uint32_t | getModelVersion () const noexcept=0 |
Get algorithm model version this extractor works with. More... | |
virtual DescriptorType | getDescriptorType () const noexcept=0 |
Get type of descriptor this extractor works with. More... | |
virtual FutureResult | extractFromWarpedImageBatchAsync (Span< const Image > warps, IDescriptorBatch *descriptorBatch, IDescriptor *aggregation, Span< float > garbageScoreBatch) const =0 |
Asynchronously extract batch of descriptors from a batch of images. More... | |
![]() | |
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 extractor interface.
+Extracts face descriptors from images. The descriptors can be later used for face matching.
+
+
|
+ +pure virtualnoexcept | +
Extract descriptor from a warped image.
+[in] | warp | image with warped face or human warp. |
[out] | descriptor | descriptor to fill with data. |
+
|
+ +pure virtualnoexcept | +
Extract batch of descriptors from a batch of images and perform aggregation.
+[in] | warps | span of images with warped faces or human warps. |
[out] | descriptorBatch | descriptor batch to fill with data. |
[out] | aggregation | descriptor with aggregation based on descriptor batch. |
[out] | garbageScoreBatch | span of descriptor scores normalized in range [0, 1] 1 - face on the input warp; 0 - garbage on the input warp. |
+
|
+ +pure virtualnoexcept | +
Extract batch of descriptors from a batch of images.
+[in] | warps | span of images with warped faces or human warps. |
[out] | descriptorBatch | descriptor batch to fill with data. |
[out] | garbageScoreBatch | span of descriptor scores normalized in range [0, 1] 1 - face on the input warp; 0 - garbage on the input warp. DT_HUMAN descriptor does not support garbage score. In a case of DT_HUMAN descriptor, you'll get batch filled by 1.0. |
+
|
+ +pure virtual | +
Asynchronously extract batch of descriptors from a batch of images.
+[in] | warps | span of images with warped faces or human warps. |
[out] | descriptorBatch | descriptor batch to fill with data. |
[out] | aggregation | descriptor with aggregation based on descriptor batch. |
[out] | garbageScoreBatch | span of descriptor scores normalized in range [0, 1] 1 - face on the input warp; 0 - garbage on the input warp. DT_HUMAN descriptor does not support garbage score. In a case of DT_HUMAN descriptor, you'll get batch filled by 1.0. |
+
|
+ +pure virtualnoexcept | +
Get type of descriptor this extractor works with.
+
+
|
+ +pure virtualnoexcept | +
Get algorithm model version this extractor works with.
+
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | warps | span of images with warped faces or human warps. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDescriptorMatcher, including all inherited members.
+calcDistance(Span< MatchingResult > similarities) const noexcept=0 | fsdk::IDescriptorMatcher | pure virtual |
calcSimilarity(Span< MatchingResult > distances) const noexcept=0 | fsdk::IDescriptorMatcher | pure virtual |
getModelVersion() const noexcept=0 | fsdk::IDescriptorMatcher | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
match(const IDescriptor *first, const IDescriptor *second) noexcept=0 | fsdk::IDescriptorMatcher | pure virtual |
match(const IDescriptor *reference, const IDescriptorBatch *candidates, Span< MatchingResult > results) noexcept=0 | fsdk::IDescriptorMatcher | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Descriptor matcher interface. + More...
+ +#include <IDescriptor.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +MatchingResult > | match (const IDescriptor *first, const IDescriptor *second) noexcept=0 |
Match descriptors 1:1. More... | |
virtual Result< FSDKError > | match (const IDescriptor *reference, const IDescriptorBatch *candidates, Span< MatchingResult > results) noexcept=0 |
Match descriptors 1:M. More... | |
virtual uint32_t | getModelVersion () const noexcept=0 |
Get algorithm model version this matcher works with. More... | |
virtual Result< FSDKError > | calcSimilarity (Span< MatchingResult > distances) const noexcept=0 |
Calculates similarity based on distance. More... | |
virtual Result< FSDKError > | calcDistance (Span< MatchingResult > similarities) const noexcept=0 |
Calculates distance from similarity. More... | |
![]() | |
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 matcher interface.
+Matches descriptors 1:1 and 1:M (
+As a result of the matching process the calling site gets a MatchingResult (or several of them in case of 1:M matching). The MatchingResult structure contains distance and similarity metrics.
+Distance is measured in abstract units and tends to 0 for similar descriptors and to infinity for different ones. Similarity is the opposite metric and shows probability of two descriptors belonging to the same person; therfore it is normalized to [0..1] range.
+
+
|
+ +pure virtualnoexcept | +
Calculates distance from similarity.
+The method gets similarity from similarities
[i].similarity and assigns the result to similarities
[i].distance.
[in] | similarities | is a mutable span of matching results with calculated similarity. |
+
|
+ +pure virtualnoexcept | +
Calculates similarity based on distance.
+The method gets distance from distances
[i].distances. and assigns the result to distances
[i].similarity.
[in] | dinstances | is a mutable span of matching results with calculated distances. |
+
|
+ +pure virtualnoexcept | +
Get algorithm model version this matcher works with.
+
+
|
+ +pure virtualnoexcept | +
Match descriptors 1:1.
+[in] | first | first descriptor. |
[in] | second | second descriptor. |
+
|
+ +pure virtualnoexcept | +
Match descriptors 1:M.
+Matches a reference descriptor to a batch of candidate descriptors. The results are layed out in the same order as the candidate descriptors in the batch.
+[in] | reference | the reference descriptor. |
[in] | candidates | the candidate descriptor batch to match with the reference. |
[out] | results | span of matching results. |
results
must be at least the same as the length of the candidates batch. ![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDetector, including all inherited members.
+detect(Span< const Image > images, Span< const Rect > ROIs, uint32_t perImageNum, DetectionType type=DT_BBOX) noexcept=0 | fsdk::IDetector | pure virtual |
detectAsync(Span< const Image > images, Span< const Rect > rectangles, uint32_t perImageNum, DetectionType type=DT_BBOX) const =0 | fsdk::IDetector | pure virtual |
detectOne(const Image &image, const Rect &rect, DetectionType type=DT_BBOX) noexcept=0 | fsdk::IDetector | pure virtual |
FaceBatchFuture typedef (defined in fsdk::IDetector) | fsdk::IDetector | |
FaceBatchResult typedef | fsdk::IDetector | |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
redetect(Span< const Image > images, Ref< IFaceDetectionBatch > detectionBatch, DetectionType type=DT_BBOX) noexcept=0 | fsdk::IDetector | pure virtual |
redetect(Span< const Image > images, Span< Span< const Detection >> detections, DetectionType type=DT_BBOX) noexcept=0 | fsdk::IDetector | pure virtual |
redetectAsync(Span< const Image > images, IFaceDetectionBatchPtr detectionBatch, DetectionType type=DT_BBOX) const =0 | fsdk::IDetector | pure virtual |
redetectOne(const Image &image, const Detection &detection, DetectionType type=DT_BBOX) noexcept=0 | fsdk::IDetector | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
setCustomDetectionComparer(const IDetectionComparer *comparer) noexcept=0 | fsdk::IDetector | pure virtual |
setDetectionComparer(DetectionComparerType comparerType) noexcept=0 | fsdk::IDetector | pure virtual |
validate(Span< const Image > images, Span< Span< const Detection >> detections, Span< Span< Result< FSDKError >>> errors) const noexcept=0 | fsdk::IDetector | pure virtual |
validate(Span< const Image > images, Span< const Rect > rects, uint32_t detectionPerImageNum, Span< Result< FSDKError >> outErrors) const noexcept=0 | fsdk::IDetector | pure virtual |
validate(Span< const Image > images, Ref< IFaceDetectionBatch > detectionBatch, Span< Result< FSDKError >> outErrors) const noexcept=0 | fsdk::IDetector | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
face detector interface. + More...
+ +#include <IDetector.h>
+Public Types | |
+using | FaceBatchResult = ResultValue< FSDKError, IFaceDetectionBatchPtr > |
Common aliases for IDetector asynchronous interface. | |
+using | FaceBatchFuture = vlc::future< IFaceDetectionBatchPtr > |
+Public Member Functions | |
virtual ResultValue< FSDKError, +Ref< IFaceDetectionBatch > > | detect (Span< const Image > images, Span< const Rect > ROIs, uint32_t perImageNum, DetectionType type=DT_BBOX) noexcept=0 |
Detect faces and their parameters on multiple images. More... | |
virtual ResultValue< FSDKError, +Face > | detectOne (const Image &image, const Rect &rect, DetectionType type=DT_BBOX) noexcept=0 |
Light function to get just one best detection from single input image. More... | |
virtual ResultValue< FSDKError, +Ref< IFaceDetectionBatch > > | redetect (Span< const Image > images, Ref< IFaceDetectionBatch > detectionBatch, DetectionType type=DT_BBOX) noexcept=0 |
Batched redetect faces on multiple images. based on the detection results for the previous frames. More... | |
virtual ResultValue< FSDKError, +Ref< IFaceDetectionBatch > > | redetect (Span< const Image > images, Span< Span< const Detection >> detections, DetectionType type=DT_BBOX) noexcept=0 |
Batched redetect faces on multiple images. based on the detection results for the previous frames. More... | |
virtual ResultValue< FSDKError, +Face > | redetectOne (const Image &image, const Detection &detection, DetectionType type=DT_BBOX) noexcept=0 |
Redetect face. More... | |
virtual void | setDetectionComparer (DetectionComparerType comparerType) noexcept=0 |
Set detection comparer from SDK defined list. More... | |
virtual void | setCustomDetectionComparer (const IDetectionComparer *comparer) noexcept=0 |
Set custom detection comparer object. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< Span< const Detection >> detections, Span< Span< Result< FSDKError >>> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< const Rect > rects, uint32_t detectionPerImageNum, Span< Result< FSDKError >> outErrors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Ref< IFaceDetectionBatch > detectionBatch, Span< Result< FSDKError >> outErrors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
virtual FaceBatchFuture | detectAsync (Span< const Image > images, Span< const Rect > rectangles, uint32_t perImageNum, DetectionType type=DT_BBOX) const =0 |
Asynchronously detect faces and their parameters on multiple images. More... | |
virtual FaceBatchFuture | redetectAsync (Span< const Image > images, IFaceDetectionBatchPtr detectionBatch, DetectionType type=DT_BBOX) const =0 |
Asynchronously redetect faces on multiple images. based on the detection results for the previous frames. More... | |
![]() | |
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... | |
face detector interface.
+
+
|
+ +pure virtualnoexcept | +
Detect faces and their parameters on multiple images.
+[in] | images | span of source images. |
[in] | rectangles | input rectangles of interest (ROI) span. |
[in] | perImageNum | the max number of detections per input image. |
[in] | type | type of the detection. |
+
|
+ +pure virtual | +
Asynchronously detect faces and their parameters on multiple images.
+[in] | images | span of source images. |
[in] | rectangles | input rectangles of interest (ROI) span. |
[in] | perImageNum | the max number of detections per input image. |
[in] | type | type of the detection. |
+
|
+ +pure virtualnoexcept | +
Light function to get just one best detection from single input image.
+[in] | image | source image. |
[in] | rect | rectangle of interest in the image. |
[in] | type | type of detection: BBox, 5landmarks or 68landmarks. |
+
|
+ +pure virtualnoexcept | +
Batched redetect faces on multiple images. based on the detection results for the previous frames.
+[in] | images | span of source images. |
[in] | detectionBatch | result of detection on the previous frames - Ref with an IFaceDetectionBatch object. |
[in] | type | type of redetection. |
+
|
+ +pure virtualnoexcept | +
Batched redetect faces on multiple images. based on the detection results for the previous frames.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space from the previous frames. It is a two dimensional Span. There is one Span of the rectangles for each image. |
[in] | type | type of redetection. |
+
|
+ +pure virtual | +
Asynchronously redetect faces on multiple images. based on the detection results for the previous frames.
+[in] | images | span of source images. |
[in] | detectionBatch | result of detection on the previous frames - Ref with an IFaceDetectionBatch object. |
[in] | type | type of redetection. |
+
|
+ +pure virtualnoexcept | +
Redetect face.
+[in] | image | source image. Format must be R8G8B8. |
[in] | detection | detection coordinates in image space from the previous frame to make redetect. |
[in] | type | type of detection: BBox, 5landmarks or 68landmarks. |
+
|
+ +pure virtualnoexcept | +
Set custom detection comparer object.
+[in] | comparer | pointer to user defined comparer object. |
+
|
+ +pure virtualnoexcept | +
Set detection comparer from SDK defined list.
+[in] | comparerType | type of the comparer for detections. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space from the previous frames. It is a two dimensional Span. There is one Span of Detections for each image. |
[out] | errors | output span of errors for each image. It is a two dimensional Span. There is one Span of the errors for each image. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | rects | span of rectangle coordinates of corresponding source images. |
[in] | detectionPerImageNum | max number of detections per input image. |
[out] | errors | output span of errors for each image. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detectionBatch | result of detection on the previous frames - Ref with an IFaceDetectionBatch object. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDynamicDescriptorStorage, including all inherited members.
+appendBatch(const IDescriptorBatch *batch) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
appendDescriptor(const IDescriptor *descriptor) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
descriptorByIndex(const DescriptorId index, IDescriptor *descriptor) const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
getDescriptorVersion() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
removeDescriptor(const DescriptorId index) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
size() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Dynamic descriptor storage interface. + More...
+ +#include <IIndex.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +DescriptorId > | appendDescriptor (const IDescriptor *descriptor) noexcept=0 |
Appends descriptor to internal storage. If used on. More... | |
virtual ResultValue< FSDKError, +DescriptorId > | appendBatch (const IDescriptorBatch *batch) noexcept=0 |
Appends batch of descriptors to internal storage. If used on. More... | |
virtual Result< FSDKError > | removeDescriptor (const DescriptorId index) noexcept=0 |
Removes descriptor out of internal storage. If used on. More... | |
![]() | |
virtual Result< FSDKError > | descriptorByIndex (const DescriptorId index, IDescriptor *descriptor) const noexcept=0 |
Requests descriptor data out of internal storage. More... | |
virtual uint32_t | getDescriptorVersion () const noexcept=0 |
Return version of stored descriptors. More... | |
virtual uint64_t | size () const noexcept=0 |
Return size of internal storage. More... | |
Dynamic descriptor storage interface.
+You may think of it as read+write access to some internal container.
+
+
|
+ +pure virtualnoexcept | +
Appends batch of descriptors to internal storage. If used on.
+[in] | batch | Batch of descriptors with correct length, version and data. |
+
|
+ +pure virtualnoexcept | +
Appends descriptor to internal storage. If used on.
+[in] | descriptor | Ptr to created descriptor with correct length, version and data. |
+
|
+ +pure virtualnoexcept | +
Removes descriptor out of internal storage. If used on.
+[in] | index | Identification of descriptors position in internal storage. Is received by using append methods or ::search. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IDynamicIndex, including all inherited members.
+appendBatch(const IDescriptorBatch *batch) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
appendDescriptor(const IDescriptor *descriptor) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
countOfIndexedDescriptors() const noexcept=0 | fsdk::IDynamicIndex | pure virtual |
descriptorByIndex(const DescriptorId index, IDescriptor *descriptor) const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
getDescriptorVersion() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
removeDescriptor(const DescriptorId index) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
saveToDenseIndex(const char *path) const noexcept=0 | fsdk::IDynamicIndex | pure virtual |
saveToDynamicIndex(const char *path) const noexcept=0 | fsdk::IDynamicIndex | pure virtual |
search(const IDescriptor *reference, int maxResultsCount, SearchResult *results) const noexcept=0 | fsdk::IIndex | pure virtual |
size() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Dynamic index interface. + More...
+ +#include <IIndex.h>
+Public Member Functions | |
virtual Result< FSDKError > | saveToDenseIndex (const char *path) const noexcept=0 |
Saves index as dense. More... | |
virtual Result< FSDKError > | saveToDynamicIndex (const char *path) const noexcept=0 |
Saves index as dynamic. More... | |
virtual uint64_t | countOfIndexedDescriptors () const noexcept=0 |
Returns count of indexed descriptors. More... | |
![]() | |
virtual ResultValue< FSDKError, +DescriptorId > | appendDescriptor (const IDescriptor *descriptor) noexcept=0 |
Appends descriptor to internal storage. If used on. More... | |
virtual ResultValue< FSDKError, +DescriptorId > | appendBatch (const IDescriptorBatch *batch) noexcept=0 |
Appends batch of descriptors to internal storage. If used on. More... | |
virtual Result< FSDKError > | removeDescriptor (const DescriptorId index) noexcept=0 |
Removes descriptor out of internal storage. If used on. More... | |
![]() | |
virtual Result< FSDKError > | descriptorByIndex (const DescriptorId index, IDescriptor *descriptor) const noexcept=0 |
Requests descriptor data out of internal storage. More... | |
virtual uint32_t | getDescriptorVersion () const noexcept=0 |
Return version of stored descriptors. More... | |
virtual uint64_t | size () const noexcept=0 |
Return size of internal storage. More... | |
![]() | |
virtual ResultValue< FSDKError, +int > | search (const IDescriptor *reference, int maxResultsCount, SearchResult *results) const noexcept=0 |
Search for descriptors with the shorter distance to passed descriptor. More... | |
![]() | |
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... | |
Dynamic index interface.
+
+
|
+ +pure virtualnoexcept | +
Returns count of indexed descriptors.
+You may wonder why this method exists if IDynamicIndex already inherits IStaticDescriptorStorage::size method. The reason is that
+
+
|
+ +pure virtualnoexcept | +
Saves index as dense.
+To load saved index use
+[in] | path | Path to file to be created and filled with index data. Any extension is acceptable. |
+
|
+ +pure virtualnoexcept | +
Saves index as dynamic.
+To load saved index use
+[in] | path | Path to file to be created and filled with index data. Any extension is acceptable. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IEyeEstimator, including all inherited members.
+estimate(const Image &warp, const EyeCropper::EyesRects &eyeRects, EyesEstimation &eyesEstimation) const noexcept=0 | fsdk::IEyeEstimator | pure virtual |
estimate(Span< const Image > warps, Span< const EyeCropper::EyesRects > eyeRects, Span< EyesEstimation > eyesEstimations) const noexcept=0 | fsdk::IEyeEstimator | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > warps, Span< const EyeCropper::EyesRects > eyeRects, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IEyeEstimator | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Eye estimator interface. + More...
+ +#include <IEyeEstimator.h>
+Public Member Functions | |
virtual Result< FSDKError > | estimate (const Image &warp, const EyeCropper::EyesRects &eyeRects, EyesEstimation &eyesEstimation) const noexcept=0 |
Estimate the attributes. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > warps, Span< const EyeCropper::EyesRects > eyeRects, Span< EyesEstimation > eyesEstimations) const noexcept=0 |
Estimate the attributes of multiple warped images in a single estimate function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > warps, Span< const EyeCropper::EyesRects > eyeRects, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
Eye estimator interface.
+
+
|
+ +pure virtualnoexcept | +
Estimate the attributes.
+[in] | warp | image with warped face. |
[in] | eyeRects | EyeCropper::EyesRects structure with valid rectangle coordinates of each eye. |
[out] | eyesEstimation | Estimation of both eyes. Iris and Eyelid output landmarks are in warpedImage coordinates. If you want them in source of warpedImage image coordinates, use IWarper::unwarp |
+
|
+ +pure virtualnoexcept | +
Estimate the attributes of multiple warped images in a single estimate function call.
+[in] | warps | span of images with warped faces. |
[in] | eyeRects | span of EyesRects structure of corresponding warped image with valid rectangle coordinates of each eye. |
[out] | eyesEstimations | span of EyesEstimation of corresponding warped images. Iris and Eyelid output landmarks are in warpedImage coordinates. If you want them in source of warpedImage image coordinates, use IWarper::unwarp |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | warps | span of images with warped faces. |
[in] | eyeRects | span of EyesRects structure of corresponding warped image with valid rectangle coordinates of each eye. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IFaceDetectionBatch, including all inherited members.
+getDetections(size_t index=0) const noexcept=0 | fsdk::IFaceDetectionBatch | pure virtual |
getFace(const Image &img, size_t imageIndex, size_t detectionIndex) const noexcept=0 | fsdk::IFaceDetectionBatch | pure virtual |
getLandmarks5(size_t index=0) const noexcept=0 | fsdk::IFaceDetectionBatch | pure virtual |
getLandmarks68(size_t index=0) const noexcept=0 | fsdk::IFaceDetectionBatch | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getSize() const noexcept=0 | fsdk::IFaceDetectionBatch | pure virtual |
getSize(size_t imageIndex) const noexcept=0 | fsdk::IFaceDetectionBatch | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Face detection result batch interface. + More...
+ +#include <IFaceDetectionBatch.h>
+Public Member Functions | |
virtual size_t | getSize () const noexcept=0 |
Returns size. More... | |
virtual size_t | getSize (size_t imageIndex) const noexcept=0 |
Returns size of the results for the target index. More... | |
virtual Face | getFace (const Image &img, size_t imageIndex, size_t detectionIndex) const noexcept=0 |
Returns detected face. More... | |
virtual Span< const Detection > | getDetections (size_t index=0) const noexcept=0 |
Returns detection Span. More... | |
virtual Span< const Landmarks5 > | getLandmarks5 (size_t index=0) const noexcept=0 |
Returns Landmarks5 Span. More... | |
virtual Span< const Landmarks68 > | getLandmarks68 (size_t index=0) const noexcept=0 |
Returns Landmarks68 Span. More... | |
![]() | |
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... | |
Face detection result batch interface.
+
+
|
+ +pure virtualnoexcept | +
Returns detection Span.
+[in] | index | index of the detection. |
+
|
+ +pure virtualnoexcept | +
Returns detected face.
+[in] | img | source image. |
[in] | imageIndex | index of the image. |
[in] | detectionIndex | index of the detection. |
+
|
+ +pure virtualnoexcept | +
Returns Landmarks5 Span.
+[in] | index | index of the landmarks object. |
+
|
+ +pure virtualnoexcept | +
Returns Landmarks68 Span.
+[in] | index | index of the landmarks object. |
+
|
+ +pure virtualnoexcept | +
Returns size.
+
+
|
+ +pure virtualnoexcept | +
Returns size of the results for the target index.
+[in] | imageIndex | index of the image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IFaceEngineMobile, including all inherited members.
+createAGSEstimator() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createBestShotQualityEstimator() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createDescriptor(uint32_t version=0) noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createDescriptor(IArchive *archive, uint32_t flags=0) noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createDescriptorBatch(int32_t size, uint32_t version=0) noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createDetector() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createExtractor(uint32_t version=0) noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createEyeEstimator() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createGlassesEstimator() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createHeadPoseEstimator() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createLivenessOneShotRGBEstimator() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createMatcher(uint32_t version=0) noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createMedicalMaskEstimator() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createQualityEstimator() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
createWarper() noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
getDataDirectory() const noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
getFaceEngineEdition() const noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
getLicense() const noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getRuntimeSettingsProvider() const noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
getSettingsProvider() const noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
setDataDirectory(const char *path) noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
setRuntimeSettingsProvider(ISettingsProvider *provider) noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
setSettingsProvider(ISettingsProvider *provider) noexcept=0 | fsdk::IFaceEngineMobile | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Root LUNA SDK object interface. + More...
+ +#include <IFaceEngineMobile.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +IDetectorPtr > | createDetector () noexcept=0 |
Creates a detector of given type. More... | |
virtual ResultValue< FSDKError, +IHeadPoseEstimatorPtr > | createHeadPoseEstimator () noexcept=0 |
Creates Head pose estimator. More... | |
virtual ResultValue< FSDKError, +IAGSEstimatorPtr > | createAGSEstimator () noexcept=0 |
Creates AGS estimator. More... | |
virtual ResultValue< FSDKError, +IEyeEstimatorPtr > | createEyeEstimator () noexcept=0 |
Creates Eye estimator. More... | |
virtual ResultValue< FSDKError, +IMedicalMaskEstimatorPtr > | createMedicalMaskEstimator () noexcept=0 |
Creates MedicalMask estimator. More... | |
virtual ResultValue< FSDKError, +IGlassesEstimatorPtr > | createGlassesEstimator () noexcept=0 |
Creates Glasses estimator. More... | |
virtual ResultValue< FSDKError, +IQualityEstimatorPtr > | createQualityEstimator () noexcept=0 |
Creates Quality estimator. More... | |
virtual ResultValue< FSDKError, +IBestShotQualityEstimatorPtr > | createBestShotQualityEstimator () noexcept=0 |
Creates BestShotQuality estimator. More... | |
virtual ResultValue< FSDKError, +ILivenessOneShotRGBEstimatorPtr > | createLivenessOneShotRGBEstimator () noexcept=0 |
Creates Liveness OneShot estimator. More... | |
virtual ResultValue< FSDKError, +IDescriptorPtr > | createDescriptor (uint32_t version=0) noexcept=0 |
Creates Descriptor. More... | |
virtual ResultValue< FSDKError, +IDescriptorPtr > | createDescriptor (IArchive *archive, uint32_t flags=0) noexcept=0 |
Creates and loads Descriptor from Archive. More... | |
virtual ResultValue< FSDKError, +IDescriptorBatchPtr > | createDescriptorBatch (int32_t size, uint32_t version=0) noexcept=0 |
Creates Batch of descriptors. More... | |
virtual ResultValue< FSDKError, +IDescriptorExtractorPtr > | createExtractor (uint32_t version=0) noexcept=0 |
Creates descriptor extractor. More... | |
virtual ResultValue< FSDKError, +IDescriptorMatcherPtr > | createMatcher (uint32_t version=0) noexcept=0 |
Creates descriptor matcher. More... | |
virtual ResultValue< FSDKError, +IWarperPtr > | createWarper () noexcept=0 |
Creates warper. More... | |
virtual FaceEngineEdition | getFaceEngineEdition () const noexcept=0 |
Get LUNA SDK ditribution edition. More... | |
virtual void | setDataDirectory (const char *path) noexcept=0 |
Sets data directory. More... | |
virtual const char * | getDataDirectory () const noexcept=0 |
Gets data directory. More... | |
virtual void | setSettingsProvider (ISettingsProvider *provider) noexcept=0 |
Sets settings provider. More... | |
virtual void | setRuntimeSettingsProvider (ISettingsProvider *provider) noexcept=0 |
Sets runtime settings provider. More... | |
virtual ISettingsProvider * | getSettingsProvider () const noexcept=0 |
Gets settings provider. More... | |
virtual ISettingsProvider * | getRuntimeSettingsProvider () const noexcept=0 |
Gets runtime settings provider. More... | |
virtual ILicense * | getLicense () const noexcept=0 |
Get current License object, which was set for FaceEngine object. More... | |
![]() | |
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... | |
Root LUNA SDK object interface.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IGlassesEstimator, including all inherited members.
+estimate(const Image &warp) const noexcept=0 | fsdk::IGlassesEstimator | pure virtual |
estimate(Span< const Image > warps, Span< GlassesEstimation > glassesEstimations) const noexcept=0 | fsdk::IGlassesEstimator | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IGlassesEstimator | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Glasses estimator interface. + More...
+ +#include <IGlassesEstimator.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +GlassesEstimation > | estimate (const Image &warp) const noexcept=0 |
virtual Result< FSDKError > | estimate (Span< const Image > warps, Span< GlassesEstimation > glassesEstimations) const noexcept=0 |
Checks if people are wearing glasses or not for multiple warped images in a single estimate function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
Glasses estimator interface.
+
+
|
+ +pure virtualnoexcept | +
brief checks whether person wearing any glasses or not.
+[in] | warp | image with warped face; |
+
|
+ +pure virtualnoexcept | +
Checks if people are wearing glasses or not for multiple warped images in a single estimate function call.
+[in] | warps | span of images with warped faces. |
[out] | glassesEstimations | output GlassesEstimation span. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | warps | span of images with warped faces. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IHeadPoseEstimator, including all inherited members.
+estimate(const Landmarks68 &landmarks, HeadPoseEstimation &out) const noexcept=0 | fsdk::IHeadPoseEstimator | pure virtual |
estimate(const Image &image, const Detection &detection, HeadPoseEstimation &out) const noexcept=0 | fsdk::IHeadPoseEstimator | pure virtual |
estimate(Span< const Image > images, Span< const Detection > detections, Span< HeadPoseEstimation > out) const noexcept=0 | fsdk::IHeadPoseEstimator | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IHeadPoseEstimator | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Head pose angles estimator interface. + More...
+ +#include <IHeadPoseEstimator.h>
+Public Member Functions | |
virtual Result< FSDKError > | estimate (const Landmarks68 &landmarks, HeadPoseEstimation &out) const noexcept=0 |
Estimate the angles. More... | |
virtual Result< FSDKError > | estimate (const Image &image, const Detection &detection, HeadPoseEstimation &out) const noexcept=0 |
Estimate the angles. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > images, Span< const Detection > detections, Span< HeadPoseEstimation > out) const noexcept=0 |
Estimate headpose angles of multiple frames in a single estimate function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
Head pose angles estimator interface.
+Estimated angles are:
+
+
|
+ +pure virtualnoexcept | +
Estimate the angles.
+[in] | landmarks | Landmarks68 structure. |
[out] | out | output estimation. |
+
|
+ +pure virtualnoexcept | +
Estimate the angles.
+[in] | image | source image. |
[in] | detection | detection coordinates in image space. |
[out] | out | output estimation. |
+
|
+ +pure virtualnoexcept | +
Estimate headpose angles of multiple frames in a single estimate function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[out] | out | estimations array of corresponding images. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IHumanDetectionBatch, including all inherited members.
+getDetections(size_t index=0) const noexcept=0 | fsdk::IHumanDetectionBatch | pure virtual |
getHuman(const Image &image, size_t imageIndex, size_t detectionIndex) const noexcept=0 | fsdk::IHumanDetectionBatch | pure virtual |
getLandmarks17(size_t index=0) const noexcept=0 | fsdk::IHumanDetectionBatch | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getSize() const noexcept=0 | fsdk::IHumanDetectionBatch | pure virtual |
getSize(size_t imageIndex) const noexcept=0 | fsdk::IHumanDetectionBatch | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Human detection result batch interface. + More...
+ +#include <IHumanDetectionBatch.h>
+Public Member Functions | |
+virtual size_t | getSize () const noexcept=0 |
Returns size. | |
virtual size_t | getSize (size_t imageIndex) const noexcept=0 |
Returns size of the results for the target index. More... | |
virtual Human | getHuman (const Image &image, size_t imageIndex, size_t detectionIndex) const noexcept=0 |
Returns detected Human. More... | |
virtual Span< const Detection > | getDetections (size_t index=0) const noexcept=0 |
Returns detection Span. More... | |
virtual Span< const +HumanLandmarks17 > | getLandmarks17 (size_t index=0) const noexcept=0 |
Returns HumanLandmarks17 Span. More... | |
![]() | |
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... | |
Human detection result batch interface.
+
+
|
+ +pure virtualnoexcept | +
Returns detection Span.
+[in] | index | index of the detections Span. |
+
|
+ +pure virtualnoexcept | +
+
|
+ +pure virtualnoexcept | +
Returns HumanLandmarks17 Span.
+[in] | index | index of the HumanLandmarks17 Span. |
+
|
+ +pure virtualnoexcept | +
Returns size of the results for the target index.
+[in] | imageIndex | index of the image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IHumanDetector, including all inherited members.
+detect(Span< const Image > images, Span< const Rect > rects, uint32_t detectionPerImageNum, HumanDetectionType type=HDT_BOX) const noexcept=0 | fsdk::IHumanDetector | pure virtual |
detectOne(const Image &image, const Rect &rect, HumanDetectionType type=HDT_BOX) const noexcept=0 | fsdk::IHumanDetector | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
redetect(Span< const Image > images, Ref< IHumanDetectionBatch > detectionBatch, HumanDetectionType type=HDT_BOX) const noexcept=0 | fsdk::IHumanDetector | pure virtual |
redetect(Span< const Image > images, Span< Span< const Detection >> detections, HumanDetectionType type=HDT_BOX) const noexcept=0 | fsdk::IHumanDetector | pure virtual |
redetectOne(const Image &image, const Detection &detection, HumanDetectionType type=HDT_BOX) const noexcept=0 | fsdk::IHumanDetector | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > images, Span< const Rect > rects, uint32_t detectionPerImageNum, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IHumanDetector | pure virtual |
validate(Span< const Image > images, Ref< IHumanDetectionBatch > detectionBatch, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IHumanDetector | pure virtual |
validate(Span< const Image > images, Span< Span< const Detection >> detections, Span< Span< Result< FSDKError >>> errors) const noexcept=0 | fsdk::IHumanDetector | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
human body detector interface. + More...
+ +#include <IHumanDetector.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +Ref< IHumanDetectionBatch > > | detect (Span< const Image > images, Span< const Rect > rects, uint32_t detectionPerImageNum, HumanDetectionType type=HDT_BOX) const noexcept=0 |
Batched detect of human bodies. More... | |
virtual ResultValue< FSDKError, +Human > | detectOne (const Image &image, const Rect &rect, HumanDetectionType type=HDT_BOX) const noexcept=0 |
Detect one person on input image. More... | |
virtual ResultValue< FSDKError, +Human > | redetectOne (const Image &image, const Detection &detection, HumanDetectionType type=HDT_BOX) const noexcept=0 |
redetect one person from input image. More... | |
virtual ResultValue< FSDKError, +IHumanDetectionBatchPtr > | redetect (Span< const Image > images, Ref< IHumanDetectionBatch > detectionBatch, HumanDetectionType type=HDT_BOX) const noexcept=0 |
Batched redetect humans on multiple images based on the detection results for the previous frames. More... | |
virtual ResultValue< FSDKError, +IHumanDetectionBatchPtr > | redetect (Span< const Image > images, Span< Span< const Detection >> detections, HumanDetectionType type=HDT_BOX) const noexcept=0 |
Batched redetect humans on multiple images based on the detection results for the previous frames. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< const Rect > rects, uint32_t detectionPerImageNum, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Ref< IHumanDetectionBatch > detectionBatch, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< Span< const Detection >> detections, Span< Span< Result< FSDKError >>> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
human body detector interface.
+
+
|
+ +pure virtualnoexcept | +
Batched detect of human bodies.
+[in] | images | span of source images. |
[in] | rects | span of input rectangles of interest. |
[in] | detectionPerImageNum | max number of detections per input image. |
[in] | type | Human detection type. |
+
|
+ +pure virtualnoexcept | +
Detect one person on input image.
+[in] | image | source image. |
[in] | rect | rectangle of interest in the image. |
[in] | type | Human detection type. |
+
|
+ +pure virtualnoexcept | +
Batched redetect humans on multiple images based on the detection results for the previous frames.
+[in] | images | span of source images. |
[in] | detectionBatch | result of detection on the previous frames - Ref with an IHumanDetectionBatch object. |
[in] | type | type of redetection. |
+
|
+ +pure virtualnoexcept | +
Batched redetect humans on multiple images based on the detection results for the previous frames.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space from the previous frames. It is a two dimensional Span. There is one Span of the rectangles for each image. |
[in] | type | type of redetection. |
+
|
+ +pure virtualnoexcept | +
redetect one person from input image.
+[in] | image | source image. |
[in] | detection | span of detection coordinates in corresponding source images space to make a redetect. |
[in] | type | Human detection type. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | rects | span of rectangle coordinates of corresponding source images. |
[in] | detectionPerImageNum | max number of detections per input image. |
[out] | errors | output span of errors for each image. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detectionBatch | result of detection on the previous frames - Ref with an IHumanDetectionBatch object. |
[out] | errors | output span of errors for each image. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space from the previous frames. It is a two dimensional Span. There is one Span of the Detections for each image. |
[out] | errors | output span of errors for each image. It is a two dimensional Span. There is one Span of the errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IHumanWarper, including all inherited members.
+getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
warp(const Image image, const Detection &detection, Image &transformedImage) const noexcept=0 | fsdk::IHumanWarper | pure virtual |
warp(Span< const Image > images, Span< const Detection > detections, Span< Image > transformedImages) const noexcept=0 | fsdk::IHumanWarper | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Human detection area warper interface. + More...
+ +#include <IHumanWarper.h>
+Public Member Functions | |
virtual Result< FSDKError > | warp (const Image image, const Detection &detection, Image &transformedImage) const noexcept=0 |
Warp human detection. More... | |
virtual Result< FSDKError > | warp (Span< const Image > images, Span< const Detection > detections, Span< Image > transformedImages) const noexcept=0 |
Warps humans on multiple images. More... | |
![]() | |
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... | |
Human detection area warper interface.
+Performs cropping and resizing of an image for human descriptor extraction.
+
+
|
+ +pure virtualnoexcept | +
Warp human detection.
+[in] | image | source image. |
[in] | detection | detection coordinates in image space. |
[in/out] | transformedImage warped image output. |
+
|
+ +pure virtualnoexcept | +
Warps humans on multiple images.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[in/out] | transformedImages span of input/output images where result will be stored. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IIndex, including all inherited members.
+getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
search(const IDescriptor *reference, int maxResultsCount, SearchResult *results) const noexcept=0 | fsdk::IIndex | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Base index interface. + More...
+ +#include <IIndex.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +int > | search (const IDescriptor *reference, int maxResultsCount, SearchResult *results) const noexcept=0 |
Search for descriptors with the shorter distance to passed descriptor. More... | |
![]() | |
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... | |
Base index interface.
+You may think of index as some data structure optimized for search queries.
+
+
|
+ +pure virtualnoexcept | +
Search for descriptors with the shorter distance to passed descriptor.
+[in] | reference | Descriptor to match against index. |
[in] | maxResultsCount | Maximum count of results. It is upper bound value, it does not guarantee to return exactly this amount of results. |
[out] | results | C-Array of at least |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IIndexBuilder, including all inherited members.
+appendBatch(const IDescriptorBatch *batch) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
appendDescriptor(const IDescriptor *descriptor) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
buildIndex(const IProgressTracker *const progressTracker=nullptr) noexcept=0 | fsdk::IIndexBuilder | pure virtual |
buildIndexAsync(IAsyncContext *const asyncContext, const IProgressTracker *const progressTracker=nullptr) noexcept=0 | fsdk::IIndexBuilder | pure virtual |
descriptorByIndex(const DescriptorId index, IDescriptor *descriptor) const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
getDescriptorVersion() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
removeDescriptor(const DescriptorId index) noexcept=0 | fsdk::IDynamicDescriptorStorage | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
size() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Index builder interface. + More...
+ +#include <IIndex.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +IDynamicIndex * > | buildIndex (const IProgressTracker *const progressTracker=nullptr) noexcept=0 |
Builds index with every descriptor appended. Blocks until completed. More... | |
virtual ResultValue< FSDKError, +Future< ResultValue< FSDKError, +IDynamicIndex * > > > | buildIndexAsync (IAsyncContext *const asyncContext, const IProgressTracker *const progressTracker=nullptr) noexcept=0 |
Builds index with every descriptor appended. Non blocking operation. More... | |
![]() | |
virtual ResultValue< FSDKError, +DescriptorId > | appendDescriptor (const IDescriptor *descriptor) noexcept=0 |
Appends descriptor to internal storage. If used on. More... | |
virtual ResultValue< FSDKError, +DescriptorId > | appendBatch (const IDescriptorBatch *batch) noexcept=0 |
Appends batch of descriptors to internal storage. If used on. More... | |
virtual Result< FSDKError > | removeDescriptor (const DescriptorId index) noexcept=0 |
Removes descriptor out of internal storage. If used on. More... | |
![]() | |
virtual Result< FSDKError > | descriptorByIndex (const DescriptorId index, IDescriptor *descriptor) const noexcept=0 |
Requests descriptor data out of internal storage. More... | |
virtual uint32_t | getDescriptorVersion () const noexcept=0 |
Return version of stored descriptors. More... | |
virtual uint64_t | size () const noexcept=0 |
Return size of internal storage. More... | |
![]() | |
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... | |
Index builder interface.
+
+
|
+ +pure virtualnoexcept | +
Builds index with every descriptor appended. Blocks until completed.
+Is very heavy method in terms of computing load.
+[in] | progressTracker | Some object that is being reported to with progress. If its nullptr, dont report progress. |
+
|
+ +pure virtualnoexcept | +
Builds index with every descriptor appended. Non blocking operation.
+Is very heavy method in terms of computing load.
+[in] | asyncContext | Asynchronous context to run build on. |
[in] | progressTracker | Some object that is being reported to with progress. If its nullptr, dont report progress. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ILicense, including all inherited members.
+checkFeatureId(LicenseFeature feature) const noexcept=0 | fsdk::ILicense | pure virtual |
FSDK_DEPRECATED("loadFromFile is deprecated since v.5.5.0,"" Use loadFromFile(const char* path, const ISettingsProvider* settings) instead") loadFromFile(const char *path) noexcept=0 | fsdk::ILicense | pure virtual |
getExpirationDate(LicenseFeature feature) const noexcept=0 | fsdk::ILicense | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
isActivated() const noexcept=0 | fsdk::ILicense | pure virtual |
loadFromFile(const char *path, const ISettingsProvider *settings) noexcept=0 | fsdk::ILicense | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
saveToFile(const char *path) const noexcept=0 | fsdk::ILicense | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
License objects interface. + More...
+ +#include <ILicense.h>
+Public Member Functions | |
virtual ResultValue< FSDKError, +bool > | checkFeatureId (LicenseFeature feature) const noexcept=0 |
Checks if the feature with featureId is available in this license. More... | |
virtual ResultValue< FSDKError, +bool > | isActivated () const noexcept=0 |
Checks if current license object is activated and could be used by FaceEngine. More... | |
virtual Result< FSDKError > | FSDK_DEPRECATED ("loadFromFile is deprecated since v.5.5.0,"" Use loadFromFile(const char* path, const ISettingsProvider* settings) instead") loadFromFile(const char *path) noexcept=0 |
Loads license from file. More... | |
virtual Result< FSDKError > | loadFromFile (const char *path, const ISettingsProvider *settings) noexcept=0 |
Loads license from file. More... | |
virtual Result< FSDKError > | saveToFile (const char *path) const noexcept=0 |
Saves license as raw format to the file. This file could be used in the next run of the application. More... | |
virtual ResultValue< FSDKError, +uint32_t > | getExpirationDate (LicenseFeature feature) const noexcept=0 |
Gets license expiration date. More... | |
![]() | |
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... | |
License objects interface.
+
+
|
+ +pure virtualnoexcept | +
Checks if the feature with featureId is available in this license.
+[in] | feature | LicenseFeature type. |
+
|
+ +pure virtualnoexcept | +
+
|
+ +pure virtualnoexcept | +
Gets license expiration date.
+[in] | feature | LicenseFeature type. |
+
|
+ +pure virtualnoexcept | +
Checks if current license object is activated and could be used by FaceEngine.
+
+
|
+ +pure virtualnoexcept | +
Loads license from file.
+[in] | path | path to the file. |
[in] | settings | License settings provider. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ILivenessOneShotRGBEstimator, including all inherited members.
+estimate(const Image &image, const Detection &detection, const Landmarks5 &landmarks5, LivenessOneShotRGBEstimation &estimation, const float qualityThreshold=-1.f) const noexcept=0 | fsdk::ILivenessOneShotRGBEstimator | pure virtual |
estimate(Span< const Image > images, Span< const Detection > detections, Span< const Landmarks5 > landmarks5, Span< LivenessOneShotRGBEstimation > estimations, const float qualityThreshold=-1.f, LivenessOneShotRGBEstimation *aggregation=nullptr) const noexcept=0 | fsdk::ILivenessOneShotRGBEstimator | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > images, Span< const Detection > detections, Span< const Landmarks5 > landmarks5, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::ILivenessOneShotRGBEstimator | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
OneShot RGB Liveness estimator interface. + More...
+ +#include <ILivenessOneShotRGBEstimator.h>
+Public Member Functions | |
virtual Result< FSDKError > | estimate (const Image &image, const Detection &detection, const Landmarks5 &landmarks5, LivenessOneShotRGBEstimation &estimation, const float qualityThreshold=-1.f) const noexcept=0 |
OneShot RGB Liveness estimation. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > images, Span< const Detection > detections, Span< const Landmarks5 > landmarks5, Span< LivenessOneShotRGBEstimation > estimations, const float qualityThreshold=-1.f, LivenessOneShotRGBEstimation *aggregation=nullptr) const noexcept=0 |
OneShot RGB Liveness estimation. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< const Detection > detections, Span< const Landmarks5 > landmarks5, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
OneShot RGB Liveness estimator interface.
+
+
|
+ +pure virtualnoexcept | +
OneShot RGB Liveness estimation.
+[in] | image | source image. |
[in] | detection | detection coordinates in image space; |
[in] | landmarks5 | Landmarks5 for the detection; |
[out] | estimation | estimation results. |
[in] | qualityThreshold | quality threshold; |
+
|
+ +pure virtualnoexcept | +
OneShot RGB Liveness estimation.
+[in] | images | span of source images; |
[in] | detections | span of detection coordinates in corresponding source images space; |
[in] | landmarks5 | span of Landmarks5; |
[out] | estimations | span of estimations; |
[in] | qualityThreshold | quality threshold; |
[out] | aggregation | aggregated value based on estimations; |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[in] | landmarks5 | span of landmarks |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IMedicalMaskEstimator, including all inherited members.
+estimate(const Image &warp, MedicalMaskEstimation &estimation) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
estimate(const Image &warp, MedicalMaskEstimationExtended &estimation) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
estimate(const Image &image, const Detection &detection, MedicalMaskEstimation &estimation) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
estimate(const Image &image, const Detection &detection, MedicalMaskEstimationExtended &estimation) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
estimate(Span< const Image > warps, Span< MedicalMaskEstimation > estimations) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
estimate(Span< const Image > warps, Span< MedicalMaskEstimationExtended > estimations) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
estimate(Span< const Image > images, Span< const Detection > detections, Span< MedicalMaskEstimation > estimations) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
estimate(Span< const Image > images, Span< const Detection > detections, Span< MedicalMaskEstimationExtended > estimations) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
validate(Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IMedicalMaskEstimator | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
MedicalMask estimator interface. + More...
+ +#include <IMedicalMaskEstimator.h>
+Public Member Functions | |
virtual Result< FSDKError > | estimate (const Image &warp, MedicalMaskEstimation &estimation) const noexcept=0 |
Estimate MedicalMask probabilities. More... | |
virtual Result< FSDKError > | estimate (const Image &warp, MedicalMaskEstimationExtended &estimation) const noexcept=0 |
Estimate MedicalMask probabilities. More... | |
virtual Result< FSDKError > | estimate (const Image &image, const Detection &detection, MedicalMaskEstimation &estimation) const noexcept=0 |
Estimate MedicalMask probabilities. More... | |
virtual Result< FSDKError > | estimate (const Image &image, const Detection &detection, MedicalMaskEstimationExtended &estimation) const noexcept=0 |
Estimate MedicalMask probabilities. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > warps, Span< MedicalMaskEstimation > estimations) const noexcept=0 |
Estimate Medical Mask probabilities. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > warps, Span< MedicalMaskEstimationExtended > estimations) const noexcept=0 |
Estimate Medical Mask probabilities. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > images, Span< const Detection > detections, Span< MedicalMaskEstimation > estimations) const noexcept=0 |
Estimate Medical Mask probabilities. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > images, Span< const Detection > detections, Span< MedicalMaskEstimationExtended > estimations) const noexcept=0 |
Estimate Medical Mask probabilities. More... | |
virtual Result< FSDKError > | validate (Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
MedicalMask estimator interface.
+
+
|
+ +pure virtualnoexcept | +
+
|
+ +pure virtualnoexcept | +
+
|
+ +pure virtualnoexcept | +
Estimate MedicalMask probabilities.
+[in] | image | source image. |
[in] | detection | detection coordinates in image space. |
[out] | estimation | estimation results. |
+
|
+ +pure virtualnoexcept | +
Estimate MedicalMask probabilities.
+[in] | image | source image. |
[in] | detection | detection coordinates in image space. |
[out] | estimation | estimation results. |
+
|
+ +pure virtualnoexcept | +
Estimate Medical Mask probabilities.
+[in] | warps | span of images with warped faces. |
[out] | estimations | span of estimations. |
+
|
+ +pure virtualnoexcept | +
Estimate Medical Mask probabilities.
+[in] | warps | span of images with warped faces. |
[out] | estimations | span of estimations. |
+
|
+ +pure virtualnoexcept | +
Estimate Medical Mask probabilities.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[out] | estimations | span of estimations. |
+
|
+ +pure virtualnoexcept | +
Estimate Medical Mask probabilities.
+[in] | images | span of source images; |
[in] | detections | span of detection coordinates in corresponding source images space. |
[out] | estimations | span of estimations; |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | warps | span of images with warped faces. |
[out] | errors | output span of errors for each image. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | images | span of source images. |
[in] | detections | span of detection coordinates in corresponding source images space. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IProgressTracker, including all inherited members.
+progress(const float completion) const noexcept=0 | fsdk::IProgressTracker | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Progress tracker interface. + More...
+ +#include <IIndex.h>
+Public Member Functions | |
virtual void | progress (const float completion) const noexcept=0 |
Function is called on some operation progress change. More... | |
Progress tracker interface.
+Implement this interface to be able to get progress info on some operation.
+
+
|
+ +pure virtualnoexcept | +
Function is called on some operation progress change.
+[in] | completion | float value in [0..1] range. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IQualityEstimator, including all inherited members.
+estimate(const Image &warp, Quality &quality) const noexcept=0 | fsdk::IQualityEstimator | pure virtual |
estimate(Span< const Image > warps, Span< Quality > quality) const noexcept=0 | fsdk::IQualityEstimator | pure virtual |
estimate(const Image &warp, SubjectiveQuality &quality) const noexcept=0 | fsdk::IQualityEstimator | pure virtual |
estimate(Span< const Image > warps, Span< SubjectiveQuality > quality) const noexcept=0 | fsdk::IQualityEstimator | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
validate(Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0 | fsdk::IQualityEstimator | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Image quality estimator interface. + More...
+ +#include <IQualityEstimator.h>
+Public Member Functions | |
virtual Result< FSDKError > | estimate (const Image &warp, Quality &quality) const noexcept=0 |
Estimate the quality. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > warps, Span< Quality > quality) const noexcept=0 |
Estimate the quality of multiple warped images in a single estimate function call. More... | |
virtual Result< FSDKError > | estimate (const Image &warp, SubjectiveQuality &quality) const noexcept=0 |
Estimate the quality. More... | |
virtual Result< FSDKError > | estimate (Span< const Image > warps, Span< SubjectiveQuality > quality) const noexcept=0 |
Estimate the subjective quality of multiple warped images in a single estimate function call. More... | |
virtual Result< FSDKError > | validate (Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0 |
Validate input of multiple frames in a single function call. More... | |
![]() | |
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... | |
Image quality estimator interface.
+
+
|
+ +pure virtualnoexcept | +
+
|
+ +pure virtualnoexcept | +
Estimate the quality of multiple warped images in a single estimate function call.
+[in] | warps | span of images with warped faces. |
[out] | quality | output quality span. |
+
|
+ +pure virtualnoexcept | +
+
|
+ +pure virtualnoexcept | +
Estimate the subjective quality of multiple warped images in a single estimate function call.
+[in] | warps | span of images with warped faces. |
[out] | quality | output SubjectiveQuality span. |
+
|
+ +pure virtualnoexcept | +
Validate input of multiple frames in a single function call.
+[in] | warps | span of images with warped faces. |
[out] | errors | output span of errors for each image. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IRefCounted, including all inherited members.
+getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Base strong reference counted object interface. + More...
+ +#include <IRefCounted.h>
+Public Member Functions | |
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... | |
Base strong reference counted object interface.
+Implements common reference counting routines to control object life time.
+Use retain() to notify the object you are going to use it, thus sharing it's ownership. Use release() to release object reference when it is no longer needed. Use getRefCount() to obtain current reference count of the object.
+All objects are created with initial strong reference count of 1 and weak reference count of 1.
+When object reference count drops to 0, it's destroyed and deallocated automatically.
+All functions of this interface have thread safe implementations in SDK classes.
+
+
|
+ +pure virtualnoexcept | +
Get actual strong reference count.
+
+
|
+ +pure virtualnoexcept | +
Get actual weak reference count.
+
+
|
+ +pure virtualnoexcept | +
Decrease strong reference count.
+
+
|
+ +pure virtualnoexcept | +
Decrease weak reference count.
+
+
|
+ +pure virtualnoexcept | +
Increase strong reference count.
+
+
|
+ +pure virtualnoexcept | +
Increase strong reference count thread safely.
+
+
|
+ +pure virtualnoexcept | +
Increase weak reference count.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IResultBatch< T >, including all inherited members.
+getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getResults(size_t index=0) const =0 (defined in fsdk::IResultBatch< T >) | fsdk::IResultBatch< T > | pure virtual |
getSize() const =0 (defined in fsdk::IResultBatch< T >) | fsdk::IResultBatch< T > | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Member Functions | |
+virtual Span< T > | getResults (size_t index=0) const =0 |
+virtual size_t | getSize () const =0 |
![]() | |
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... | |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISerializableObject, including all inherited members.
+Default enum value | fsdk::ISerializableObject | |
Error enum name | fsdk::ISerializableObject | |
Flags enum name | fsdk::ISerializableObject | |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getSize(Sizer &sizer, uint32_t flags=Default) const noexcept=0 | fsdk::ISerializableObject | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
load(IArchive *archive, uint32_t flags=Default)=0 | fsdk::ISerializableObject | pure virtual |
NoSignature enum value | fsdk::ISerializableObject | |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
save(IArchive *archive, uint32_t flags=Default) const =0 | fsdk::ISerializableObject | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Serializable object interface. + More...
+ +#include <IObject.h>
+Public Types | |
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 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... | |
![]() | |
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... | |
Serializable object interface.
+Provides common functions for all serializable objects.
+
+
|
+ +strong | +
enum fsdk::ISerializableObject::Flags | +
Serialization flags.
+These flags control advanced options and should not be set to anything else from Default in normal conditions.
+ +Enumerator | |
---|---|
Default |
+ Default serialization mode. + |
NoSignature |
+ Omit object signature. +Helps to save space if there are several objects of the same type coming in a stream or where type is known for sure. +
|
+
|
+ +pure virtualnoexcept | +
Estimate size of this object binary data.
+[in,out] | sizer | sizer object to append result to. |
[in] | flags | [optional] serialization flags |
+
|
+ +pure virtual | +
Load object from archive.
+[in] | archive | archive to read from. |
[in] | flags | [optional] serialization flags |
+
|
+ +pure virtual | +
Save object to archive.
+[in] | archive | archive to write to. |
[in] | flags | [optional] serialization flags |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider, including all inherited members.
+clear() noexcept=0 | fsdk::ISettingsProvider | pure virtual |
Error enum name | fsdk::ISettingsProvider | |
getDefaultPath() const noexcept=0 | fsdk::ISettingsProvider | pure virtual |
getDesc(const Key &key) const noexcept | fsdk::ISettingsProvider | |
getDesc(const char *section, const char *parameter) const noexcept | fsdk::ISettingsProvider | |
getEntry(const Key &key) const noexcept=0 | fsdk::ISettingsProvider | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getValue(const Key &key) const noexcept | fsdk::ISettingsProvider | |
getValue(const char *section, const char *parameter) const noexcept | fsdk::ISettingsProvider | |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
isEmpty() const noexcept=0 | fsdk::ISettingsProvider | pure virtual |
load(const char *path) noexcept=0 | fsdk::ISettingsProvider | pure virtual |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
save(const char *path) const noexcept=0 | fsdk::ISettingsProvider | pure virtual |
setDesc(const Key &key, const Desc &desc) noexcept=0 | fsdk::ISettingsProvider | pure virtual |
setDesc(const char *section, const char *parameter, const Desc &desc) noexcept | fsdk::ISettingsProvider | |
setEntry(const Key &key, Entry &&entry) noexcept=0 | fsdk::ISettingsProvider | pure virtual |
setEntry(const Key &key, const Desc &desc, Value &&value) noexcept | fsdk::ISettingsProvider | |
setEntry(const char *section, const char *parameter, const Desc &desc, Value &&value) noexcept | fsdk::ISettingsProvider | |
setValue(const Key &key, Value &&value) noexcept=0 | fsdk::ISettingsProvider | pure virtual |
setValue(const char *section, const char *parameter, Value &&value) noexcept | fsdk::ISettingsProvider |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
SDK settings provider interface. + More...
+ +#include <ISettingsProvider.h>
+Classes | |
struct | Desc |
Configuration parameter description. More... | |
struct | Entry |
Configuration parameter entry. More... | |
struct | Key |
Configuration parameter key. More... | |
struct | Value |
Configuration parameter value. More... | |
+Public Types | |
enum | Error : uint32_t { + Error::Ok, +Error::IOError, +Error::Memory, +Error::Internal, + + Error::InvalidPi, +Error::InvalidTag, +Error::InvalidCdata, +Error::FileNotFound, + + Error::InvalidPcdata, +Error::InvalidDocType, +Error::InvalidSettings, +Error::InvalidComment, + + Error::InvalidAttribute, +Error::InvalidEndElement, +Error::AppendInvalidRoot, +Error::NoDocumentElement, + + Error::EndElementMismatch, +Error::InvalidStartElement, +Error::MemoryAllocationFailed + + } |
Config parsing error codes. More... | |
+Public Member Functions | |
virtual const char * | getDefaultPath () const noexcept=0 |
Get settings path this provider is bound to. More... | |
virtual Result< Error > | load (const char *path) noexcept=0 |
Load settings from given path. More... | |
virtual bool | save (const char *path) const noexcept=0 |
Save settings values using the default path. More... | |
virtual void | clear () noexcept=0 |
Clear settings. More... | |
virtual bool | isEmpty () const noexcept=0 |
virtual void | setDesc (const Key &key, const Desc &desc) noexcept=0 |
Set parameter description. More... | |
void | setDesc (const char *section, const char *parameter, const Desc &desc) noexcept |
Set parameter description. More... | |
virtual void | setValue (const Key &key, Value &&value) noexcept=0 |
Set parameter value. More... | |
void | setValue (const char *section, const char *parameter, Value &&value) noexcept |
Set parameter value. More... | |
virtual void | setEntry (const Key &key, Entry &&entry) noexcept=0 |
Set parameter. More... | |
void | setEntry (const Key &key, const Desc &desc, Value &&value) noexcept |
Set parameter. More... | |
void | setEntry (const char *section, const char *parameter, const Desc &desc, Value &&value) noexcept |
Set parameter. More... | |
virtual const Entry & | getEntry (const Key &key) const noexcept=0 |
Find parameter entry. More... | |
Desc | getDesc (const Key &key) const noexcept |
Get parameter description. More... | |
Desc | getDesc (const char *section, const char *parameter) const noexcept |
Get parameter description. More... | |
const Value & | getValue (const Key &key) const noexcept |
Get parameter value. More... | |
const Value & | getValue (const char *section, const char *parameter) const noexcept |
Get parameter value. More... | |
![]() | |
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... | |
SDK settings provider interface.
+Takes care of loading and parsing of SDK configuration files.
+
+
|
+ +strong | +
Config parsing error codes.
+Enumerator | |
---|---|
Ok |
+ No error. + |
IOError |
+ Error reading from file/stream. + |
Memory |
+ Could not allocate memory. + |
Internal |
+ Internal error occurred. + |
InvalidPi |
+ Parsing error occurred while parsing document declaration/processing instruction. + |
InvalidTag |
+ Parser could not determine tag type. + |
InvalidCdata |
+ Parsing error occurred while parsing CDATA section. + |
FileNotFound |
+ File was not found during load_file() + |
InvalidPcdata |
+ Parsing error occurred while parsing PCDATA section. + |
InvalidDocType |
+ Parsing error occurred while parsing document type declaration. + |
InvalidSettings |
+ Settings section is invalid or absent. + |
InvalidComment |
+ Parsing error occurred while parsing comment. + |
InvalidAttribute |
+ Parsing error occurred while parsing element attribute. + |
InvalidEndElement |
+ Parsing error occurred while parsing end element tag. + |
AppendInvalidRoot |
+ Unable to append nodes since root type is not node_element or node_document (exclusive to xml_node::append_buffer) + |
NoDocumentElement |
+ Parsing resulted in a document without element nodes. + |
EndElementMismatch |
+ There was a mismatch of start-end tags (closing tag had incorrect name, some tag was not closed or there was an excessive closing tag) + |
InvalidStartElement |
+ Parsing error occurred while parsing start element tag. + |
MemoryAllocationFailed |
+ memory allocation failed for internal data + |
+
|
+ +pure virtualnoexcept | +
Clear settings.
+
+
|
+ +pure virtualnoexcept | +
Get settings path this provider is bound to.
+This is the same path that was given to load().
+
+
|
+ +noexcept | +
Get parameter description.
+Lookup parameter by key. Return empty description if the parameters does not exist.
+key | parameter key. |
+
|
+ +noexcept | +
Get parameter description.
+Lookup parameter by key. Return empty description if the parameters does not exist.
+section | parameter section. |
parameter | parameter name. |
+
|
+ +pure virtualnoexcept | +
Find parameter entry.
+Lookup parameter by key. Return empty entry if the parameters does not exist.
+key | parameter key. |
+
|
+ +noexcept | +
Get parameter value.
+Lookup parameter by key. Return empty value if the parameters does not exist.
+key | parameter key. |
+
|
+ +noexcept | +
Get parameter value.
+Lookup parameter by key. Return empty value if the parameters does not exist.
+section | parameter section. |
parameter | parameter name. |
+
|
+ +pure virtualnoexcept | +
Check if there are loaded settings.
+
+
|
+ +pure virtualnoexcept | +
Load settings from given path.
+if path
is null, load from the default path;
+
|
+ +pure virtualnoexcept | +
Save settings values using the default path.
+path may be null, in this case a path from getDefaultPath() will be used.
+
+
|
+ +pure virtualnoexcept | +
Set parameter description.
+Lookup parameter by key. Creates a parameter if it does not already exist.
+key | parameter key. |
desc | parameter description. |
+
|
+ +noexcept | +
Set parameter description.
+Lookup parameter by key. Creates a parameter if it does not already exist.
+section | parameter section. |
parameter | parameter name. |
desc | parameter description. |
+
|
+ +pure virtualnoexcept | +
Set parameter.
+Lookup parameter by key. Creates a parameter if it does not already exist.
+key | parameter key. |
entry | parameter entry. |
+
|
+ +noexcept | +
Set parameter.
+Lookup parameter by key. Creates a parameter if it does not already exist.
+key | parameter key. |
desc | parameter description. |
value | parameter value. |
+
|
+ +noexcept | +
Set parameter.
+Lookup parameter by key. Creates a parameter if it does not already exist.
+section | parameter section. |
parameter | parameter name. |
desc | parameter description. |
value | parameter value. |
+
|
+ +pure virtualnoexcept | +
Set parameter value.
+Lookup parameter by key. Creates a parameter if it does not already exist.
+key | parameter key. |
value | parameter value. |
+
|
+ +noexcept | +
Set parameter value.
+Lookup parameter by key. Creates a parameter if it does not already exist.
+section | parameter section. |
parameter | parameter name. |
value | parameter value. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Desc, including all inherited members.
+Desc() noexcept | fsdk::ISettingsProvider::Desc | |
Desc(const char *desc) noexcept | fsdk::ISettingsProvider::Desc | |
getDesc() const noexcept | fsdk::ISettingsProvider::Desc | |
m_bufferLength (defined in fsdk::ISettingsProvider::Desc) | fsdk::ISettingsProvider::Desc | protectedstatic |
m_desc | fsdk::ISettingsProvider::Desc | protected |
setDesc(const char *desc) noexcept | fsdk::ISettingsProvider::Desc |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Configuration parameter description. + More...
+ +#include <ISettingsProvider.h>
+Public Member Functions | |
+ | Desc () noexcept |
Initialize an empty description. | |
Desc (const char *desc) noexcept | |
Initialize a description. More... | |
const char * | getDesc () const noexcept |
Get description text. More... | |
void | setDesc (const char *desc) noexcept |
Set description text. More... | |
+Protected Attributes | |
+char | m_desc [m_bufferLength] |
Parameter description text. | |
+Static Protected Attributes | |
+static const unsigned int | m_bufferLength = 256 |
Configuration parameter description.
+
+
|
+ +noexcept | +
Initialize a description.
+desc | description text. |
+
|
+ +noexcept | +
Get description text.
+
+
|
+ +noexcept | +
Set description text.
+desc | description text. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Entry, including all inherited members.
+Entry() noexcept=default | fsdk::ISettingsProvider::Entry | |
Entry(Entry &&right) (defined in fsdk::ISettingsProvider::Entry) | fsdk::ISettingsProvider::Entry | |
Entry(const Desc &desc, Value &&value) noexcept | fsdk::ISettingsProvider::Entry | |
getDesc() const noexcept | fsdk::ISettingsProvider::Entry | |
getValue() const noexcept | fsdk::ISettingsProvider::Entry | |
m_desc | fsdk::ISettingsProvider::Entry | |
m_value | fsdk::ISettingsProvider::Entry | |
operator=(Entry &&right) (defined in fsdk::ISettingsProvider::Entry) | fsdk::ISettingsProvider::Entry | |
setDesc(const Desc &desc) noexcept | fsdk::ISettingsProvider::Entry | |
setValue(Value &&value) noexcept | fsdk::ISettingsProvider::Entry | |
swap(Entry &first, Entry &second) (defined in fsdk::ISettingsProvider::Entry) | fsdk::ISettingsProvider::Entry |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Configuration parameter entry. + More...
+ +#include <ISettingsProvider.h>
+Public Member Functions | |
+ | Entry () noexcept=default |
Initialize an empty entry. | |
+ | Entry (Entry &&right) |
+Entry & | operator= (Entry &&right) |
+void | swap (Entry &first, Entry &second) |
Entry (const Desc &desc, Value &&value) noexcept | |
Initialize an entry. More... | |
void | setDesc (const Desc &desc) noexcept |
Set description. More... | |
void | setValue (Value &&value) noexcept |
Set value. More... | |
const Desc & | getDesc () const noexcept |
Get description. More... | |
const Value & | getValue () const noexcept |
Get value. More... | |
+Public Attributes | |
+Value | m_value |
Parameter value. | |
+Desc | m_desc |
Parameter description. | |
Configuration parameter entry.
+
+
|
+ +noexcept | +
Initialize an entry.
+desc | description. |
value | value. |
+
|
+ +noexcept | +
Get description.
+
+
|
+ +noexcept | +
Get value.
+
+
|
+ +noexcept | +
Set description.
+desc | description. |
+
|
+ +noexcept | +
Set value.
+value | value. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Key, including all inherited members.
+getParameter() const noexcept | fsdk::ISettingsProvider::Key | |
getSection() const noexcept | fsdk::ISettingsProvider::Key | |
Key() noexcept | fsdk::ISettingsProvider::Key | |
Key(const char *section, const char *parameter) noexcept | fsdk::ISettingsProvider::Key | |
m_bufferLength (defined in fsdk::ISettingsProvider::Key) | fsdk::ISettingsProvider::Key | protectedstatic |
m_parameter | fsdk::ISettingsProvider::Key | protected |
m_section | fsdk::ISettingsProvider::Key | protected |
operator<(const ISettingsProvider::Key &other) const noexcept | fsdk::ISettingsProvider::Key | |
setParameter(const char *parameter) noexcept | fsdk::ISettingsProvider::Key | |
setSection(const char *section) noexcept | fsdk::ISettingsProvider::Key |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Configuration parameter key. + More...
+ +#include <ISettingsProvider.h>
+Public Member Functions | |
+ | Key () noexcept |
Initialize an empty key. | |
Key (const char *section, const char *parameter) noexcept | |
Initialize a key. More... | |
const char * | getSection () const noexcept |
Get section name. More... | |
const char * | getParameter () const noexcept |
Get parameter name. More... | |
void | setSection (const char *section) noexcept |
Set section name. More... | |
void | setParameter (const char *parameter) noexcept |
Set parameter name. More... | |
bool | operator< (const ISettingsProvider::Key &other) const noexcept |
Operator Less . More... | |
+Protected Attributes | |
+char | m_section [m_bufferLength] |
Config section name. | |
+char | m_parameter [m_bufferLength] |
Config parameter name. | |
+Static Protected Attributes | |
+static const unsigned int | m_bufferLength = 128 |
Configuration parameter key.
+
+
|
+ +noexcept | +
Initialize a key.
+section | section name. |
parameter | parameter name. |
+
|
+ +noexcept | +
Get parameter name.
+
+
|
+ +noexcept | +
Get section name.
+
+
|
+ +noexcept | +
Operator Less
.
other | other key. |
+
|
+ +noexcept | +
Set parameter name.
+parameter | parameter name. |
+
|
+ +noexcept | +
Set section name.
+section | section name. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value, including all inherited members.
+asBool(bool defaultValue=false) const noexcept | fsdk::ISettingsProvider::Value | |
asFloat(float defaultValue=0.f) const noexcept | fsdk::ISettingsProvider::Value | |
asInt(int defaultValue=0) const noexcept | fsdk::ISettingsProvider::Value | |
asPoint2f(const Point2f &defaultValue=Point2f()) const noexcept | fsdk::ISettingsProvider::Value | |
asPoint2i(const Point2i &defaultValue=Point2i()) const noexcept | fsdk::ISettingsProvider::Value | |
asRect(const Rect &defaultValue=Rect()) const noexcept | fsdk::ISettingsProvider::Value | |
asSize(const Size &defaultValue=Size()) const noexcept | fsdk::ISettingsProvider::Value | |
asString(const char *defaultValue="") const noexcept | fsdk::ISettingsProvider::Value | |
Float1 enum value | fsdk::ISettingsProvider::Value | |
Float2 enum value | fsdk::ISettingsProvider::Value | |
Float3 enum value | fsdk::ISettingsProvider::Value | |
Float4 enum value | fsdk::ISettingsProvider::Value | |
getBool(bool *x) const noexcept | fsdk::ISettingsProvider::Value | |
getFloat(float *x) const noexcept | fsdk::ISettingsProvider::Value | |
getFloat(float *x, float *y) const noexcept | fsdk::ISettingsProvider::Value | |
getFloat(float *x, float *y, float *z) const noexcept | fsdk::ISettingsProvider::Value | |
getFloat(float *x, float *y, float *z, float *w) const noexcept | fsdk::ISettingsProvider::Value | |
getInt(int *x) const noexcept | fsdk::ISettingsProvider::Value | |
getInt(int *x, int *y) const noexcept | fsdk::ISettingsProvider::Value | |
getInt(int *x, int *y, int *z) const noexcept | fsdk::ISettingsProvider::Value | |
getInt(int *x, int *y, int *z, int *w) const noexcept | fsdk::ISettingsProvider::Value | |
getPoint2f(Point2f *point) const noexcept | fsdk::ISettingsProvider::Value | |
getPoint2i(Point2i *point) const noexcept | fsdk::ISettingsProvider::Value | |
getRect(Rect *rect) const noexcept | fsdk::ISettingsProvider::Value | |
getSize(Size *size) const noexcept | fsdk::ISettingsProvider::Value | |
getString(char *string) const noexcept | fsdk::ISettingsProvider::Value | |
Int1 enum value | fsdk::ISettingsProvider::Value | |
Int2 enum value | fsdk::ISettingsProvider::Value | |
Int3 enum value | fsdk::ISettingsProvider::Value | |
Int4 enum value | fsdk::ISettingsProvider::Value | |
is(Type type) const noexcept | fsdk::ISettingsProvider::Value | |
m_data | fsdk::ISettingsProvider::Value | |
m_type | fsdk::ISettingsProvider::Value | |
operator bool() const noexcept | fsdk::ISettingsProvider::Value | |
operator=(const Value &other)=delete (defined in fsdk::ISettingsProvider::Value) | fsdk::ISettingsProvider::Value | inline |
operator=(Value &&other) (defined in fsdk::ISettingsProvider::Value) | fsdk::ISettingsProvider::Value | |
setBool(bool x) noexcept | fsdk::ISettingsProvider::Value | |
setFloat(float x) noexcept | fsdk::ISettingsProvider::Value | |
setFloat(float x, float y) noexcept | fsdk::ISettingsProvider::Value | |
setFloat(float x, float y, float z) noexcept | fsdk::ISettingsProvider::Value | |
setFloat(float x, float y, float z, float w) noexcept | fsdk::ISettingsProvider::Value | |
setInt(int x) noexcept | fsdk::ISettingsProvider::Value | |
setInt(int x, int y) noexcept | fsdk::ISettingsProvider::Value | |
setInt(int x, int y, int z) noexcept | fsdk::ISettingsProvider::Value | |
setInt(int x, int y, int z, int w) noexcept | fsdk::ISettingsProvider::Value | |
setPoint2f(const Point2f &point) noexcept | fsdk::ISettingsProvider::Value | |
setPoint2i(const Point2i &point) noexcept | fsdk::ISettingsProvider::Value | |
setRect(const Rect &rect) noexcept | fsdk::ISettingsProvider::Value | |
setSize(const Size &size) noexcept | fsdk::ISettingsProvider::Value | |
setString(const char *string) noexcept | fsdk::ISettingsProvider::Value | |
String enum value | fsdk::ISettingsProvider::Value | |
swap(Value &first, Value &second) (defined in fsdk::ISettingsProvider::Value) | fsdk::ISettingsProvider::Value | |
Type enum name | fsdk::ISettingsProvider::Value | |
Undefined enum value | fsdk::ISettingsProvider::Value | |
Value() noexcept | fsdk::ISettingsProvider::Value | |
Value(int x) noexcept | fsdk::ISettingsProvider::Value | |
Value(int x, int y) noexcept | fsdk::ISettingsProvider::Value | |
Value(int x, int y, int z) noexcept | fsdk::ISettingsProvider::Value | |
Value(int x, int y, int z, int w) noexcept | fsdk::ISettingsProvider::Value | |
Value(float x) noexcept | fsdk::ISettingsProvider::Value | |
Value(float x, float y) noexcept | fsdk::ISettingsProvider::Value | |
Value(float x, float y, float z) noexcept | fsdk::ISettingsProvider::Value | |
Value(float x, float y, float z, float w) noexcept | fsdk::ISettingsProvider::Value | |
Value(const char *string) noexcept | fsdk::ISettingsProvider::Value | |
Value(const Rect &rect) noexcept | fsdk::ISettingsProvider::Value | |
Value(const Size &size) noexcept | fsdk::ISettingsProvider::Value | |
Value(const Point2f &point) noexcept | fsdk::ISettingsProvider::Value | |
Value(bool x) noexcept | fsdk::ISettingsProvider::Value | |
Value(const Value &other)=delete (defined in fsdk::ISettingsProvider::Value) | fsdk::ISettingsProvider::Value | inline |
Value(Value &&other) (defined in fsdk::ISettingsProvider::Value) | fsdk::ISettingsProvider::Value | |
~Value() (defined in fsdk::ISettingsProvider::Value) | fsdk::ISettingsProvider::Value |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Configuration parameter value. + More...
+ +#include <ISettingsProvider.h>
+Classes | |
union | Data |
Value data. More... | |
+Public Types | |
enum | Type { + Undefined, +Int1, +Int2, +Int3, + + Int4, +Float1, +Float2, +Float3, + + Float4, +String + + } |
Value type. More... | |
+Public Member Functions | |
Value () noexcept | |
Initialize an empty value. More... | |
Value (int x) noexcept | |
Initialize an integer value. More... | |
Value (int x, int y) noexcept | |
Initialize a 2d integer value. More... | |
Value (int x, int y, int z) noexcept | |
Initialize a 3d integer value. More... | |
Value (int x, int y, int z, int w) noexcept | |
Initialize a 4d integer value. More... | |
Value (float x) noexcept | |
Initialize a float value. More... | |
Value (float x, float y) noexcept | |
Initialize a 2d float value. More... | |
Value (float x, float y, float z) noexcept | |
Initialize a 3d float value. More... | |
Value (float x, float y, float z, float w) noexcept | |
Initialize a 4d float value. More... | |
Value (const char *string) noexcept | |
Initialize a string value. More... | |
Value (const Rect &rect) noexcept | |
Initialize a rect value. More... | |
Value (const Size &size) noexcept | |
Initialize a size value. More... | |
Value (const Point2f &point) noexcept | |
Initialize a point value. More... | |
Value (bool x) noexcept | |
Initialize a bool value. More... | |
operator bool () const noexcept | |
Check if value type is not Undefined . More... | |
bool | is (Type type) const noexcept |
Check if value type is of concrete type. More... | |
bool | setString (const char *string) noexcept |
Set a string value. More... | |
bool | getString (char *string) const noexcept |
Get a string value. More... | |
void | setRect (const Rect &rect) noexcept |
Set a rect value. More... | |
bool | getRect (Rect *rect) const noexcept |
Get a rect value. More... | |
void | setSize (const Size &size) noexcept |
Set a size value. More... | |
bool | getSize (Size *size) const noexcept |
Get a size value. More... | |
void | setPoint2i (const Point2i &point) noexcept |
Set a Point2i value. More... | |
bool | getPoint2i (Point2i *point) const noexcept |
Get a Point2i value. More... | |
void | setPoint2f (const Point2f &point) noexcept |
Set a setPoint2f value. More... | |
bool | getPoint2f (Point2f *point) const noexcept |
Get a Point2f value. More... | |
void | setBool (bool x) noexcept |
Set a bool value. More... | |
bool | getBool (bool *x) const noexcept |
Get a bool value. More... | |
void | setInt (int x) noexcept |
Set an int value. More... | |
bool | getInt (int *x) const noexcept |
Get an int value. More... | |
void | setInt (int x, int y) noexcept |
Set a 2d int value. More... | |
bool | getInt (int *x, int *y) const noexcept |
Get a 2d int value. More... | |
void | setInt (int x, int y, int z) noexcept |
Set a 3d int value. More... | |
bool | getInt (int *x, int *y, int *z) const noexcept |
Get a 3d int value. More... | |
void | setInt (int x, int y, int z, int w) noexcept |
Set a 4d int value. More... | |
bool | getInt (int *x, int *y, int *z, int *w) const noexcept |
Get a 4d int value. More... | |
void | setFloat (float x) noexcept |
Set a float value. More... | |
bool | getFloat (float *x) const noexcept |
Get a float value. More... | |
void | setFloat (float x, float y) noexcept |
Set a 2d float value. More... | |
bool | getFloat (float *x, float *y) const noexcept |
Get a 2d float value. More... | |
void | setFloat (float x, float y, float z) noexcept |
Set a 3d float value. More... | |
bool | getFloat (float *x, float *y, float *z) const noexcept |
Get a 3d float value. More... | |
void | setFloat (float x, float y, float z, float w) noexcept |
Set a 4d float value. More... | |
bool | getFloat (float *x, float *y, float *z, float *w) const noexcept |
Get a 4d float value. More... | |
float | asFloat (float defaultValue=0.f) const noexcept |
Safely get a float. More... | |
Point2f | asPoint2f (const Point2f &defaultValue=Point2f()) const noexcept |
Safely get a Point2f. More... | |
bool | asBool (bool defaultValue=false) const noexcept |
Safely get a boolean. More... | |
int | asInt (int defaultValue=0) const noexcept |
Safely get an integer. More... | |
Size | asSize (const Size &defaultValue=Size()) const noexcept |
Safely get a Size. More... | |
Point2i | asPoint2i (const Point2i &defaultValue=Point2i()) const noexcept |
Safely get a Point2i. More... | |
Rect | asRect (const Rect &defaultValue=Rect()) const noexcept |
Safely get a Rect. More... | |
const char * | asString (const char *defaultValue="") const noexcept |
Safely get a string. More... | |
+ | Value (const Value &other)=delete |
+ | Value (Value &&other) |
+Value & | operator= (const Value &other)=delete |
+Value & | operator= (Value &&other) |
+void | swap (Value &first, Value &second) |
+Public Attributes | |
+union +fsdk::ISettingsProvider::Value::Data | m_data |
Data storage. | |
+enum +fsdk::ISettingsProvider::Value::Type | m_type |
Data type.. | |
Configuration parameter value.
+enum fsdk::ISettingsProvider::Value::Type | +
Value type.
+Enumerator | |
---|---|
Undefined |
+ Unkown value type. + |
Int1 |
+ Integer. + |
Int2 |
+ 2D integer. + |
Int3 |
+ 3D integer. + |
Int4 |
+ 4D integer. + |
Float1 |
+ floating point. + |
Float2 |
+ 2D floating point. + |
Float3 |
+ 3D floating point. + |
Float4 |
+ 4D floating point. + |
String |
+ Short string. + |
+
|
+ +noexcept | +
Initialize an empty value.
+Value type will be set to Undefined
.
+
|
+ +noexcept | +
Initialize an integer value.
+x | integer value. |
+
|
+ +noexcept | +
Initialize a 2d integer value.
+x | 1st value. |
y | 2nd value. |
+
|
+ +noexcept | +
Initialize a 3d integer value.
+x | 1st value. |
y | 2nd value. |
z | 3rd value. |
+
|
+ +noexcept | +
Initialize a 4d integer value.
+x | 1st value. |
y | 2nd value. |
z | 3rd value. |
w | 4th value. |
+
|
+ +noexcept | +
Initialize a float value.
+x | float value. |
+
|
+ +noexcept | +
Initialize a 2d float value.
+x | 1st value. |
y | 2nd value. |
+
|
+ +noexcept | +
Initialize a 3d float value.
+x | 1st value. |
y | 2nd value. |
z | 3rd value. |
+
|
+ +noexcept | +
Initialize a 4d float value.
+x | 1st value. |
y | 2nd value. |
z | 3rd value. |
w | 4th value. |
+
|
+ +noexcept | +
Initialize a string value.
+string | string value. |
+
|
+ +noexcept | +
Initialize a rect value.
+rect | rect value. |
+
|
+ +noexcept | +
Initialize a size value.
+size | size value. |
+
|
+ +noexcept | +
Initialize a point value.
+point | point value. |
+
|
+ +noexcept | +
Initialize a bool value.
+x | bool value. |
+
|
+ +noexcept | +
Safely get a boolean.
+If actual value type is convertible to bool, the value is returned; if not a fallback value is returned.
+defaultValue | fallback value (optional). |
+
|
+ +noexcept | +
Safely get a float.
+If actual value type is float, the value is returned; if not a fallback value is returned.
+defaultValue | fallback value (optional). |
+
|
+ +noexcept | +
Safely get an integer.
+If actual value type is Int, the value is returned; if not a fallback value is returned.
+defaultValue | fallback value (optional). |
+
|
+ +noexcept | +
Safely get a Point2f.
+If actual value type is convertible to Point2f, the value is returned; if not a fallback value is returned.
+defaultValue | fallback value (optional). |
+
|
+ +noexcept | +
Safely get a Point2i.
+If actual value type is convertible to Point2i, the value is returned; if not a fallback value is returned.
+defaultValue | fallback value (optional). |
+
|
+ +noexcept | +
Safely get a Rect.
+If actual value type is convertible to Rect, the value is returned; if not a fallback value is returned.
+defaultValue | fallback value (optional). |
+
|
+ +noexcept | +
Safely get a Size.
+If actual value type is convertible to Size, the value is returned; if not a fallback value is returned.
+defaultValue | fallback value (optional). |
+
|
+ +noexcept | +
Safely get a string.
+If actual value type is String, the value is returned; if not a fallback value is returned.
+defaultValue | fallback value (optional). |
+
|
+ +noexcept | +
Get a bool value.
+[out] | x | the value. |
x
isn't modified.
+
|
+ +noexcept | +
Get a float value.
+[out] | x | the value. |
+
|
+ +noexcept | +
Get a 2d float value.
+[out] | x | 1st value. |
[out] | y | 2nd value. |
+
|
+ +noexcept | +
Get a 3d float value.
+[out] | x | 1st value. |
[out] | y | 2nd value. |
[out] | z | 3rd value. |
+
|
+ +noexcept | +
Get a 4d float value.
+[out] | x | 1st value. |
[out] | y | 2nd value. |
[out] | z | 3rd value. |
[out] | w | 4th value. |
+
|
+ +noexcept | +
Get an int value.
+[out] | x | the value. |
x
isn't modified.
+
|
+ +noexcept | +
Get a 2d int value.
+[out] | x | 1st value. |
[out] | y | 2nd value. |
+
|
+ +noexcept | +
Get a 3d int value.
+[out] | x | 1st value. |
[out] | y | 2nd value. |
[out] | z | 3rd value. |
+
|
+ +noexcept | +
Get a 4d int value.
+[out] | x | 1st value. |
[out] | y | 2nd value. |
[out] | z | 3rd value. |
[out] | w | 4th value. |
+
|
+ +noexcept | +
Get a Point2f value.
+[out] | point | the value. |
point
isn't modified.
+
|
+ +noexcept | +
Get a Point2i value.
+[out] | point | the value. |
point
isn't modified.
+
|
+ +noexcept | +
Get a rect value.
+[out] | rect | the value. |
rect
isn't modified.
+
|
+ +noexcept | +
Get a size value.
+[out] | size | the value. |
size
isn't modified.
+
|
+ +noexcept | +
Get a string value.
+[out] | string | the value. |
string
isn't modified.
+
|
+ +noexcept | +
Check if value type is of concrete type.
+type | type to check. |
type
.
+
|
+ +noexcept | +
Check if value type is not Undefined
.
Undefined
.
+
|
+ +noexcept | +
Set a bool value.
+x | the value. |
+
|
+ +noexcept | +
Set a float value.
+x | the value. |
+
|
+ +noexcept | +
Set a 2d float value.
+x | 1st value. |
y | 2nd value. |
+
|
+ +noexcept | +
Set a 3d float value.
+x | 1st value. |
y | 2nd value. |
z | 3rd value. |
+
|
+ +noexcept | +
Set a 4d float value.
+x | 1st value. |
y | 2nd value. |
z | 3rd value. |
w | 4th value. |
+
|
+ +noexcept | +
Set an int value.
+x | the value. |
+
|
+ +noexcept | +
Set a 2d int value.
+x | 1st value. |
y | 2nd value. |
+
|
+ +noexcept | +
Set a 3d int value.
+x | 1st value. |
y | 2nd value. |
z | 3rd value. |
+
|
+ +noexcept | +
Set a 4d int value.
+x | 1st value. |
y | 2nd value. |
z | 3rd value. |
w | 4th value. |
+
|
+ +noexcept | +
Set a setPoint2f value.
+point | the value. |
+
|
+ +noexcept | +
Set a Point2i value.
+point | the value. |
+
|
+ +noexcept | +
Set a rect value.
+rect | the value. |
+
|
+ +noexcept | +
Set a size value.
+size | the value. |
+
|
+ +noexcept | +
Set a string value.
+string | the value. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::Float1, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::Float1) | fsdk::ISettingsProvider::Value::Data::Float1 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+float | m_value |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::Float2, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::Float2) | fsdk::ISettingsProvider::Value::Data::Float2 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+float | m_value [2] |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::Float3, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::Float3) | fsdk::ISettingsProvider::Value::Data::Float3 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+float | m_value [3] |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::Float4, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::Float4) | fsdk::ISettingsProvider::Value::Data::Float4 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+float | m_value [4] |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::Int1, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::Int1) | fsdk::ISettingsProvider::Value::Data::Int1 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+int | m_value |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::Int2, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::Int2) | fsdk::ISettingsProvider::Value::Data::Int2 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+int | m_value [2] |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::Int3, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::Int3) | fsdk::ISettingsProvider::Value::Data::Int3 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+int | m_value [3] |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::Int4, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::Int4) | fsdk::ISettingsProvider::Value::Data::Int4 |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+int | m_value [4] |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data::String, including all inherited members.
+m_value (defined in fsdk::ISettingsProvider::Value::Data::String) | fsdk::ISettingsProvider::Value::Data::String |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Attributes | |
+char * | m_value |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IStaticDescriptorStorage, including all inherited members.
+descriptorByIndex(const DescriptorId index, IDescriptor *descriptor) const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
getDescriptorVersion() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
size() const noexcept=0 | fsdk::IStaticDescriptorStorage | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Static descriptor storage interface. + More...
+ +#include <IIndex.h>
+Public Member Functions | |
virtual Result< FSDKError > | descriptorByIndex (const DescriptorId index, IDescriptor *descriptor) const noexcept=0 |
Requests descriptor data out of internal storage. More... | |
virtual uint32_t | getDescriptorVersion () const noexcept=0 |
Return version of stored descriptors. More... | |
virtual uint64_t | size () const noexcept=0 |
Return size of internal storage. More... | |
Static descriptor storage interface.
+You may think of it as read only access to some internal container.
+
+
|
+ +pure virtualnoexcept | +
Requests descriptor data out of internal storage.
+[in] | index | Identification value of some descriptor. Might be received either by using |
[out] | descriptor | Ptr to created descriptor object with correctly set version and length. Only changes data of passed descriptor. |
+
|
+ +pure virtualnoexcept | +
Return version of stored descriptors.
+
+
|
+ +pure virtualnoexcept | +
Return size of internal storage.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::IWarper, including all inherited members.
+createTransformation(const Detection &detection, const Landmarks5 &landmarks) const noexcept=0 | fsdk::IWarper | pure virtual |
getRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
getWeakRefCount() const noexcept=0 | fsdk::IRefCounted | pure virtual |
ImageBatch typedef | fsdk::IWarper | |
ImageBatchFuture typedef (defined in fsdk::IWarper) | fsdk::IWarper | |
release() noexcept=0 | fsdk::IRefCounted | pure virtual |
releaseWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
retain() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainLocked() noexcept=0 | fsdk::IRefCounted | pure virtual |
retainWeak() noexcept=0 | fsdk::IRefCounted | pure virtual |
unwarp(const EyesEstimation &eyesEstimationInWarpCoordinates, const Transformation &transformation, EyesEstimation &eyesEstimation) const noexcept=0 | fsdk::IWarper | pure virtual |
unwarp(const Landmarks5 &warpedLandmarks5, const Transformation &transformation, Landmarks5 &landmarks5) const noexcept=0 | fsdk::IWarper | pure virtual |
unwarp(const Landmarks68 &warpedLandmarks68, const Transformation &transformation, Landmarks68 &landmarks68) const noexcept=0 | fsdk::IWarper | pure virtual |
unwarp(const GazeEstimation &warpedAngles, const Transformation &transformation, GazeEstimation &angles) const noexcept=0 (defined in fsdk::IWarper) | fsdk::IWarper | pure virtual |
warp(const Image &image, const Transformation &transformation, Image &transformedImage) const noexcept=0 | fsdk::IWarper | pure virtual |
warp(Span< const Image > images, Span< const Transformation > transformations, Span< Image > transformedImages) const noexcept=0 | fsdk::IWarper | pure virtual |
warp(const Landmarks5 &landmarks, const Transformation &transformation, Landmarks5 &transformedLandmarks) const noexcept=0 | fsdk::IWarper | pure virtual |
warp(const Landmarks68 &landmarks68, const Transformation &transformation, Landmarks68 &transformedLandmarks68) const noexcept=0 | fsdk::IWarper | pure virtual |
warpAsync(Span< const Image > images, Span< const Transformation > transformations) const =0 | fsdk::IWarper | pure virtual |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Face detection area warper interface. + More...
+ +#include <IWarper.h>
+Public Types | |
+using | ImageBatch = std::vector< Image > |
Common aliases for IWarper asynchronous interface. | |
+using | ImageBatchFuture = vlc::future< ImageBatch > |
+Public Member Functions | |
virtual Transformation | createTransformation (const Detection &detection, const Landmarks5 &landmarks) const noexcept=0 |
Create transformation data struct. More... | |
virtual Result< FSDKError > | warp (const Image &image, const Transformation &transformation, Image &transformedImage) const noexcept=0 |
Warp image. More... | |
virtual Result< FSDKError > | warp (Span< const Image > images, Span< const Transformation > transformations, Span< Image > transformedImages) const noexcept=0 |
Warp faces on multiple images. More... | |
virtual Result< FSDKError > | warp (const Landmarks5 &landmarks, const Transformation &transformation, Landmarks5 &transformedLandmarks) const noexcept=0 |
Warp landmarks of size 5. More... | |
virtual Result< FSDKError > | warp (const Landmarks68 &landmarks68, const Transformation &transformation, Landmarks68 &transformedLandmarks68) const noexcept=0 |
Warp landmarks of size 68. More... | |
virtual Result< FSDKError > | unwarp (const EyesEstimation &eyesEstimationInWarpCoordinates, const Transformation &transformation, EyesEstimation &eyesEstimation) const noexcept=0 |
Warp irisLandmarks in EyesEstimation struct for both eyes. More... | |
virtual Result< FSDKError > | unwarp (const Landmarks5 &warpedLandmarks5, const Transformation &transformation, Landmarks5 &landmarks5) const noexcept=0 |
Warp landmarks of size 5 back to source image coordinates. More... | |
virtual Result< FSDKError > | unwarp (const Landmarks68 &warpedLandmarks68, const Transformation &transformation, Landmarks68 &landmarks68) const noexcept=0 |
Warp landmarks of size 68 back to source image coordinates. More... | |
+virtual Result< FSDKError > | unwarp (const GazeEstimation &warpedAngles, const Transformation &transformation, GazeEstimation &angles) const noexcept=0 |
virtual ImageBatchFuture | warpAsync (Span< const Image > images, Span< const Transformation > transformations) const =0 |
Asynchronously warp faces on multiple images. More... | |
![]() | |
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... | |
Face detection area warper interface.
+Perform affine transformations on an image to properly align depicted face for descriptor extraction.
+
+
|
+ +pure virtualnoexcept | +
Create transformation data struct.
+[in] | detection | detection coordinates in image space. |
[in] | landmarks | vector of landmarks to calculate warping angles. |
+
|
+ +pure virtualnoexcept | +
Warp irisLandmarks in EyesEstimation struct for both eyes.
+Warps from warped image coord. space to source image coordinates space, the one that was used to create transformation.
+[in] | eyesEstimationInWarpCoordinates | EyesEstimation straight out of EyeEstimator. Should be create from warpedImage, that was created with the same transformation object as the one passed. |
[in] | transformation | transformation data. |
[out] | eyesEstimation | eyes estimation with iris landmarks warped to source image coordinates space. |
+
|
+ +pure virtualnoexcept | +
Warp landmarks of size 5 back to source image coordinates.
+[in] | warpedLandmarks5 | warped landmarks array of size 5. |
[in] | transformation | transformation data. |
[out] | landmarks5 | landmarks of size 5 warped back to source image coordinates. |
+
|
+ +pure virtualnoexcept | +
Warp landmarks of size 68 back to source image coordinates.
+[in] | warpedLandmarks5 | warped landmarks array of size 68. |
[in] | transformation | transformation data. |
[out] | landmarks5 | landmarks of size 68 warped back to source image coordinates. |
+
|
+ +pure virtualnoexcept | +
Warp image.
+[in] | image | source image. |
[in] | transformation | transformation data. |
[out] | transformedImage | output transformed image. |
+
|
+ +pure virtualnoexcept | +
Warp faces on multiple images.
+[in] | images | span of source images. |
[in] | transformations | span of transformation structures. |
[in/out] | transformedImages span of output warped images. |
+
|
+ +pure virtualnoexcept | +
Warp landmarks of size 5.
+[in] | landmarks | landmarks array of size 5 |
[in] | transformation | transformation data. |
[out] | transformedLandmarks | output transformed landmarks. If transformation is created with detection, it's in the coordinates of transformed warped image, otherwise in the coordinates of detection. |
+
|
+ +pure virtualnoexcept | +
Warp landmarks of size 68.
+[in] | landmarks68 | landmarks to warp. |
[in] | transformation | transformation data. |
[out] | transformedLandmarks68 | output transformed landmarks of size 68. If transformation is created with detection, it's in the coordinates of transformed warped image, otherwise in the coordinates of detection. |
+
|
+ +pure virtual | +
Asynchronously warp faces on multiple images.
+[in] | images | span of source images. |
[in] | transformations | span of transformation structures. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Image, including all inherited members.
+allocate(int size) noexcept | fsdk::Image | protectedstatic |
clone() const noexcept | fsdk::Image | inline |
convert(Image &dest, int x, int y, int width, int height, Format format, TargetDevice device=TargetDevice::CPU) const noexcept | fsdk::Image | |
convert(Image &dest, const Point2i &origin, const Size &size, Format format, TargetDevice device=TargetDevice::CPU) const noexcept | fsdk::Image | inline |
convert(Image &dest, const Size &size, Format format, TargetDevice device=TargetDevice::CPU) const noexcept | fsdk::Image | inline |
convert(Image &dest, const Rect &rect, Format format, TargetDevice device=TargetDevice::CPU) const noexcept | fsdk::Image | inline |
convert(Image &dest, Format format, TargetDevice device=TargetDevice::CPU) const noexcept | fsdk::Image | inline |
create(int width, int height, Format format, bool cleanup=true, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept | fsdk::Image | |
create(int width, int height, Format format, const void *data, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept | fsdk::Image | |
create(int width, int height, Format format, void *data, bool copy, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept | fsdk::Image | |
create(const fsdk::Image &source, MemoryResidence residence, int deviceId=0) noexcept | fsdk::Image | |
deallocate(void *memory) noexcept | fsdk::Image | protectedstatic |
equalStrong(const fsdk::Image &other) noexcept | fsdk::Image | inline |
equalWeak(const fsdk::Image &other) noexcept | fsdk::Image | inline |
Error enum name | fsdk::Image | |
extract(int x, int y, int width, int height) const noexcept | fsdk::Image | |
extract(const Rect &rect) const noexcept | fsdk::Image | inline |
extract(const Size &size) const noexcept | fsdk::Image | inline |
extract(const Point2i &origin, const Size &size) const noexcept | fsdk::Image | inline |
getAspectRatio() const noexcept | fsdk::Image | inline |
getData() noexcept | fsdk::Image | inline |
getData() const noexcept | fsdk::Image | inline |
getDataAs() noexcept | fsdk::Image | inline |
getDataAs() const noexcept | fsdk::Image | inline |
getDataSize() const noexcept | fsdk::Image | |
getDataSize(Sizer &sizer) const noexcept | fsdk::Image | |
getDeviceId() const noexcept (defined in fsdk::Image) | fsdk::Image | inline |
getFormat() const noexcept | fsdk::Image | inline |
getHeight() const noexcept | fsdk::Image | inline |
getMemoryResidence() const noexcept (defined in fsdk::Image) | fsdk::Image | inline |
getRect() const noexcept | fsdk::Image | inline |
getRefCount() const noexcept | fsdk::Image | protected |
getRowSize() const noexcept | fsdk::Image | inline |
getScanLine(int y) noexcept | fsdk::Image | |
getScanLine(int y) const noexcept | fsdk::Image | |
getScanLineAs(int y) noexcept | fsdk::Image | inline |
getScanLineAs(int y) const noexcept | fsdk::Image | inline |
getSize() const noexcept | fsdk::Image | inline |
getWidth() const noexcept | fsdk::Image | inline |
guessTypeFromMemory(const void *data, const uint32_t sizeInBytes, Type &type) noexcept | fsdk::Image | static |
Image() noexcept | fsdk::Image | |
Image(int width, int height, Format format, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept | fsdk::Image | |
Image(int width, int height, Format format, const void *data, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept | fsdk::Image | |
Image(int width, int height, Format format, void *data, bool copy, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept | fsdk::Image | |
Image(const Image &other) noexcept | fsdk::Image | |
Image(Image &&other) noexcept | fsdk::Image | |
Image(const SubImage &subImage) noexcept | fsdk::Image | explicit |
ImageCompression enum name | fsdk::Image | |
isNull() const noexcept | fsdk::Image | inline |
isSharedWith(const Image &other) const noexcept | fsdk::Image | inline |
isValid() const noexcept | fsdk::Image | inline |
load(const char *path) noexcept | fsdk::Image | |
load(const char *path, const Format format) noexcept | fsdk::Image | |
loadFromMemory(const void *data, const uint32_t sizeInBytes) noexcept | fsdk::Image | |
loadFromMemory(const void *data, const uint32_t sizeInBytes, const Format format) noexcept | fsdk::Image | |
loadFromMemoryOfType(const void *data, const uint32_t sizeInBytes, const Type type) noexcept | fsdk::Image | |
loadFromMemoryOfType(const void *data, const uint32_t sizeInBytes, const Type type, const Format format) noexcept | fsdk::Image | |
m_data | fsdk::Image | protected |
m_deviceId | fsdk::Image | protected |
m_format | fsdk::Image | protected |
m_height | fsdk::Image | protected |
m_ref | fsdk::Image | protected |
m_residence (defined in fsdk::Image) | fsdk::Image | protected |
m_width | fsdk::Image | protected |
map(int x, int y, int width, int height) const noexcept | fsdk::Image | |
map(const Rect &rect) const noexcept | fsdk::Image | inline |
map(const Size &size) const noexcept | fsdk::Image | inline |
map(const Point2i &origin, const Size &size) const noexcept | fsdk::Image | inline |
MemoryResidence enum name | fsdk::Image | |
operator bool() const noexcept | fsdk::Image | inline |
operator=(const Image &other) noexcept | fsdk::Image | inline |
operator=(Image &&other) noexcept | fsdk::Image | inline |
ownsData() const noexcept | fsdk::Image | inline |
putPixel(uint32_t x, uint32_t y) noexcept (defined in fsdk::Image) | fsdk::Image | |
release() noexcept | fsdk::Image | protected |
rescale(float scale) const noexcept | fsdk::Image | |
reset() noexcept | fsdk::Image | inline |
retain() noexcept | fsdk::Image | protected |
save(const char *path, fsdk::Image::ImageCompression additionalFlag=fsdk::Image::ImageCompression::IC_NO_COMPRESSION) const noexcept | fsdk::Image | |
save(const char *path, const Format format) const noexcept | fsdk::Image | |
saveToMemory(Image::Type type, IArchive *archive, fsdk::Image::ImageCompression additionalFlag=fsdk::Image::ImageCompression::IC_NO_COMPRESSION) const noexcept | fsdk::Image | |
saveToMemory(Image::Type type, IArchive *archive, const Format format) const noexcept | fsdk::Image | |
set(int width, int height, Format format, const void *data, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept | fsdk::Image | |
set(int width, int height, Format format, void *data, bool copy, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept | fsdk::Image | |
set(const Image &other) noexcept | fsdk::Image | |
set(const SubImage &subImage) noexcept | fsdk::Image | |
swap(Image &other) noexcept | fsdk::Image | inline |
TargetDevice enum name | fsdk::Image | |
Type enum name | fsdk::Image | |
~Image() (defined in fsdk::Image) | fsdk::Image |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
#include <Image.h>
+Public Types | |
enum | Type : uint8_t { + BMP, +JPG, +PNG, +PPM, + + TIFF, +Unknown + + } |
Supported image types. | |
enum | TargetDevice { CPU, +GPU, +NPU + } |
Target device that fsdk::Image algorithms will be running on. | |
enum | ImageCompression { + ImageCompression::IC_NO_COMPRESSION, +ImageCompression::IC_SMALL_COMPRESSION, +ImageCompression::IC_MEDIUM_COMPRESSION, +ImageCompression::IC_HARD_COMPRESSION, + + ImageCompression::IC_BEST_COMPRESSION + + } |
Supported compression type is used only for jpg and png types. More... | |
enum | Error : uint32_t { + Error::Ok, +Error::InvalidWidth, +Error::InvalidHeight, +Error::InvalidDataPtr, + + Error::InvalidDataSize, +Error::InvalidImage, +Error::InvalidArchive, +Error::InvalidPath, + + Error::InvalidType, +Error::InvalidFormat, +Error::InvalidBitmap, +Error::InvalidMemory, + + Error::InvalidConversion, +Error::InvalidResidence, +Error::InvalidDevice, +Error::FailedToSave, + + Error::FailedToLoad, +Error::FailedToInitialize, +Error::ReleasedInOtherThread + + } |
Image error codes. More... | |
enum | MemoryResidence : uint32_t { MemoryResidence::MemoryCPU, +MemoryResidence::MemoryGPU, +MemoryResidence::MemoryNPU, +MemoryResidence::MemoryNPU_DPP + } |
Memory residence. More... | |
+Public Member Functions | |
+FSDK_API | Image () noexcept |
Initializes an empty image. | |
FSDK_API | Image (int width, int height, Format format, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept |
Initializes an empty image and preallocates storage buffer of given size. More... | |
FSDK_API | Image (int width, int height, Format format, const void *data, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept |
Initializes an empty image and preallocates storage buffer of given size. Fills image contents with provided data. More... | |
FSDK_API | Image (int width, int height, Format format, void *data, bool copy, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept |
Initializes an image. If copy is true, this allocates a new buffer of given size and fills image contents with provided data (copies it). If copy is false (which is default) this will just reference the provided data. More... | |
FSDK_API | Image (const Image &other) noexcept |
Initializes an image as a reference to an other image. More... | |
FSDK_API | Image (Image &&other) noexcept |
Initializes an image with contents of an other image. Source image is then invalidated. More... | |
FSDK_API | Image (const SubImage &subImage) noexcept |
Initializes an image with contents of a sub image. Since sub images do not handle data life time, image contents are always copied. More... | |
FSDK_API Result< Error > | create (int width, int height, Format format, bool cleanup=true, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept |
Initializes an empty image and preallocates storage buffer of given size. More... | |
FSDK_API Result< Error > | create (int width, int height, Format format, const void *data, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept |
Initializes an empty image and preallocates storage buffer of given size. Fills image contents with provided data. More... | |
FSDK_API Result< Error > | create (int width, int height, Format format, void *data, bool copy, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept |
Initializes an image. If copy is true, this allocates a new buffer of given size and fills image contents with provided data (copies it). If copy is false (which is default) this will just reference the provided data. More... | |
FSDK_API Result< Error > | create (const fsdk::Image &source, MemoryResidence residence, int deviceId=0) noexcept |
Creates image with given memory residence based on other image instance. If source image has another MemoryResidence or device id, all memory will be copied to the new residence. In the other case new instance will be just a reference for the source. More... | |
FSDK_API Result< Error > | set (int width, int height, Format format, const void *data, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept |
Initializes an image with provided data. If current image is not empty and it's size and format match the provided ones, no memory reallocation is performed. Otherwise image is re-created to match requirements. More... | |
FSDK_API Result< Error > | set (int width, int height, Format format, void *data, bool copy, MemoryResidence residence=MemoryResidence::MemoryCPU, int deviceId=0) noexcept |
Initializes an image with provided data. If copy is true and if current image is not empty and it's size and format match the provided ones, no memory reallocation is performed. Otherwise image is re-created to match requirements. If copy is false (which is default) this will just reference the provided data. More... | |
FSDK_API Result< Error > | set (const Image &other) noexcept |
Initializes an image as a reference to an other image. More... | |
FSDK_API Result< Error > | set (const SubImage &subImage) noexcept |
Initializes an image with contents of a sub image. Since sub images do not handle data life time, image contents are always copied. More... | |
FSDK_API SubImage | map (int x, int y, int width, int height) const noexcept |
Map image contents to a given area. More... | |
SubImage | map (const Rect &rect) const noexcept |
Map image contents to a given area. More... | |
SubImage | map (const Size &size) const noexcept |
Map image contents to a given area. More... | |
SubImage | map (const Point2i &origin, const Size &size) const noexcept |
Map image contents to a given area. More... | |
FSDK_API Image | extract (int x, int y, int width, int height) const noexcept |
Extract a sub image of this image. The new image will have it's own reference count. More... | |
Image | extract (const Rect &rect) const noexcept |
Extract a sub image of this image. The new image will have it's own reference count. More... | |
Image | extract (const Size &size) const noexcept |
Extract a sub image of this image. The new image will have it's own reference count. More... | |
Image | extract (const Point2i &origin, const Size &size) const noexcept |
Extract a sub image of this image. The new image will have it's own reference count. More... | |
Image | clone () const noexcept |
Create a copy of this image. The new image will have it's own reference count. More... | |
FSDK_API Result< Image::Error > | convert (Image &dest, int x, int y, int width, int height, Format format, TargetDevice device=TargetDevice::CPU) const noexcept |
Convert image format. More... | |
Result< Image::Error > | convert (Image &dest, const Point2i &origin, const Size &size, Format format, TargetDevice device=TargetDevice::CPU) const noexcept |
Convert image format. More... | |
Result< Image::Error > | convert (Image &dest, const Size &size, Format format, TargetDevice device=TargetDevice::CPU) const noexcept |
Convert image format. More... | |
Result< Image::Error > | convert (Image &dest, const Rect &rect, Format format, TargetDevice device=TargetDevice::CPU) const noexcept |
Convert image format. More... | |
Result< Image::Error > | convert (Image &dest, Format format, TargetDevice device=TargetDevice::CPU) const noexcept |
Convert image format. More... | |
FSDK_API Image | rescale (float scale) const noexcept |
Rescale image keeping proportions. More... | |
FSDK_API Result< Image::Error > | save (const char *path, fsdk::Image::ImageCompression additionalFlag=fsdk::Image::ImageCompression::IC_NO_COMPRESSION) const noexcept |
Save image. More... | |
FSDK_API Result< Error > | save (const char *path, const Format format) const noexcept |
Convert and Save image. More... | |
FSDK_API Result< Image::Error > | saveToMemory (Image::Type type, IArchive *archive, fsdk::Image::ImageCompression additionalFlag=fsdk::Image::ImageCompression::IC_NO_COMPRESSION) const noexcept |
Save image to memory buffer. More... | |
FSDK_API Result< Image::Error > | saveToMemory (Image::Type type, IArchive *archive, const Format format) const noexcept |
Convert and save image to memory buffer. More... | |
FSDK_API Result< Error > | load (const char *path) noexcept |
Load image from file. More... | |
FSDK_API Result< Error > | load (const char *path, const Format format) noexcept |
Load image from file and convert it to required format. More... | |
FSDK_API Result< Error > | loadFromMemory (const void *data, const uint32_t sizeInBytes) noexcept |
Load image from memory. More... | |
FSDK_API Result< Error > | loadFromMemory (const void *data, const uint32_t sizeInBytes, const Format format) noexcept |
Load image from memory and convert it to required format. More... | |
FSDK_API Result< Error > | loadFromMemoryOfType (const void *data, const uint32_t sizeInBytes, const Type type) noexcept |
Load image from memory of specific type. More... | |
FSDK_API Result< Error > | loadFromMemoryOfType (const void *data, const uint32_t sizeInBytes, const Type type, const Format format) noexcept |
Load image from memory of specific type and convert it to required format. More... | |
Image & | operator= (const Image &other) noexcept |
Assign other image. More... | |
Image & | operator= (Image &&other) noexcept |
Move other image. More... | |
bool | isNull () const noexcept |
bool | isValid () const noexcept |
operator bool () const noexcept | |
Implicit cast to boolean; results in true if image is valid, false if not. More... | |
FSDK_API void * | getScanLine (int y) noexcept |
Get image scanline data. More... | |
FSDK_API const void * | getScanLine (int y) const noexcept |
Get image scanline data. More... | |
FSDK_API int | getDataSize () const noexcept |
FSDK_API void | getDataSize (Sizer &sizer) const noexcept |
Get actual image size in bytes. More... | |
template<typename T > | |
T * | getScanLineAs (int y) noexcept |
Get image scanline data. More... | |
template<typename T > | |
const T * | getScanLineAs (int y) const noexcept |
Get image scanline data. More... | |
void * | getData () noexcept |
const void * | getData () const noexcept |
template<typename T > | |
T * | getDataAs () noexcept |
template<typename T > | |
const T * | getDataAs () const noexcept |
int | getRowSize () const noexcept |
int | getWidth () const noexcept |
int | getHeight () const noexcept |
float | getAspectRatio () const noexcept |
Format | getFormat () const noexcept |
+MemoryResidence | getMemoryResidence () const noexcept |
+int | getDeviceId () const noexcept |
Size | getSize () const noexcept |
Rect | getRect () const noexcept |
bool | ownsData () const noexcept |
bool | isSharedWith (const Image &other) const noexcept |
void | swap (Image &other) noexcept |
Swap contents with another image. More... | |
+void | reset () noexcept |
Reset image contents. | |
+bool | equalWeak (const fsdk::Image &other) noexcept |
Performs weak comparison of this image with other. Weak in this context means only image parameters should be equal i.e width, height, format and residence. Actual data pointer of two images might differ. | |
bool | equalStrong (const fsdk::Image &other) noexcept |
Performs strong comparison of this image with other. Beside weak comparison strong comparison also checks whether two images point to the same block of pixels. More... | |
+FSDK_API void | putPixel (uint32_t x, uint32_t y) noexcept |
+Static Public Member Functions | |
static FSDK_API Result< Error > | guessTypeFromMemory (const void *data, const uint32_t sizeInBytes, Type &type) noexcept |
Guess type of image written into memory. More... | |
+Protected Member Functions | |
FSDK_API int | retain () noexcept |
Increase reference count. More... | |
FSDK_API int | release () noexcept |
Decrease reference count. More... | |
FSDK_API int | getRefCount () const noexcept |
Obtain reference count. More... | |
+Static Protected Member Functions | |
static FSDK_API void * | allocate (int size) noexcept |
Allocate memory. More... | |
static FSDK_API void | deallocate (void *memory) noexcept |
Free memory. More... | |
+Protected Attributes | |
+void * | m_data |
raw image data. | |
+int * | m_ref |
reference counter. nullptr if image does not own data. | |
+int | m_height |
image height. | |
+int | m_width |
image width. | |
+int | m_deviceId |
id of the device where image memory is allocated | |
Format | m_format |
image format ( More... | |
+MemoryResidence | m_residence |
Image objects embed an implicit reference counter to automatically track consumers perform assignments without unnecessary reallocations in a thread-safe manner.
+Every time you assign or set an other image as the source of the current image, the current image data reference count is decreased, new data pointer is referenced, and it's counter is increased. When data reference count drops to zero, the data is deallocated.
+Image can also reference external data without an actual ownership. This way you can operate on your data buffer using methods of Image and still own it and cotrol it's life time.
+ +
+
|
+ +strong | +
Image error codes.
+Enumerator | |
---|---|
Ok |
+ Ok. + |
InvalidWidth |
+ Invalid width. + |
InvalidHeight |
+ Invalid height. + |
InvalidDataPtr |
+ Bad input data pointer. + |
InvalidDataSize |
+ Bad input data size. + |
InvalidImage |
+ Invalid image. + |
InvalidArchive |
+ Archive error. + |
InvalidPath |
+ Bad path for saving / loading. + |
InvalidType |
+ Unsupported type. +
|
InvalidFormat |
+ Unsupported format. +
|
InvalidBitmap |
+ Bitmap error occurred. + |
InvalidMemory |
+ Error at memory opening. + |
InvalidConversion |
+ Conversion not implemented. + |
InvalidResidence |
+ Invalid memory residence. + |
InvalidDevice |
+ Target Device is not supported for this system. + |
FailedToSave |
+ Error during image saving. + |
FailedToLoad |
+ Error during image loading. + |
FailedToInitialize |
+ Error during initialization. + |
ReleasedInOtherThread |
+ Failed to retain image: it was released in another thread. + |
+
|
+ +strong | +
Supported compression type is used only for jpg and png types.
+JPG case: the higher level of compression corresponds to the lower quality. Compression/decompression speed are constant. PNG case: the higher level of compression corresponds to the lower compression speed. Quality are constant.
+Enumerator | |
---|---|
IC_NO_COMPRESSION |
+ no compression (only for png or jpg image) + |
IC_SMALL_COMPRESSION |
+ compression with minimal (or without) quality loss (only for png or jpg image) + |
IC_MEDIUM_COMPRESSION |
+ medium compression (only for png or jpg) + |
IC_HARD_COMPRESSION |
+ more than medium compression (only for png or jpg) + |
IC_BEST_COMPRESSION |
+ maximum compression level (only for png or jpg) + |
+
|
+ +strong | +
Memory residence.
+Enumerator | |
---|---|
MemoryCPU |
+ Image in Host device memory. + |
MemoryGPU |
+ Image in Cuda device memory. + |
MemoryNPU |
+ Image in NPU device memory. + |
MemoryNPU_DPP |
+ Image in NPU PreProcessing module memory. + |
+
|
+ +noexcept | +
Initializes an empty image and preallocates storage buffer of given size.
+[in] | width | image width. |
[in] | height | image height. |
[in] | format | image format. |
[in] | deviceId | index of a device where image will be allocated |
+
|
+ +noexcept | +
Initializes an empty image and preallocates storage buffer of given size. Fills image contents with provided data.
+[in] | width | image width. |
[in] | height | image height. |
[in] | format | image format. |
[in] | data | image data. |
[in] | deviceId | index of a device where image will be allocated |
+
|
+ +noexcept | +
Initializes an image. If copy is true, this allocates a new buffer of given size and fills image contents with provided data (copies it). If copy is false (which is default) this will just reference the provided data.
+[in] | width | image width. |
[in] | height | image height. |
[in] | format | image format. |
[in] | data | image data. |
[in] | copy | [optional] whether to copy or reference data. |
[in] | deviceId | index of a device where image will be allocated |
Initializes an image as a reference to an other image.
+[in] | other | other image. |
Initializes an image with contents of an other image. Source image is then invalidated.
+[in] | other | other image. |
+
|
+ +explicitnoexcept | +
Initializes an image with contents of a sub image. Since sub images do not handle data life time, image contents are always copied.
+[in] | subImage | sub image. |
+
|
+ +staticprotectednoexcept | +
Allocate memory.
+[in] | size | memory region size in bytes. |
+
|
+ +inlinenoexcept | +
Create a copy of this image. The new image will have it's own reference count.
+
+
|
+ +noexcept | +
Convert image format.
+[in,out] | dest | destination image. |
[in] | x | horisontal coordinate of top left corner of image rect to convert. |
[in] | y | vertical coordinate of top left corner of image rect to convert. |
[in] | width | width of image rect to convert. |
[in] | height | height of image rect to convert. |
[in] | format | new format. |
[in] | device | target device to run convert on. |
+
|
+ +inlinenoexcept | +
Convert image format.
+[in,out] | dest | destination image. |
[in] | origin | converted image origin. |
[in] | size | image size to convert. |
[in] | format | new format. |
[in] | device | target device to run convert on. |
+
|
+ +inlinenoexcept | +
Convert image format.
+[in,out] | dest | destination image. |
[in] | format | new format. |
[in] | size | image area size to convert. |
[in] | device | target device to run convert on. |
+
|
+ +inlinenoexcept | +
Convert image format.
+[in,out] | dest | destination image. |
[in] | format | new format. |
[in] | rect | image area rect to convert. |
[in] | device | target device to run convert on. |
+
|
+ +inlinenoexcept | +
Convert image format.
+[in,out] | dest | destination image. |
[in] | format | new format. |
[in] | device | target device to run convert on. |
+
|
+ +noexcept | +
Initializes an empty image and preallocates storage buffer of given size.
+[in] | width | image width. |
[in] | height | image height. |
[in] | format | image format. |
[in] | cleanup | initializes internal image memory to default value. |
[in] | residence | memory residence of a data pointer. |
[in] | deviceId | index of a device where image will be allocated |
+
|
+ +noexcept | +
Initializes an empty image and preallocates storage buffer of given size. Fills image contents with provided data.
+[in] | width | image width. |
[in] | height | image height. |
[in] | format | image format. |
[in] | data | image data. |
[in] | memory | residence of a data pointer. |
[in] | deviceId | index of a device where data pointer was allocated |
+
|
+ +noexcept | +
Initializes an image. If copy is true, this allocates a new buffer of given size and fills image contents with provided data (copies it). If copy is false (which is default) this will just reference the provided data.
+[in] | width | image width. |
[in] | height | image height. |
[in] | format | image format. |
[in] | data | image data. |
[in] | copy | whether to copy or reference data |
[in] | memory | residence of a data pointer. |
[in] | deviceId | index of a device where data pointer was allocated |
+
|
+ +noexcept | +
Creates image with given memory residence based on other image instance. If source image has another MemoryResidence or device id, all memory will be copied to the new residence. In the other case new instance will be just a reference for the source.
+[in] | image | instance to create copy for |
[in] | residence | memory residence for the target image |
[in] | deviceId | index of a device for the target image |
+
|
+ +staticprotectednoexcept | +
Free memory.
+[in] | memory | memory region pointer. |
+
|
+ +inlinenoexcept | +
Performs strong comparison of this image with other. Beside weak comparison strong comparison also checks whether two images point to the same block of pixels.
+
+
|
+ +noexcept | +
Extract a sub image of this image. The new image will have it's own reference count.
+[in] | x | horisontal coordinate of top left corner of image rect to extract. |
[in] | y | vertical coordinate of top left corner of image rect to extract. |
[in] | width | width of image rect to extract. |
[in] | height | height of image rect to extract. |
+
|
+ +inlinenoexcept | +
Extract a sub image of this image. The new image will have it's own reference count.
+[in] | rect | image rect to extract. |
+
|
+ +inlinenoexcept | +
Extract a sub image of this image. The new image will have it's own reference count.
+[in] | size | image size to extract. |
+
|
+ +inlinenoexcept | +
Extract a sub image of this image. The new image will have it's own reference count.
+[in] | origin | extracted image origin. |
[in] | size | image size to extract. |
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Get actual image size in bytes.
+[in,out] | sizer | sizer to append result to. |
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +protectednoexcept | +
Obtain reference count.
+
+
|
+ +inlinenoexcept | +
+
|
+ +noexcept | +
Get image scanline data.
+[in] | y | scanline number. |
+
|
+ +noexcept | +
Get image scanline data.
+[in] | y | scanline number. |
+
|
+ +inlinenoexcept | +
Get image scanline data.
+[in] | y | scanline number. |
+
|
+ +inlinenoexcept | +
Get image scanline data.
+[in] | y | scanline number. |
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +staticnoexcept | +
Guess type of image written into memory.
+[in] | data | Pointer to memory containing image. |
[in] | sizeInBytes | Count of bytes containing image pointed to by data. |
[out] | type | Type of passed image. |
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
[in] | other | other image to check againts. |
+
|
+ +inlinenoexcept | +
+
|
+ +noexcept | +
Load image from file.
+This function loads image contents from disk. Supported types are: bmp, png, ppm, jpeg, tiff. If image is not empty, it's content will be freed and memory will be reallocated to fit in the data from the file if:
+[in] | path | Input file path. |
+
|
+ +noexcept | +
Load image from file and convert it to required format.
+This function does exact same thing as method above, and additionally converts loaded image to input format.
+[in] | path | Input file path. |
[in] | format | required image format. |
+
|
+ +noexcept | +
Load image from memory.
+This function loads image contents from memory. Supported types are: bmp, png, ppm, jpeg, tiff. If image is not empty, it's content will be freed and memory will be reallocated to fit in the data from the file if:
+[in] | data | Pointer to input memory. |
[in] | sizeInBytes | Count of bytes of image pointed to by data. |
+
|
+ +noexcept | +
Load image from memory and convert it to required format.
+This function does exact same thing as method above, and additionally converts loaded image to input format.
+[in] | data | Pointer to input memory. |
[in] | sizeInBytes | Count of bytes of image pointed to by data. |
[in] | format | required image format. |
+
|
+ +noexcept | +
Load image from memory of specific type.
+This function loads specific type image contents from memory. If data points to image of another type, not the one passed, does nothing. Supported types are: bmp, png, ppm, jpeg, tiff. If image is not empty, it's content will be freed and memory will be reallocated to fit in the data from the file if:
+[in] | data | Pointer to input memory. |
[in] | sizeInBytes | Count of bytes of image pointed to by data. |
[in] | type | Type of image to be loaded. |
+
|
+ +noexcept | +
Load image from memory of specific type and convert it to required format.
+This function does exact same thing as method above, and additionally converts loaded image to input format.
+[in] | data | Pointer to input memory. |
[in] | sizeInBytes | Count of bytes of image pointed to by data. |
[in] | type | Type of image to be loaded. |
[in] | format | required image format. |
+
|
+ +noexcept | +
Map image contents to a given area.
+[in] | x | horizontal coordinate of top left corner of image rect to map. |
[in] | y | vertical coordinate of top left corner of image rect to map. |
[in] | width | width of image rect to map |
[in] | height | height of image rect to map |
+
|
+ +inlinenoexcept | +
Map image contents to a given area.
+[in] | rect | image rect to extract |
+
|
+ +inlinenoexcept | +
Map image contents to a given area.
+[in] | size | image size to map. |
+
|
+ +inlinenoexcept | +
Map image contents to a given area.
+[in] | origin | sub image image origin. |
[in] | size | sub image size to extract. |
+
|
+ +inlinenoexcept | +
Implicit cast to boolean; results in true if image is valid, false if not.
+
+
|
+ +inlinenoexcept | +
Assign other image.
+[in] | other | image to assign. |
Move other image.
+[in] | other | image to move. |
+
|
+ +inlinenoexcept | +
+
|
+ +protectednoexcept | +
Decrease reference count.
+
+
|
+ +noexcept | +
Rescale image keeping proportions.
+[in] | scale | factor. Must be positive. |
+
|
+ +protectednoexcept | +
Increase reference count.
+
+
|
+ +noexcept | +
Save image.
+This function saves image contents to disk. Type is extracted from provided file extension. If it is unknown, function fails. Supported types are: bmp, png, ppm, jpeg, tiff.
+[in] | path | output file path with proper file extension. |
[in] | additionalFlag | additional flag for saving of png or jpg image |
+
|
+ +noexcept | +
Convert and Save image.
+This function converts image to required format and saves image contents to disk. Type is extracted from provided file extension. If it is unknown, function fails. Supported types are: bmp, png, ppm, jpeg, tiff.
+[in] | path | output file path with proper file extension. |
[in] | format | required image format. |
+
|
+ +noexcept | +
Save image to memory buffer.
+This function saves image contents to memory buffer (IArchive). Passed IArchvie will call setSizeHint for resize.
+[in] | Image::Type | format used to encode. |
[in] | IArchive | to store contents of encoded image. |
[in] | additionalFlag | additional flag for saving of png or jpg image |
+
|
+ +noexcept | +
Convert and save image to memory buffer.
+This function converts image to required format and saves image contents to memory buffer (IArchive). Passed IArchvie will call setSizeHint for resize.
+[in] | Image::Type | format used to encode. |
[in] | IArchive | to store contents of encoded image. |
[in] | format | required image format. |
+
|
+ +noexcept | +
Initializes an image with provided data. If current image is not empty and it's size and format match the provided ones, no memory reallocation is performed. Otherwise image is re-created to match requirements.
+[in] | width | image width. |
[in] | height | image height. |
[in] | format | image format. |
[in] | data | image data. |
[in] | memory | residence of a data pointer. |
[in] | deviceId | index of a device where data pointer was allocated |
+
|
+ +noexcept | +
Initializes an image with provided data. If copy is true and if current image is not empty and it's size and format match the provided ones, no memory reallocation is performed. Otherwise image is re-created to match requirements. If copy is false (which is default) this will just reference the provided data.
+[in] | width | image width. |
[in] | height | image height. |
[in] | format | image format. |
[in] | data | image data. |
[in] | copy | whether to copy or reference data. |
[in] | memory | residence of a data pointer. |
[in] | deviceId | index of a device where data pointer was allocated |
+
|
+ +noexcept | +
Initializes an image as a reference to an other image.
+[in] | other | other image. |
+
|
+ +noexcept | +
Initializes an image with contents of a sub image. Since sub images do not handle data life time, image contents are always copied.
+[in] | subImage | sub image. |
+
|
+ +inlinenoexcept | +
Swap contents with another image.
+[in,out] | other | image to swap with. |
+
|
+ +protected | +
image format (
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Landmarks< numOfLandmarks >, including all inherited members.
+landmarkCount (defined in fsdk::Landmarks< numOfLandmarks >) | fsdk::Landmarks< numOfLandmarks > | static |
landmarks | fsdk::Landmarks< numOfLandmarks > | |
Landmarks()=default (defined in fsdk::Landmarks< numOfLandmarks >) | fsdk::Landmarks< numOfLandmarks > | |
Landmarks(const Landmarks &cp) (defined in fsdk::Landmarks< numOfLandmarks >) | fsdk::Landmarks< numOfLandmarks > | inline |
Landmarks(Landmarks &&mv) (defined in fsdk::Landmarks< numOfLandmarks >) | fsdk::Landmarks< numOfLandmarks > | inline |
operator=(const Landmarks &cp) (defined in fsdk::Landmarks< numOfLandmarks >) | fsdk::Landmarks< numOfLandmarks > | inline |
operator=(Landmarks &&mv) (defined in fsdk::Landmarks< numOfLandmarks >) | fsdk::Landmarks< numOfLandmarks > | inline |
~Landmarks()=default (defined in fsdk::Landmarks< numOfLandmarks >) | fsdk::Landmarks< numOfLandmarks > |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Face landmarks template structure. + More...
+ +#include <Landmarks.h>
+Public Member Functions | |
+ | Landmarks (const Landmarks &cp) |
+ | Landmarks (Landmarks &&mv) |
+Landmarks & | operator= (const Landmarks &cp) |
+Landmarks & | operator= (Landmarks &&mv) |
+Public Attributes | |
+Landmark | landmarks [landmarkCount] |
Detected landmarks. | |
+Static Public Attributes | |
+static constexpr uint64_t | landmarkCount = numOfLandmarks |
Face landmarks template structure.
+Face detector is capable of face landmarks detection. Contain's not fixed, but provided at compile time amount of landmarks
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Landmarks5Indexes, including all inherited members.
+LandmarkCount enum value | fsdk::Landmarks5Indexes | |
LandmarkLeftEye enum value | fsdk::Landmarks5Indexes | |
LandmarkMouthLeftCorner enum value | fsdk::Landmarks5Indexes | |
LandmarkMouthRightCorner enum value | fsdk::Landmarks5Indexes | |
LandmarkNose enum value | fsdk::Landmarks5Indexes | |
LandmarkRightEye enum value | fsdk::Landmarks5Indexes |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Enumerates detected landmarks. Only valid for template with 5 landmarks. + More...
+ +#include <Landmarks.h>
+Public Types | |
enum | { + LandmarkLeftEye = 0, +LandmarkRightEye, +LandmarkNose, +LandmarkMouthLeftCorner, + + LandmarkMouthRightCorner, +LandmarkCount + + } |
Enumerates detected landmarks. Only valid for template with 5 landmarks.
+anonymous enum | +
Enumerator | |
---|---|
LandmarkLeftEye |
+ Left eye center. + |
LandmarkRightEye |
+ Right eye center. + |
LandmarkNose |
+ Nose tip. Same as FL_NOSE_TIP. + |
LandmarkMouthLeftCorner |
+ Mouth left corner. Same as FL_MOUTH_LEFT_CORNER. + |
LandmarkMouthRightCorner |
+ Mouth right corner. Same as FL_MOUTH_RIGHT_CORENR. + |
LandmarkCount |
+ Not a landmark; counts number of detected landmarks. + |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::LaunchOptions, including all inherited members.
+defaultDeviceId (defined in fsdk::LaunchOptions) | fsdk::LaunchOptions | static |
deviceClass (defined in fsdk::LaunchOptions) | fsdk::LaunchOptions | |
deviceId (defined in fsdk::LaunchOptions) | fsdk::LaunchOptions | |
runConcurrently (defined in fsdk::LaunchOptions) | fsdk::LaunchOptions |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
LaunchOptions struct configures inference options on per-estimator/detector basis, giving user fine grained control over cpu/gpu utilisation. + More...
+ +#include <LaunchOptions.h>
+Public Attributes | |
+DeviceClass | deviceClass = DeviceClass::CPU |
+bool | runConcurrently = true |
+int32_t | deviceId = defaultDeviceId |
+Static Public Attributes | |
+static constexpr int32_t | defaultDeviceId = -1 |
LaunchOptions struct configures inference options on per-estimator/detector basis, giving user fine grained control over cpu/gpu utilisation.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::LivenessOneShotRGBEstimation, including all inherited members.
+qualityScore | fsdk::LivenessOneShotRGBEstimation | |
score | fsdk::LivenessOneShotRGBEstimation | |
state | fsdk::LivenessOneShotRGBEstimation | |
State enum name | fsdk::LivenessOneShotRGBEstimation |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Liveness OneShotRGB estimation structure. + More...
+ +#include <ILivenessOneShotRGBEstimator.h>
+Public Types | |
enum | State { State::Alive = 0, +State::Fake, +State::Unknown + } |
+Public Attributes | |
+float | score |
Estimation score. | |
+State | state |
Liveness status. | |
+float | qualityScore |
Liveness quality score. | |
Liveness OneShotRGB estimation structure.
+
+
|
+ +strong | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::MatchingResult, including all inherited members.
+distance | fsdk::MatchingResult | |
MatchingResult(void) noexcept | fsdk::MatchingResult | inline |
MatchingResult(float distance, float similarity) noexcept | fsdk::MatchingResult | inline |
similarity | fsdk::MatchingResult |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Result of descriptor matching. + More...
+ +#include <IDescriptor.h>
+Public Member Functions | |
+ | MatchingResult (void) noexcept |
Initializes result to default values. | |
MatchingResult (float distance, float similarity) noexcept | |
Initializes result. More... | |
+Public Attributes | |
+float | distance |
distance between descriptor vectors. | |
+float | similarity |
similarity (normalized in [0..1] range). | |
Result of descriptor matching.
+
+
|
+ +inlinenoexcept | +
Initializes result.
+[in] | distance | distance value. |
[in] | similarity | similarity value. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::MedicalMaskEstimation, including all inherited members.
+getScore(DetailedMaskType type) const | fsdk::MedicalMaskEstimation | inline |
maskScore | fsdk::MedicalMaskEstimation | |
maskType | fsdk::MedicalMaskEstimation | |
noMaskScore | fsdk::MedicalMaskEstimation | |
occludedFaceScore | fsdk::MedicalMaskEstimation | |
result | fsdk::MedicalMaskEstimation | |
scores | fsdk::MedicalMaskEstimation |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
MedicalMask estimator output structure. This structure contains the result of estimation (. + More...
+ +#include <IMedicalMaskEstimator.h>
+Public Member Functions | |
float | getScore (DetailedMaskType type) const |
Returns score of required detailed mask type. More... | |
+Public Attributes | |
MedicalMask | result |
estimation result ( More... | |
DetailedMaskType | maskType |
detailed type ( More... | |
+float | maskScore |
medical mask is on the face score | |
+float | noMaskScore |
no medical mask on the face score | |
+float | occludedFaceScore |
face is occluded by something score | |
+float | scores [static_cast< int >(DetailedMaskType::Count)] |
detailed estimation scores | |
MedicalMask estimator output structure. This structure contains the result of estimation (.
+
+
|
+ +inline | +
Returns score of required detailed mask type.
+[in] | type | detailed mask type. |
DetailedMaskType fsdk::MedicalMaskEstimation::maskType | +
detailed type (
+MedicalMask fsdk::MedicalMaskEstimation::result | +
estimation result (
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::MedicalMaskEstimationExtended, including all inherited members.
+maskNotInPlace | fsdk::MedicalMaskEstimationExtended | |
maskScore | fsdk::MedicalMaskEstimationExtended | |
noMaskScore | fsdk::MedicalMaskEstimationExtended | |
occludedFaceScore | fsdk::MedicalMaskEstimationExtended | |
result | fsdk::MedicalMaskEstimationExtended |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
MedicalMask estimator output structure. This structure contains the result of estimation (. + More...
+ +#include <IMedicalMaskEstimator.h>
+Public Attributes | |
MedicalMaskExtended | result |
estimation result ( More... | |
+float | maskScore |
medical mask is on the face score | |
+float | noMaskScore |
no medical mask on the face score | |
+float | maskNotInPlace |
mask is not on the right place | |
+float | occludedFaceScore |
face is occluded by something score | |
MedicalMask estimator output structure. This structure contains the result of estimation (.
+MedicalMaskExtended fsdk::MedicalMaskEstimationExtended::result | +
estimation result (
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::MultiError< E0, E1 >, including all inherited members.
+E0Type typedef (defined in fsdk::MultiError< E0, E1 >) | fsdk::MultiError< E0, E1 > | |
E1Type typedef (defined in fsdk::MultiError< E0, E1 >) | fsdk::MultiError< E0, E1 > | |
m_first (defined in fsdk::MultiError< E0, E1 >) | fsdk::MultiError< E0, E1 > | |
m_second (defined in fsdk::MultiError< E0, E1 >) | fsdk::MultiError< E0, E1 > |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
An error structure designed for functions which can return errors from different enum classes. + More...
+ +#include <MultiError.h>
+Public Types | |
+using | E0Type = E0 |
+using | E1Type = E1 |
+Public Attributes | |
+E0 | m_first |
+E1 | m_second |
An error structure designed for functions which can return errors from different enum classes.
+The order of isOk() check and toString() returns should be specified via ErrorTraits structure. ErrorTraits for additional information.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Quality, including all inherited members.
+blur (defined in fsdk::Quality) | fsdk::Quality | |
dark (defined in fsdk::Quality) | fsdk::Quality | |
getQuality() const noexcept | fsdk::Quality | inline |
gray (defined in fsdk::Quality) | fsdk::Quality | |
light (defined in fsdk::Quality) | fsdk::Quality |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: + More...
+ +#include <IQualityEstimator.h>
+Public Member Functions | |
float | getQuality () const noexcept |
+Public Attributes | |
+float | light |
+float | dark |
+float | gray |
+float | blur |
Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings:
+light:
image overlighting degree. 1 - ok, 0 - overlighted; dark:
image darkness degree. 1 - ok, 0 - too dark; gray:
image grayness degree 1 - ok, 0 - too gray; blur:
image blur degree. 1 - ok, 0 - too blured.
+
|
+ +inlinenoexcept | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Ref< T >, including all inherited members.
+acquire(T *ptr) noexcept | fsdk::Ref< T > | inline |
as() const noexcept | fsdk::Ref< T > | inline |
assign(T *ptr) noexcept | fsdk::Ref< T > | inline |
get() const noexcept | fsdk::RefBase< T > | inline |
getInitReference() noexcept | fsdk::Ref< T > | inline |
isExpired() const noexcept | fsdk::RefBase< T > | inline |
isNull() const noexcept | fsdk::RefBase< T > | inline |
isUnique() const noexcept | fsdk::RefBase< T > | inline |
m_ptr | fsdk::RefBase< T > | protected |
make_ref(T *ptr) noexcept | fsdk::Ref< T > | inline |
operator bool() const noexcept | fsdk::RefBase< T > | inline |
operator T *() const noexcept | fsdk::RefBase< T > | inline |
operator!=(const Ref &other) const noexcept | fsdk::Ref< T > | inline |
fsdk::RefBase::operator!=(const RefBase &other) const noexcept | fsdk::RefBase< T > | inline |
operator*() const noexcept | fsdk::RefBase< T > | inline |
operator->() const noexcept | fsdk::Ref< T > | inline |
operator=(const Ref &other) noexcept | fsdk::Ref< T > | inline |
operator=(const Ref< D > &other) noexcept | fsdk::Ref< T > | inline |
operator=(T *ptr) noexcept | fsdk::Ref< T > | inline |
operator=(std::nullptr_t) noexcept | fsdk::Ref< T > | inline |
operator==(const Ref &other) const noexcept | fsdk::Ref< T > | inline |
fsdk::RefBase::operator==(const RefBase &other) const noexcept | fsdk::RefBase< T > | inline |
Ref() noexcept=default | fsdk::Ref< T > | |
Ref(std::nullptr_t) noexcept | fsdk::Ref< T > | inline |
Ref(T *ptr) noexcept | fsdk::Ref< T > | inlineexplicit |
Ref(const Ref &other) | fsdk::Ref< T > | inline |
Ref(const Ref< D > &other) | fsdk::Ref< T > | inlineexplicit |
RefBase() noexcept=default | fsdk::RefBase< T > | |
RefBase(T *ptr) noexcept | fsdk::RefBase< T > | inlineexplicit |
reset() noexcept | fsdk::Ref< T > | inline |
set(T *ptr) noexcept | fsdk::RefBase< T > | inline |
~Ref() noexcept | fsdk::Ref< T > | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Smart pointer for reference counted objects. + More...
+ +#include <Ref.h>
+Public Member Functions | |
+ | Ref () noexcept=default |
Constructor. Initializes object pointer to nullptr. | |
+ | Ref (std::nullptr_t) noexcept |
Initializes object pointer to nullptr. | |
Ref (T *ptr) noexcept | |
Initializes object pointer with ptr and retains a reference. More... | |
Ref (const Ref &other) | |
Initializes object pointer with other and retains a reference. More... | |
template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type> | |
Ref (const Ref< D > &other) | |
Initializes object pointer with other and retains a reference. More... | |
+ | ~Ref () noexcept |
Releases reference being held (if any). | |
T * | operator-> () const noexcept |
Access pointer. More... | |
T ** | getInitReference () noexcept |
Access pointer for initialization. More... | |
bool | operator== (const Ref &other) const noexcept |
Check if two refs are the same. More... | |
bool | operator!= (const Ref &other) const noexcept |
Check if two refs are not the same. More... | |
Ref & | operator= (const Ref &other) noexcept |
Assign a strong reference. More... | |
template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type> | |
Ref & | operator= (const Ref< D > &other) noexcept |
Assign a strong reference. More... | |
Ref & | operator= (T *ptr) noexcept |
Assign a raw pointer. More... | |
Ref & | operator= (std::nullptr_t) noexcept |
Assign a nullptr_t. More... | |
Ref & | assign (T *ptr) noexcept |
Assign an object. Presumes shared ownership, increases reference count. More... | |
Ref & | acquire (T *ptr) noexcept |
Acquire ownership of the object. More... | |
Ref & | make_ref (T *ptr) noexcept |
Create ref without acquiring ownership. More... | |
+T * | reset () noexcept |
Reset reference counted object and assign nullptr to the pointer. | |
template<typename S > | |
Ref< S > | as () const noexcept |
Make smart reference with relative type. More... | |
![]() | |
+ | RefBase () noexcept=default |
Initializes object pointer to nullptr. | |
RefBase (T *ptr) noexcept | |
Initializes object pointer with ptr. More... | |
operator T * () const noexcept | |
Get raw object pointer. More... | |
T & | operator* () const noexcept |
Dereference operator. More... | |
operator bool () const noexcept | |
Implicit cast to bool. More... | |
bool | operator== (const RefBase &other) const noexcept |
Check if two refs are the same. More... | |
bool | operator!= (const RefBase &other) const noexcept |
Check if two refs are not the same. More... | |
bool | isNull () const noexcept |
Check for nullptr. More... | |
bool | isExpired () const noexcept |
Check is object is dead. More... | |
bool | isUnique () const noexcept |
Check if object has only one strong reference. More... | |
T * | get () const noexcept |
Get current raw object pointer. More... | |
void | set (T *ptr) noexcept |
Replace object pointer without any checks or reference management. More... | |
+Additional Inherited Members | |
![]() | |
+T * | m_ptr {nullptr} |
Raw pointer. | |
Smart pointer for reference counted objects.
+Automatically calls retain/release and provides safety assertions.
+T | object interface (must be derived from IRefCounted) |
+
|
+ +inlineexplicitnoexcept | +
Initializes object pointer with ptr and retains a reference.
+[in] | ptr | raw pointer to initialize with. |
+
|
+ +inline | +
Initializes object pointer with other and retains a reference.
+[in] | other | pointer to initialize with. |
+
|
+ +inlineexplicit | +
Initializes object pointer with other and retains a reference.
+[in] | other | pointer of derived template class to initialize with. |
+
|
+ +inlinenoexcept | +
Acquire ownership of the object.
+[in] | ptr | raw object pointer to acquire. |
+
|
+ +inlinenoexcept | +
Make smart reference with relative type.
+S | target interface (must be relative to T) |
+
|
+ +inlinenoexcept | +
Assign an object. Presumes shared ownership, increases reference count.
+[in] | ptr | raw object pointer to assign. |
+
|
+ +inlinenoexcept | +
Access pointer for initialization.
+
+
|
+ +inlinenoexcept | +
Create ref without acquiring ownership.
+[in] | ptr | raw object pointer. |
+
|
+ +inlinenoexcept | +
Check if two refs are not the same.
+[in] | other | ref to check against. |
+
|
+ +inlinenoexcept | +
Access pointer.
+
+
|
+ +inlinenoexcept | +
Assign a strong reference.
+[in] | other | strong reference. |
+
|
+ +inlinenoexcept | +
Assign a strong reference.
+[in] | other | strong reference of derived template class. |
+
|
+ +inlinenoexcept | +
Assign a raw pointer.
+[in] | ptr | raw pointer. |
+
|
+ +inlinenoexcept | +
Assign a nullptr_t.
+
+
|
+ +inlinenoexcept | +
Check if two refs are the same.
+[in] | other | ref to check against. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::RefBase< T >, including all inherited members.
+get() const noexcept | fsdk::RefBase< T > | inline |
isExpired() const noexcept | fsdk::RefBase< T > | inline |
isNull() const noexcept | fsdk::RefBase< T > | inline |
isUnique() const noexcept | fsdk::RefBase< T > | inline |
m_ptr | fsdk::RefBase< T > | protected |
operator bool() const noexcept | fsdk::RefBase< T > | inline |
operator T *() const noexcept | fsdk::RefBase< T > | inline |
operator!=(const RefBase &other) const noexcept | fsdk::RefBase< T > | inline |
operator*() const noexcept | fsdk::RefBase< T > | inline |
operator==(const RefBase &other) const noexcept | fsdk::RefBase< T > | inline |
RefBase() noexcept=default | fsdk::RefBase< T > | |
RefBase(T *ptr) noexcept | fsdk::RefBase< T > | inlineexplicit |
set(T *ptr) noexcept | fsdk::RefBase< T > | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Generic base class of a pointer for reference counted objects. + More...
+ +#include <RefBase.h>
+Public Member Functions | |
+ | RefBase () noexcept=default |
Initializes object pointer to nullptr. | |
RefBase (T *ptr) noexcept | |
Initializes object pointer with ptr. More... | |
operator T * () const noexcept | |
Get raw object pointer. More... | |
T & | operator* () const noexcept |
Dereference operator. More... | |
operator bool () const noexcept | |
Implicit cast to bool. More... | |
bool | operator== (const RefBase &other) const noexcept |
Check if two refs are the same. More... | |
bool | operator!= (const RefBase &other) const noexcept |
Check if two refs are not the same. More... | |
bool | isNull () const noexcept |
Check for nullptr. More... | |
bool | isExpired () const noexcept |
Check is object is dead. More... | |
bool | isUnique () const noexcept |
Check if object has only one strong reference. More... | |
T * | get () const noexcept |
Get current raw object pointer. More... | |
void | set (T *ptr) noexcept |
Replace object pointer without any checks or reference management. More... | |
+Protected Attributes | |
+T * | m_ptr {nullptr} |
Raw pointer. | |
Generic base class of a pointer for reference counted objects.
+Implements common features of Ref and WeakRef and is not meant to be used directly.
+T | object interface (must be derived from IRefCounted) |
+
|
+ +inlineexplicitnoexcept | +
Initializes object pointer with ptr.
+[in] | ptr | raw pointer to initialize with. |
+
|
+ +inlinenoexcept | +
Get current raw object pointer.
+
+
|
+ +inlinenoexcept | +
Check is object is dead.
+
+
|
+ +inlinenoexcept | +
Check for nullptr.
+
+
|
+ +inlinenoexcept | +
Check if object has only one strong reference.
+
+
|
+ +inlinenoexcept | +
Implicit cast to bool.
+
+
|
+ +inlinenoexcept | +
Get raw object pointer.
+
+
|
+ +inlinenoexcept | +
Check if two refs are not the same.
+[in] | other | ref to check against. |
+
|
+ +inlinenoexcept | +
Dereference operator.
+
+
|
+ +inlinenoexcept | +
Check if two refs are the same.
+[in] | other | ref to check against. |
+
|
+ +inlinenoexcept | +
Replace object pointer without any checks or reference management.
+[in] | ptr | raw object pointer to set. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Result< E >, including all inherited members.
+ErrorType typedef | fsdk::Result< E > | |
getError() const noexcept | fsdk::Result< E > | inline |
isError() const noexcept | fsdk::Result< E > | inline |
isOk() const noexcept | fsdk::Result< E > | inline |
operator bool() const noexcept | fsdk::Result< E > | inline |
Result(E error) noexcept | fsdk::Result< E > | inlineexplicit |
Result() noexcept | fsdk::Result< E > | inline |
Traits typedef (defined in fsdk::Result< E >) | fsdk::Result< E > | |
what() const noexcept | fsdk::Result< E > | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
A structure that encapsulates an action result enumeration. + More...
+ +#include <Result.h>
+Public Types | |
+using | ErrorType = E |
Result value enumeration type. | |
+using | Traits = ErrorTraits< E > |
+Public Member Functions | |
Result (E error) noexcept | |
Initializes result. More... | |
+ | Result () noexcept |
Initializes result by default. | |
E | getError () const noexcept |
Gets actual result value. More... | |
bool | isError () const noexcept |
Checks for an error. More... | |
bool | isOk () const noexcept |
Checks for a success. More... | |
operator bool () const noexcept | |
Checks for a success. More... | |
const char * | what () const noexcept |
Gets a textual description of the result. More... | |
A structure that encapsulates an action result enumeration.
+An enum should specify a result code. By default the result is in a special uninitialized state which should be interpreted as an error. Default success value shoud be defined to zero.
+enumeration | to wrap. |
+
|
+ +inlineexplicitnoexcept | +
Initializes result.
+[in] | result | value to set. |
+
|
+ +inlinenoexcept | +
Gets actual result value.
+
+
|
+ +inlinenoexcept | +
Checks for an error.
+
+
|
+ +inlinenoexcept | +
Checks for a success.
+
+
|
+ +inlinenoexcept | +
Checks for a success.
+
+
|
+ +inlinenoexcept | +
Gets a textual description of the result.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ResultValue< R, V, Enable >, including all inherited members.
+ErrorType typedef | fsdk::Result< R > | |
getError() const noexcept | fsdk::Result< R > | inline |
isError() const noexcept | fsdk::Result< R > | inline |
isOk() const noexcept | fsdk::Result< R > | inline |
operator bool() const noexcept | fsdk::Result< R > | inline |
Result(Rerror) noexcept | fsdk::Result< R > | inlineexplicit |
Result() noexcept | fsdk::Result< R > | inline |
Traits typedef (defined in fsdk::Result< R >) | fsdk::Result< R > | |
what() const noexcept | fsdk::Result< R > | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Addon for Result to output some value aside the result. Specialization for copiable types. + More...
+ +#include <ResultValue.h>
+Additional Inherited Members | |
![]() | |
+using | ErrorType = R |
Result value enumeration type. | |
+using | Traits = ErrorTraits< R > |
![]() | |
Result (Rerror) noexcept | |
Initializes result. More... | |
+ | Result () noexcept |
Initializes result by default. | |
R | getError () const noexcept |
Gets actual result value. More... | |
bool | isError () const noexcept |
Checks for an error. More... | |
bool | isOk () const noexcept |
Checks for a success. More... | |
operator bool () const noexcept | |
Checks for a success. More... | |
const char * | what () const noexcept |
Gets a textual description of the result. More... | |
Addon for Result to output some value aside the result. Specialization for copiable types.
+R | result enumeration type. |
V | result value type. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type >, including all inherited members.
+EnumType typedef | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | |
ErrorType typedef | fsdk::Result< R > | |
getError() const noexcept | fsdk::Result< R > | inline |
getValue() const noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | inline |
isError() const noexcept | fsdk::Result< R > | inline |
isOk() const noexcept | fsdk::Result< R > | inline |
m_value | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | protected |
operator bool() const noexcept | fsdk::Result< R > | inline |
operator->() const noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | inline |
Result(Rerror) noexcept | fsdk::Result< R > | inlineexplicit |
Result() noexcept | fsdk::Result< R > | inline |
ResultValue(R result) noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | inline |
ResultValue(R result, const V &value) noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | inline |
ResultValue(R result, V &&value) noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | inline |
takeValue() noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | inline |
Traits typedef (defined in fsdk::Result< R >) | fsdk::Result< R > | |
ValueType typedef | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value >::type > | |
what() const noexcept | fsdk::Result< R > | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
+Public Types | |
+typedef R | EnumType |
Result enumeration type. | |
+typedef V | ValueType |
Result value type. | |
![]() | |
+using | ErrorType = R |
Result value enumeration type. | |
+using | Traits = ErrorTraits< R > |
+Public Member Functions | |
ResultValue (R result) noexcept | |
Initializes result. More... | |
ResultValue (R result, const V &value) noexcept | |
Initializes result. More... | |
ResultValue (R result, V &&value) noexcept | |
Initializes result. More... | |
const V & | getValue () const noexcept |
Gets result value. More... | |
V && | takeValue () noexcept |
Gets result value as rvalue. More... | |
const V * | operator-> () const noexcept |
Gets result value. More... | |
![]() | |
Result (Rerror) noexcept | |
Initializes result. More... | |
+ | Result () noexcept |
Initializes result by default. | |
R | getError () const noexcept |
Gets actual result value. More... | |
bool | isError () const noexcept |
Checks for an error. More... | |
bool | isOk () const noexcept |
Checks for a success. More... | |
operator bool () const noexcept | |
Checks for a success. More... | |
const char * | what () const noexcept |
Gets a textual description of the result. More... | |
+Protected Attributes | |
+V | m_value |
Actual value. | |
+
|
+ +inlinenoexcept | +
Initializes result.
+[in] | result | value to set. |
+
|
+ +inlinenoexcept | +
Initializes result.
+[in] | result | result to set. |
[in] | value | value to set. |
+
|
+ +inlinenoexcept | +
Initializes result.
+[in] | result | result to set. |
[in] | value | value to set. |
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
Gets result value as rvalue.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type >, including all inherited members.
+EnumType typedef | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > | |
ErrorType typedef | fsdk::Result< R > | |
getError() const noexcept | fsdk::Result< R > | inline |
getValue() const noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > | inline |
isError() const noexcept | fsdk::Result< R > | inline |
isOk() const noexcept | fsdk::Result< R > | inline |
m_value | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > | protected |
operator bool() const noexcept | fsdk::Result< R > | inline |
operator->() const noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > | inline |
Result(Rerror) noexcept | fsdk::Result< R > | inlineexplicit |
Result() noexcept | fsdk::Result< R > | inline |
ResultValue(R result) noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > | inline |
ResultValue(R result, V &&value) noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > | inline |
takeValue() noexcept | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > | inline |
Traits typedef (defined in fsdk::Result< R >) | fsdk::Result< R > | |
ValueType typedef | fsdk::ResultValue< R, V, typename std::enable_if< std::is_copy_constructible< V >::value==false >::type > | |
what() const noexcept | fsdk::Result< R > | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Addon for Result to output some value aside the result. Specialization for non copiable types. + More...
+ +#include <ResultValue.h>
+Public Types | |
+typedef R | EnumType |
Result enumeration type. | |
+typedef V | ValueType |
Result value type. | |
![]() | |
+using | ErrorType = R |
Result value enumeration type. | |
+using | Traits = ErrorTraits< R > |
+Public Member Functions | |
ResultValue (R result) noexcept | |
Initializes result. More... | |
ResultValue (R result, V &&value) noexcept | |
Initializes result. More... | |
const V & | getValue () const noexcept |
Gets result value. More... | |
V && | takeValue () noexcept |
Gets result value as rvalue. More... | |
const V * | operator-> () const noexcept |
Gets result value. More... | |
![]() | |
Result (Rerror) noexcept | |
Initializes result. More... | |
+ | Result () noexcept |
Initializes result by default. | |
R | getError () const noexcept |
Gets actual result value. More... | |
bool | isError () const noexcept |
Checks for an error. More... | |
bool | isOk () const noexcept |
Checks for a success. More... | |
operator bool () const noexcept | |
Checks for a success. More... | |
const char * | what () const noexcept |
Gets a textual description of the result. More... | |
+Protected Attributes | |
+V | m_value |
Actual value. | |
Addon for Result to output some value aside the result. Specialization for non copiable types.
+R | result enumeration type. |
V | result value type. |
+
|
+ +inlinenoexcept | +
Initializes result.
+[in] | result | value to set. |
+
|
+ +inlinenoexcept | +
Initializes result.
+[in] | result | result to set. |
[in] | value | value to set. |
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
Gets result value as rvalue.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::SearchResult, including all inherited members.
+distance | fsdk::MatchingResult | |
index | fsdk::SearchResult | |
MatchingResult(void) noexcept | fsdk::MatchingResult | inline |
MatchingResult(float distance, float similarity) noexcept | fsdk::MatchingResult | inline |
SearchResult() noexcept | fsdk::SearchResult | inline |
SearchResult(float distance, float similarity, DescriptorId index) noexcept | fsdk::SearchResult | inline |
similarity | fsdk::MatchingResult |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Result of index search. + More...
+ +#include <IIndex.h>
+Public Member Functions | |
+ | SearchResult () noexcept |
Default constructor. | |
SearchResult (float distance, float similarity, DescriptorId index) noexcept | |
Construct structure with parameters. More... | |
![]() | |
+ | MatchingResult (void) noexcept |
Initializes result to default values. | |
MatchingResult (float distance, float similarity) noexcept | |
Initializes result. More... | |
+Public Attributes | |
+DescriptorId | index |
Identificator of descriptor in some storage. | |
![]() | |
+float | distance |
distance between descriptor vectors. | |
+float | similarity |
similarity (normalized in [0..1] range). | |
Result of index search.
+
+
|
+ +inlinenoexcept | +
Construct structure with parameters.
+[in] | distance | Distance between descriptors. |
[in] | similarity | Similarity between descriptors. |
[in] | index | Index of found descriptors in some storage. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Sizer, including all inherited members.
+append(size_t bytes) noexcept | fsdk::Sizer | inline |
append(const Sizer &other) noexcept | fsdk::Sizer | inline |
getBytes() const noexcept | fsdk::Sizer | inline |
getGBytes() const noexcept | fsdk::Sizer | inline |
getKBytes() const noexcept | fsdk::Sizer | inline |
getMBytes() const noexcept | fsdk::Sizer | inline |
isEmpty() const noexcept | fsdk::Sizer | inline |
m_bytes | fsdk::Sizer | protected |
operator bool() const noexcept | fsdk::Sizer | inline |
operator size_t() const noexcept | fsdk::Sizer | inline |
operator!=(const Sizer &other) const noexcept | fsdk::Sizer | inline |
operator<<(size_t bytes) noexcept | fsdk::Sizer | inline |
operator<<(const Sizer &other) noexcept | fsdk::Sizer | inline |
operator=(const Sizer &other) noexcept | fsdk::Sizer | inline |
operator==(const Sizer &other) const noexcept | fsdk::Sizer | inline |
reset() noexcept | fsdk::Sizer | inline |
Sizer() noexcept | fsdk::Sizer | inline |
Sizer(const Sizer &other) noexcept | fsdk::Sizer | inline |
swap(Sizer &other) noexcept | fsdk::Sizer | inline |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Helper entity to measure size of dynamic objects in memory. + More...
+ +#include <Sizer.h>
+Public Member Functions | |
+ | Sizer () noexcept |
Initializes sizer with zero. | |
Sizer (const Sizer &other) noexcept | |
Initializes sizer with another sizer value. More... | |
void | append (size_t bytes) noexcept |
Append bytes to current byte count. More... | |
void | append (const Sizer &other) noexcept |
Append other sizer byte count to current byte count. More... | |
+void | reset () noexcept |
Reset byte count to zero. | |
size_t | getBytes () const noexcept |
Get current size. More... | |
size_t | getKBytes () const noexcept |
Get current size. More... | |
size_t | getMBytes () const noexcept |
Get current size. More... | |
size_t | getGBytes () const noexcept |
Get current size. More... | |
+ | operator size_t () const noexcept |
Cast to size type. | |
bool | isEmpty () const noexcept |
Check whether size is zero. More... | |
operator bool () const noexcept | |
Check whether size is zero. More... | |
Sizer & | operator<< (size_t bytes) noexcept |
Append bytes to current byte count. More... | |
Sizer & | operator<< (const Sizer &other) noexcept |
Append other sizer byte count to current byte count. More... | |
Sizer & | operator= (const Sizer &other) noexcept |
Assign value of another sizer. More... | |
bool | operator== (const Sizer &other) const noexcept |
Check if two sizers are equal. More... | |
bool | operator!= (const Sizer &other) const noexcept |
Check if two sizers are not equal. More... | |
void | swap (Sizer &other) noexcept |
+Protected Attributes | |
+size_t | m_bytes |
Current measured size in bytes. | |
Helper entity to measure size of dynamic objects in memory.
+
+
|
+ +inlinenoexcept | +
Initializes sizer with another sizer value.
+[in] | other | another sizer. |
+
|
+ +inlinenoexcept | +
Append bytes to current byte count.
+[in] | bytes | number of bytes to append. |
+
|
+ +inlinenoexcept | +
Append other sizer byte count to current byte count.
+[in] | other | sizer to take bytes from. |
+
|
+ +inlinenoexcept | +
Get current size.
+
+
|
+ +inlinenoexcept | +
Get current size.
+
+
|
+ +inlinenoexcept | +
Get current size.
+
+
|
+ +inlinenoexcept | +
Get current size.
+
+
|
+ +inlinenoexcept | +
Check whether size is zero.
+
+
|
+ +inlinenoexcept | +
Check whether size is zero.
+
+
|
+ +inlinenoexcept | +
Check if two sizers are not equal.
+[in] | other | sizer. |
+
|
+ +inlinenoexcept | +
Append bytes to current byte count.
+[in] | bytes | number of bytes to append. |
+
|
+ +inlinenoexcept | +
Append other sizer byte count to current byte count.
+[in] | other | sizer to take bytes from. |
+
|
+ +inlinenoexcept | +
Assign value of another sizer.
+[in] | other | sizer to take bytes from. |
+
|
+ +inlinenoexcept | +
Check if two sizers are equal.
+[in] | other | sizer. |
+
|
+ +inlinenoexcept | +
Swap contents with an other sizer.
+[in,out] | other | sizer to swap with. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::SubImage, including all inherited members.
+data | fsdk::SubImage | |
format | fsdk::SubImage | |
getDataAs() noexcept | fsdk::SubImage | inline |
getDataAs() const noexcept | fsdk::SubImage | inline |
getOrigin() const noexcept | fsdk::SubImage | inline |
getRect() const noexcept | fsdk::SubImage | inline |
getSize() const noexcept | fsdk::SubImage | inline |
height | fsdk::SubImage | |
pitch | fsdk::SubImage | |
SubImage() noexcept | fsdk::SubImage | inline |
width | fsdk::SubImage | |
x | fsdk::SubImage | |
y | fsdk::SubImage |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
#include <SubImage.h>
+Public Member Functions | |
+ | SubImage () noexcept |
intializes empty sub image. | |
template<typename T > | |
T * | getDataAs () noexcept |
template<typename T > | |
const T * | getDataAs () const noexcept |
Point2i | getOrigin () const noexcept |
Size | getSize () const noexcept |
Rect | getRect () const noexcept |
+Public Attributes | |
+void * | data |
Beginning of data sub image data. | |
+int | pitch |
Number of bytes to the next scanline of the sub image. | |
+int | x |
Sub image origin x coordinate. | |
+int | y |
Sub image origin y coordinate. | |
+int | width |
Sub image width. | |
+int | height |
Sub image height. | |
+Format | format |
Sub image format. | |
Sub Image.
+Represents an image region of given size. Provides easy access to image internal data without any lifetime management capabilities.
+
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::SubjectiveQuality, including all inherited members.
+blur (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
darkness (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
illumination (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
isBlurred (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
isDark (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
isGood() const noexcept | fsdk::SubjectiveQuality | inline |
isHighlighted (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
isIlluminated (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
isNotSpecular (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
light (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality | |
specularity (defined in fsdk::SubjectiveQuality) | fsdk::SubjectiveQuality |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Subjective Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: + More...
+ +#include <IQualityEstimator.h>
+Public Member Functions | |
bool | isGood () const noexcept |
+Public Attributes | |
+float | blur |
+float | light |
+float | darkness |
+float | illumination |
+float | specularity |
+bool | isBlurred |
+bool | isHighlighted |
+bool | isDark |
+bool | isIlluminated |
+bool | isNotSpecular |
Subjective Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings:
+blur:
image blur degree. 1 - ok, 0 - too blured. light:
image brightness degree. 1 - ok, 0 - too bright; darkness:
image darkness degree. 1 - ok, 0 - too dark; illumination:
image illumination uniformity degree. 1 - ok, 0 - is too illuminated; specularity:
image specularity degree. 1 - ok, 0 - is not specular; isBlurred
image is blurred flag; isHighlighted
image is overlighted flag; isDark
image image is too dark flag; isIlluminated
image is too illuminated flag; isNotSpecular
image is not specular flag;
+
|
+ +inlinenoexcept | +
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Transformation, including all inherited members.
+angleDeg (defined in fsdk::Transformation) | fsdk::Transformation | |
centerP (defined in fsdk::Transformation) | fsdk::Transformation | |
detectionTopLeft (defined in fsdk::Transformation) | fsdk::Transformation | |
isValid (defined in fsdk::Transformation) | fsdk::Transformation | |
scale (defined in fsdk::Transformation) | fsdk::Transformation |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Transformation data structure, used for warping. + More...
+ +#include <IWarper.h>
+Public Attributes | |
+Vector2< float > | centerP = {0, 0} |
+float | angleDeg = 0 |
+float | scale = 0 |
+Vector2< int > | detectionTopLeft = {0, 0} |
+bool | isValid = false |
Transformation data structure, used for warping.
+Use this structure to perform image and landmarks transformations.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Vector2< T >, including all inherited members.
+operator!=(const Vector2 &other) const noexcept | fsdk::Vector2< T > | inline |
operator*(const Vector2 &rhs) const noexcept | fsdk::Vector2< T > | inline |
operator*(T rhs) const noexcept | fsdk::Vector2< T > | inline |
operator*=(const Vector2 &rhs) noexcept | fsdk::Vector2< T > | inline |
operator*=(T rhs) noexcept | fsdk::Vector2< T > | inline |
operator+(const Vector2 &rhs) const noexcept | fsdk::Vector2< T > | inline |
operator+(T rhs) const noexcept | fsdk::Vector2< T > | inline |
operator+=(const Vector2 &rhs) noexcept | fsdk::Vector2< T > | inline |
operator+=(T rhs) noexcept | fsdk::Vector2< T > | inline |
operator-(void) const noexcept | fsdk::Vector2< T > | inline |
operator-(const Vector2 &rhs) const noexcept | fsdk::Vector2< T > | inline |
operator-(T rhs) const noexcept | fsdk::Vector2< T > | inline |
operator-=(const Vector2 &rhs) noexcept | fsdk::Vector2< T > | inline |
operator-=(T rhs) noexcept | fsdk::Vector2< T > | inline |
operator/(const Vector2 &rhs) const noexcept | fsdk::Vector2< T > | inline |
operator/(T rhs) const noexcept | fsdk::Vector2< T > | inline |
operator/=(const Vector2 &rhs) noexcept | fsdk::Vector2< T > | inline |
operator/=(T rhs) noexcept | fsdk::Vector2< T > | inline |
operator<(const Vector2 &other) const noexcept | fsdk::Vector2< T > | inline |
operator<=(const Vector2 &other) const noexcept | fsdk::Vector2< T > | inline |
operator=(const Vector2< Other > &other) noexcept | fsdk::Vector2< T > | inline |
operator==(const Vector2 &other) const noexcept | fsdk::Vector2< T > | inline |
operator>(const Vector2 &other) const noexcept | fsdk::Vector2< T > | inline |
operator>=(const Vector2 &other) const noexcept | fsdk::Vector2< T > | inline |
operator[](int n) noexcept | fsdk::Vector2< T > | inline |
operator[](int n) const noexcept | fsdk::Vector2< T > | inline |
Vector2() noexcept | fsdk::Vector2< T > | inline |
Vector2(T x_) noexcept | fsdk::Vector2< T > | inlineexplicit |
Vector2(T x_, T y_) noexcept | fsdk::Vector2< T > | inline |
Vector2(const Vector2< Other > &other) noexcept | fsdk::Vector2< T > | inline |
x | fsdk::Vector2< T > | |
y | fsdk::Vector2< T > |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
Generic 2D vector. + More...
+ +#include <Vector2.h>
+Public Member Functions | |
+ | Vector2 () noexcept |
Initializes a vector with zeroes. | |
Vector2 (T x_) noexcept | |
Initializes all elements with the same value. More... | |
Vector2 (T x_, T y_) noexcept | |
Initializes elements with given value. More... | |
template<typename Other > | |
Vector2 (const Vector2< Other > &other) noexcept | |
Copies another vector. More... | |
template<typename Other > | |
Vector2< T > & | operator= (const Vector2< Other > &other) noexcept |
Copies another vector. More... | |
bool | operator== (const Vector2 &other) const noexcept |
Checks if two vectors are equal. More... | |
bool | operator!= (const Vector2 &other) const noexcept |
Checks if two vectors are not equal. More... | |
bool | operator> (const Vector2 &other) const noexcept |
Checks if both coordinates are greater then respective coordinates of another vector. More... | |
bool | operator>= (const Vector2 &other) const noexcept |
Checks if both coordinates are greater or equal to respective coordinates of another vector. More... | |
bool | operator< (const Vector2 &other) const noexcept |
Checks if both coordinates are smaller then respective coordinates of another vector. More... | |
bool | operator<= (const Vector2 &other) const noexcept |
Checks if both coordinates are smaller or equal to respective coordinates of another vector. More... | |
T & | operator[] (int n) noexcept |
Indexes the vector. More... | |
const T & | operator[] (int n) const noexcept |
Indexes the vector. More... | |
Vector2 | operator- (void) const noexcept |
Negates all elements. More... | |
Vector2 | operator+ (const Vector2 &rhs) const noexcept |
Adds (per-element) two vectors. More... | |
Vector2 | operator- (const Vector2 &rhs) const noexcept |
Subtracts (per-element) two vectors. More... | |
Vector2 | operator* (const Vector2 &rhs) const noexcept |
Multiplies (per-element) two vectors. More... | |
Vector2 | operator/ (const Vector2 &rhs) const noexcept |
Divides (per-element) two vectors. More... | |
Vector2 & | operator+= (const Vector2 &rhs) noexcept |
Adds (per-element) two vectors. More... | |
Vector2 & | operator-= (const Vector2 &rhs) noexcept |
Subtracts (per-element) two vectors. More... | |
Vector2 & | operator*= (const Vector2 &rhs) noexcept |
Multiplies (per-element) two vectors. More... | |
Vector2 & | operator/= (const Vector2 &rhs) noexcept |
Divides (per-element) two vectors. More... | |
Vector2 | operator+ (T rhs) const noexcept |
Adds (per-element) a constant to each element of the vector. More... | |
Vector2 | operator- (T rhs) const noexcept |
Subtracts (per-element) a constant to each element of the vector. More... | |
Vector2 | operator* (T rhs) const noexcept |
Multiplies (per-element) a constant to each element of the vector. More... | |
Vector2 | operator/ (T rhs) const noexcept |
Divides (per-element) a constant to each element of the vector. More... | |
Vector2 & | operator+= (T rhs) noexcept |
Adds (per-element) a constant to each element of the vector. More... | |
Vector2 & | operator-= (T rhs) noexcept |
Subtracts (per-element) a constant to each element of the vector. More... | |
Vector2 & | operator*= (T rhs) noexcept |
Multiplies (per-element) a constant to each element of the vector. More... | |
Vector2 & | operator/= (T rhs) noexcept |
Divides (per-element) a constant to each element of the vector. More... | |
+Public Attributes | |
+T | x |
x coordinate. | |
+T | y |
y coordinate. | |
Generic 2D vector.
+T | any POD numeric type. |
+
|
+ +inlineexplicitnoexcept | +
Initializes all elements with the same value.
+[in] | x_ | value to initialize with. |
+
|
+ +inlinenoexcept | +
Initializes elements with given value.
+[in] | x_ | x coordinate value. |
[in] | y_ | y coordinate value. |
+
|
+ +inlinenoexcept | +
Copies another vector.
+[in] | other | another vector. |
+
|
+ +inlinenoexcept | +
Checks if two vectors are not equal.
+[in] | other | vector to check against. |
+
|
+ +inlinenoexcept | +
Multiplies (per-element) two vectors.
+[in] | rhs | vector to multiply by. |
+
|
+ +inlinenoexcept | +
Multiplies (per-element) a constant to each element of the vector.
+[in] | rhs | value to multiply by. |
+
|
+ +inlinenoexcept | +
Multiplies (per-element) two vectors.
+[in] | rhs | vector to multiply by. |
+
|
+ +inlinenoexcept | +
Multiplies (per-element) a constant to each element of the vector.
+[in] | rhs | value to multiply by. |
+
|
+ +inlinenoexcept | +
Adds (per-element) two vectors.
+[in] | rhs | vector to add. |
+
|
+ +inlinenoexcept | +
Adds (per-element) a constant to each element of the vector.
+[in] | rhs | value to add. |
+
|
+ +inlinenoexcept | +
Adds (per-element) two vectors.
+[in] | rhs | vector to add. |
+
|
+ +inlinenoexcept | +
Adds (per-element) a constant to each element of the vector.
+[in] | rhs | value to add. |
+
|
+ +inlinenoexcept | +
Negates all elements.
+
+
|
+ +inlinenoexcept | +
Subtracts (per-element) two vectors.
+[in] | rhs | vector to subtract. |
+
|
+ +inlinenoexcept | +
Subtracts (per-element) a constant to each element of the vector.
+[in] | rhs | value to subtract. |
+
|
+ +inlinenoexcept | +
Subtracts (per-element) two vectors.
+[in] | rhs | vector to subtract. |
+
|
+ +inlinenoexcept | +
Subtracts (per-element) a constant to each element of the vector.
+[in] | rhs | value to subtract. |
+
|
+ +inlinenoexcept | +
Divides (per-element) two vectors.
+[in] | rhs | vector to divide by. |
+
|
+ +inlinenoexcept | +
Divides (per-element) a constant to each element of the vector.
+[in] | rhs | value to divide by. |
+
|
+ +inlinenoexcept | +
Divides (per-element) two vectors.
+[in] | rhs | vector to divide by. |
+
|
+ +inlinenoexcept | +
Divides (per-element) a constant to each element of the vector.
+[in] | rhs | value to divide by. |
+
|
+ +inlinenoexcept | +
Checks if both coordinates are smaller then respective coordinates of another vector.
+[in] | other | vector to check against. |
+
|
+ +inlinenoexcept | +
Checks if both coordinates are smaller or equal to respective coordinates of another vector.
+[in] | other | vector to check against. |
+
|
+ +inlinenoexcept | +
Copies another vector.
+[in] | other | another vector. |
+
|
+ +inlinenoexcept | +
Checks if two vectors are equal.
+[in] | other | vector to check against. |
+
|
+ +inlinenoexcept | +
Checks if both coordinates are greater then respective coordinates of another vector.
+[in] | other | vector to check against. |
+
|
+ +inlinenoexcept | +
Checks if both coordinates are greater or equal to respective coordinates of another vector.
+[in] | other | vector to check against. |
+
|
+ +inlinenoexcept | +
Indexes the vector.
+[in] | n | element index. |
+
|
+ +inlinenoexcept | +
Indexes the vector.
+[in] | n | element index. |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::Version, including all inherited members.
+major | fsdk::Version | |
minor | fsdk::Version | |
patch | fsdk::Version |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
#include <Version.h>
+Public Attributes | |
+uint8_t | major |
Major version number. | |
+uint8_t | minor |
Minor version number. | |
+uint16_t | patch |
Revision number. | |
Version structure.
+![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
This is the complete list of members for fsdk::ISettingsProvider::Value::Data, including all inherited members.
+m_float1 | fsdk::ISettingsProvider::Value::Data | |
m_float2 | fsdk::ISettingsProvider::Value::Data | |
m_float3 | fsdk::ISettingsProvider::Value::Data | |
m_float4 | fsdk::ISettingsProvider::Value::Data | |
m_int1 | fsdk::ISettingsProvider::Value::Data | |
m_int2 | fsdk::ISettingsProvider::Value::Data | |
m_int3 | fsdk::ISettingsProvider::Value::Data | |
m_int4 | fsdk::ISettingsProvider::Value::Data | |
m_string | fsdk::ISettingsProvider::Value::Data |
![]() |
+
+ Face Engine SDK
+ 5.8.0
+
+ A face detection, recognition and tracking engine.
+ |
+
#include <ISettingsProvider.h>
+Classes | |
struct | Float1 |
struct | Float2 |
struct | Float3 |
struct | Float4 |
struct | Int1 |
struct | Int2 |
struct | Int3 |
struct | Int4 |
struct | String |
+Public Attributes | |
+struct +fsdk::ISettingsProvider::Value::Data::Int1 | m_int1 |
Data as integer. | |
+struct +fsdk::ISettingsProvider::Value::Data::Int2 | m_int2 |
Data as 2D integer. | |
+struct +fsdk::ISettingsProvider::Value::Data::Int3 | m_int3 |
Data as 3D integer. | |
+struct +fsdk::ISettingsProvider::Value::Data::Int4 | m_int4 |
Data as 4D integer. | |
+struct +fsdk::ISettingsProvider::Value::Data::Float1 | m_float1 |
Data as float. | |
+struct +fsdk::ISettingsProvider::Value::Data::Float2 | m_float2 |
Data as 2D float. | |
+struct +fsdk::ISettingsProvider::Value::Data::Float3 | m_float3 |
Data as 3D float. | |
+struct +fsdk::ISettingsProvider::Value::Data::Float4 | m_float4 |
Data as 4D float. | |
+struct +fsdk::ISettingsProvider::Value::Data::String | m_string |
Data as string. | |
Value data.
+