![]() |
Face Engine SDK
5.15.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... | |
| 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 | IHeadDetector |
| struct | IHumanDetectionBatch |
| Human detection result batch interface. More... | |
| struct | IHumanDetector |
| human body detector interface. More... | |
| struct | HumanFaceAssociation |
| Type for human and face association. More... | |
| struct | IHumanFaceBatch |
| HumanFace result batch interface. More... | |
| struct | IHumanFaceDetector |
| Human and face detector interface. More... | |
| struct | IHumanLandmarksBatch |
| Landmarks result batch interface. More... | |
| struct | IHumanLandmarksDetector |
| 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 = vlc::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 |
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) |
| HumanFaceDetectionType | operator| (HumanFaceDetectionType a, HumanFaceDetectionType b) |
| bool | operator& (HumanFaceDetectionType lhs, HumanFaceDetectionType rhs) |
| FSDK_API ResultValue < FSDKError, ISettingsProviderPtr > | createSettingsProviderFromString (const char *content) noexcept |
| Creates a settings provider from the xml-formatted string. More... | |
| 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 |
|
strong |
Common SDK error codes.
|
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. |
| 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.
|
| enum fsdk::RotationType : uint32_t |
Image rotation type.
| Enumerator | |
|---|---|
| RT_NONE |
Leave image as it is. |
| RT_LEFT |
Turn image to the left by 90 deg. |
| RT_UPSIDE_DOWN |
Flip image upside down (turn by 180 deg) |
| RT_RIGHT |
Turn image to the right by 90 deg. |
|
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. |