Face Engine SDK
5.23.1
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 | DepthLivenessEstimation |
Depth estimator output structure. More... | |
struct | IDepthLivenessEstimator |
Depth 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 | FaceOcclusionEstimation |
FaceOcclusionEstimation structure. This structure is used to check for occlusions in various parts of the face (such as the lower face, nose, eyes, or forehead). It contains the result of FaceOcclusionState and FaceOcclusionType estimations for each image. More... | |
struct | IFaceOcclusionEstimator |
FaceOcclusion 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 | DepthRGBEstimation |
Depth+RBG liveness estimation output structure. More... | |
struct | ILivenessDepthRGBEstimator |
Depth+RGB 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 | SmileTypeScores |
Scores of smile type. Probability scores are defined in [0,1] range. Scores in this struct sum up to 1.0. We use them to decide if person is smiling with teeth's exposed or not. More... | |
struct | MouthEstimation |
Mouth estimator output structure. Stores flags that indicates which mouth feature is present. Multiple state flags may be set to true meaning that the final mouth state is a combination of those. Probability scores are defined in [0,1] range. More... | |
struct | MouthEstimationExtended |
Extended mouth estimator output structure. Stores flags that indicates which mouth feature is present. Multiple state flags may be set to true meaning that the final mouth state is a combination of those. Probability scores are defined in [0,1] range. More... | |
struct | IMouthEstimator |
Mouth estimator interface. More... | |
struct | NIRLivenessEstimation |
NIR Liveness estimation structure. Each score in normalized [0, 1] range, state shows real person or not. More... | |
struct | INIRLivenessEstimator |
Infra red liveness 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... | |
struct | IDetectionBatch |
Detection result batch 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 | IFaceLandmarksBatch |
Landmarks result batch interface. More... | |
struct | IFaceLandmarksDetector |
struct | IImagesBatch |
Result of ImageTransfer module. More... | |
struct | IImageTransfer |
Image transfer facility which give speed up of usage internal memory pool. 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 | IPointBatch |
Points result batch interface. 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 | 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 | Future |
Future class to support asynchronous data retrieval Look into std::future semantics to understand it. More... | |
class | Promise |
Promise class to support asynchronous data retrieval Look into std::promise semantics to understand it. More... | |
struct | ErrorTraits< FutureError > |
Specialized for Future::Error. More... | |
struct | ErrorTraits< PromiseError > |
Specialized for Promise::Error. More... | |
struct | Human |
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 | Transformation |
Transformation data structure, used for warping. More... | |
struct | Vector2 |
Generic 2D vector. More... | |
struct | Version |
Typedefs | |
typedef Vector2< float > | Landmark |
Landmark floating point coordinates type. | |
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 | FaceOcclusionType { Forehead = 0, LeftEye, RightEye, Nose, Mouth, LowerFace, Count } |
FaceOcclusionType enum. This enum contains all possible facial occlusion types. More... | |
enum | FaceOcclusionState { NotOccluded = 0, Occluded, Count } |
FaceOcclusionState enum. This enum contains all possible facial occlusion states. More... | |
enum | GlassesEstimation { NoGlasses, EyeGlasses, SunGlasses, EstimationError } |
Glasses estimation enum. More... | |
enum | MedicalMask { Mask = 0, NoMask, OccludedFace } |
MedicalMask estimator output enum. This enum contains all possible estimation results. More... | |
enum | MedicalMaskExtended { Mask = 0, NoMask, MaskNotInPlace, OccludedFace } |
MedicalMask estimator output enum. This enum contains all possible extended estimation results. More... | |
enum | DetailedMaskType { CorrectMask = 0, MouthCoveredWithMask, ClearFace, ClearFaceWithMaskUnderChin, PartlyCoveredFace, FullMask, Count } |
MedicalMask estimator output enum. This enum contains all type of DetailedMaskType results. More... | |
enum | SmileType { None, SmileLips, SmileOpen } |
MouthEstimationExtended smile type enum. This enum contains all possible smile types. More... | |
enum | NIRLivenessMode { Default, M1, M2 } |
NIRLiveness estimation mode. Currently, available values to select the estimation mode are: Default, M1 and M2. The scenario `Default` means the mode is specified in config file. More... | |
enum | FSDKError { Ok, Internal, InvalidInput, InvalidImage, InvalidRect, InvalidImageFormat, InvalidImageSize, InvalidDetection, InvalidLandmarks5, InvalidLandmarks68, InvalidTransformation, InvalidDescriptor, InvalidDescriptorBatch, InvalidSettingsProvider, InvalidDescriptorId, InvalidPath, InvalidSerializedObject, ModuleNotInitialized, ModuleNotReady, LicenseError, BufferIsNull, BufferIsFull, BufferIsEmpty, InvalidBufferSize, InvalidSpanSize, InvalidBatch, IncompatibleDescriptors, EnableJustInBetaMode, FiltredAggregationError, BatchedInternalError, UnsupportedFunctionality, HighMemoryUsage, IncompatibleModelVersions, ModelNotLoaded, InvalidConfig, LicenseIsNotActivated, LicenseActivationLimitExceeded, FeatureNotAvailable, FeatureExpired, FingerprintError, ValidationFailed, CudaError, 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 { DV_MIN_FACE_DESCRIPTOR_VERSION = 54, DV_MIN_HUMAN_DESCRIPTOR_VERSION = 102 } |
Minimum descriptor model version. Determines which minimum version of descriptor to use. More... | |
enum | HumanDescriptorVersion { HDV_TRACKER_HUMAN_DESCRIPTOR_VERSION = 102, HDV_PRECISE_HUMAN_DESCRIPTOR_VERSION = 103, HDV_REGULAR_HUMAN_DESCRIPTOR_VERSION = 104, HDV_TRACKER_V2 = 105, HDV_PRECISE_V2 = 106, HDV_REGULAR_V2 = 107, HDV_TRACKER_V3 = 108, HDV_PRECISE_V3 = 109, HDV_REGULAR_V3 = 110, HDV_PRECISE_V4 = 112, HDV_REGULAR_V4 = 113, HDV_PRECISE_V5 = 115, HDV_REGULAR_V5 = 116 } |
Human descriptor model versions. Determines which version of human descriptor to use. More... | |
enum | ObjectDetectorClassType { FACE_DET_DEFAULT = 0, FACE_DET_V1 = 4, FACE_DET_V2 = 5, FACE_DET_V3 = 6, FACE_DET_V3M = 7, FACE_DET_COUNT = 8 } |
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 | LicenseFeature { 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, DeepFakeEstimation = 22, DepthRGBLiveness = 23, FightsEstimation = 24, BodyAttributes = 25, NIRLiveness = 26, DepthLiveness = 27, VirtualCameraChecker = 500 } |
License features. | |
enum | DeviceClass { CPU = 0, GPU = 1, CPU_ARM = 2, CPU_AVX2, CPU_AUTO, GPU_INT8, CPU_ARM_INT8, NPU_ASCEND, Invalid = -1 } |
DeviceClass specifies which device/instruction set to use for cnn inference. | |
enum | FaceEngineEdition { FrontEndEdition, CompleteEdition } |
enum | ExecutionPolicy { Sync, Async } |
Enum to tell some method how to behave. More... | |
enum | FuturePromiseState { Empty, Promised, Fulfilled, CancelRequested, Canceled, Failed, Broken } |
Enumeration of possible future or promise states. More... | |
enum | FutureError { Ok, InvalidInput, NotPromised, NotFulfilled, NonWaitable, Timeout, Internal } |
Enumeration of possible Future errors. More... | |
enum | PromiseError { Ok, Internal, StateNotCancelable, StateNotFailable, StateNotFulfillable, StateDoesntAllowFutureCreation } |
Enumeration of possible Promise errors. More... | |
enum | OrientationType { OT_NORMAL = 0, OT_LEFT = 1, OT_UPSIDE_DOWN = 2, OT_RIGHT = 3 } |
Estimation of image orientation. More... | |
enum | RotationType { RT_NONE = 0, RT_LEFT = 1, RT_UPSIDE_DOWN = 2, RT_RIGHT = 3 } |
Image rotation type. More... | |
enum | SensorType { Visible = 0, NIR } |
Sensor type structure. Determines which type of camera sensor is used to perform face recognition. 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. | |
FSDK_API Result< FSDKError > | activateLicense (ILicense *license, ISettingsProvider *settings) noexcept |
Makes License activation with some platform specific manner. Network connection is required. | |
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. | |
FSDK_API ResultValue < FSDKError, ISettingsProviderPtr > | createSettingsProvider (const char *path) noexcept |
Create a settings provider. | |
FSDK_API ResultValue < FSDKError, ISettingsProviderPtr > | createSettingsProviderFromString (const char *content) noexcept |
Creates a settings provider from the xml-formatted string. | |
constexpr int | format_as (Format::Type in) |
const char * | toString (Image::MemoryResidence residence) |
Returns a string representation of a MemoryResidence type. | |
Landmarks5 FSDK_API | convert (const Landmarks68 &landmarks) |
convert landmarks68 into landmarks5 | |
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 | |
template<typename T > | |
Ref< T > | make_ref (T *ptr) noexcept |
Make smart reference to a IRefCounted based object without acquiring ownership. | |
template<typename S , typename T > | |
Ref< S > | make_ref_as (T *ptr) noexcept |
Make smart reference to a IRefCounted based object without acquiring ownership. | |
template<typename T > | |
Ref< T > | acquire (T *ptr) noexcept |
Acquire ownership of IRefCounted based object. | |
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. | |
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. | |
bool | operator< (Version lhs, Version rhs) noexcept |
Check if one version is less than another. | |
bool | operator== (Version lhs, Version rhs) noexcept |
Check if versions are equal. | |
bool | operator!= (Version lhs, Version rhs) noexcept |
Check if versions are not equal. | |
FSDK_API Version | getVersion () noexcept |
Get FaceEngine version. | |
FSDK_API const char * | getVersionHash () noexcept |
Get FaceEngine commit hash. | |
FSDK_API const char * | getVersionString () noexcept |
Get FaceEngine version string. | |
FSDK_API const char * | getBuildInfo () noexcept |
Get FaceEngine build description. The descripton contains used flags and compler settings. |
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
enum fsdk::FSDKError |
Common SDK error codes.
enum fsdk::FutureError |
Enumeration of possible Future errors.
Ok |
Ok. All good. |
InvalidInput |
Invalid input. 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 |
Internal error. Some internal error. |
Enumeration of possible future or promise states.
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. |
enum fsdk::PromiseError |
Enumeration of possible Promise errors.
Ok |
Ok. All good. |
Internal |
Internal error. Some internal error. |
StateNotCancelable |
Error if you call.
|
StateNotFailable |
Error if you call.
|
StateNotFulfillable |
Error if you call.
|
StateDoesntAllowFutureCreation |
Error if you call.
|
enum fsdk::RotationType |
Image rotation type.
enum fsdk::SensorType |
Ref<T> fsdk::acquire | ( | T * | ptr | ) | [inline] |
Acquire ownership of IRefCounted based object.
T | object interface (must be derived from IRefCounted). |
[in] | ptr | raw pointer. |
Ref<S> fsdk::acquire_as | ( | T * | ptr | ) | [inline] |
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. |
BaseRect<Type> fsdk::centerScale | ( | const BaseRect< Type > & | in, |
float | scaleFactor | ||
) |
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 |
Ref<T> fsdk::make_ref | ( | T * | ptr | ) | [inline] |
Make smart reference to a IRefCounted based object without acquiring ownership.
T | object interface (must be derived from IRefCounted). |
[in] | ptr | raw pointer. |
Ref<S> fsdk::make_ref_as | ( | T * | ptr | ) | [inline] |
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. |
ResultValue<R, typename std::remove_const<typename std::remove_reference<V>::type>::type> fsdk::makeResultValue | ( | R | result, |
V && | value | ||
) | [inline] |
Addon for Result to output some value aside the result.
R | result enumeration type. |
V | result value type. |
result | the result. |
value | the value. |
const char* fsdk::toString | ( | Image::MemoryResidence | residence | ) |
Returns a string representation of a MemoryResidence type.