| Face Engine SDK 5.35.0 A face detection, recognition and tracking engine.

IFaceEnginePos.h
1 #pragma once
2
3 #include <fsdk/Def.h>
4 #include <fsdk/IObject.h>
5 #include <fsdk/ILicense.h>
6 #include <fsdk/IDetector.h>
7 #include <fsdk/IDescriptor.h>
8 #include <fsdk/ISettingsProvider.h>
9 #include <fsdk/IWarper.h>
10 #include <fsdk/Log.h>
11 #include <fsdk/Version.h>
12
13 #include <fsdk/Estimators/IHeadPoseEstimator.h>
14 #include <fsdk/Estimators/IGlassesEstimator.h>
15 #include <fsdk/Estimators/IMedicalMaskEstimator.h>
16 #include <fsdk/Estimators/IQualityEstimator.h>
17 #include <fsdk/Estimators/ISubjectiveQualityEstimator.h>
18
19 #include <fsdk/Types/FaceEngineEdition.h>
20
43 namespace fsdk {
45
46 #ifndef DOXYGEN_SHOULD_SKIP_THIS
47 DECLARE_SMARTPTR(IFaceEnginePos);
48 #endif
49
59 struct IFaceEnginePos : IRefCounted {
60
65 virtual ResultValue<FSDKError, IDetectorPtr> createDetector() noexcept = 0;
66
71 virtual ResultValue<FSDKError, IHeadPoseEstimatorPtr> createHeadPoseEstimator() noexcept = 0;
72
78 virtual ResultValue<FSDKError, IMedicalMaskEstimatorPtr> createMedicalMaskEstimator() noexcept = 0;
79
85 virtual ResultValue<FSDKError, IGlassesEstimatorPtr> createGlassesEstimator() noexcept = 0;
86
92 FSDK_DEPRECATED("createQualityEstimator is deprecated since v.5.32.0, "
93 "use createSubjectiveQualityEstimator instead!")
94 virtual ResultValue<FSDKError, IQualityEstimatorPtr> createQualityEstimator() noexcept = 0;
95
101 virtual ResultValue<FSDKError, ISubjectiveQualityEstimatorPtr>
102 createSubjectiveQualityEstimator() noexcept = 0;
103
112 virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(uint32_t version = 0) noexcept = 0;
113
120 virtual ResultValue<FSDKError, IDescriptorPtr>
121 createDescriptor(IArchive* archive, uint32_t flags = 0) noexcept = 0;
122
133 virtual ResultValue<FSDKError, IDescriptorBatchPtr>
134 createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;
135
145 virtual ResultValue<FSDKError, IDescriptorExtractorPtr>
146 createExtractor(uint32_t version = 0) noexcept = 0;
147
156 virtual ResultValue<FSDKError, IDescriptorMatcherPtr> createMatcher(uint32_t version = 0) noexcept = 0;
157
162 virtual ResultValue<FSDKError, IWarperPtr> createWarper() noexcept = 0;
163
171 virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;
172
177 virtual void setDataDirectory(const char* path) noexcept = 0;
178
184 virtual const char* getDataDirectory() const noexcept = 0;
185
190 virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;
191
196 virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;
197
202 virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
203
208 virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;
209
214 virtual ILicense* getLicense() const noexcept = 0;
215 };
216
226 FSDK_API Result<FSDKError>
227 activateLicense(ILicense* license, const char* configPath, const char* json = nullptr) noexcept;
228
238 FSDK_API Result<FSDKError>
239 activateLicense(ILicense* license, ISettingsProvider* settings, const char* json = nullptr) noexcept;
240
246 FSDK_API ResultValue<FSDKError, Fingerprint> getFingerprint(const ISettingsProvider* settings) noexcept;
247
256 FSDK_API ResultValue<FSDKError, IFaceEnginePosPtr> createFaceEngineMobile(
257 const char* dataPath = nullptr,
258 const char* configPath = nullptr,
259 const char* runtimePath = nullptr) noexcept;
260
266 FSDK_API ResultValue<FSDKError, ISettingsProviderPtr> createSettingsProvider(const char* path) noexcept;
267
274 FSDK_API ResultValue<FSDKError, ISettingsProviderPtr>
275 createSettingsProviderFromString(const char* content) noexcept;
276
277
278 } // namespace fsdk
fsdk::IFaceEnginePos::getFaceEngineEdition
virtual FaceEngineEdition getFaceEngineEdition() const noexcept=0
Get LUNA SDK distribution edition.
fsdk::IFaceEnginePos::FSDK_DEPRECATED
FSDK_DEPRECATED("createQualityEstimator is deprecated since v.5.32.0, " "use createSubjectiveQualityEstimator instead!") virtual ResultValue< FSDKError
Creates Quality estimator.
fsdk::IFaceEnginePos::createGlassesEstimator
virtual ResultValue< FSDKError, IGlassesEstimatorPtr > createGlassesEstimator() noexcept=0
Creates Glasses estimator.
fsdk::activateLicense
FSDK_API Result< FSDKError > activateLicense(ILicense *license, const char *configPath, const char *json=nullptr) noexcept
Makes License activation with some platform specific manner. Network connection is required...
FSDK_API
#define FSDK_API
Dummy.
Definition: Def.h:27
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:70
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
IWarper.h
Image and landmarks warping.
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
fsdk::IFaceEnginePos::getRuntimeSettingsProvider
virtual ISettingsProvider * getRuntimeSettingsProvider() const noexcept=0
Gets runtime settings provider.
fsdk::IFaceEnginePos::createDetector
virtual ResultValue< FSDKError, IDetectorPtr > createDetector() noexcept=0
Creates a detector of given type.
IObject.h
Object system types and interfaces.
fsdk::ILicense
License objects interface.
Definition: ILicense.h:84
fsdk::createSettingsProviderFromString
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProviderFromString(const char *content) noexcept
Creates a settings provider from the xml-formatted string.
fsdk::IFaceEnginePos::setDataDirectory
virtual void setDataDirectory(const char *path) noexcept=0
Sets data directory.
fsdk::getFingerprint
FSDK_API ResultValue< FSDKError, Fingerprint > getFingerprint(const ISettingsProvider *settings) noexcept
Gets the device fingerprint which could be used for the offline activation.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:37
fsdk::createFaceEngineMobile
FSDK_API ResultValue< FSDKError, IFaceEnginePosPtr > createFaceEngineMobile(const char *dataPath=nullptr, const char *configPath=nullptr, const char *runtimePath=nullptr) noexcept
Create the LUNA SDK root object.
Version.h
SDK version information routines.
Log.h
Log interfaces.
fsdk::IFaceEnginePos
Root LUNA SDK object interface.
Definition: IFaceEnginePos.h:59
fsdk::IFaceEnginePos::getDataDirectory
virtual const char * getDataDirectory() const noexcept=0
Gets data directory.
fsdk::IFaceEnginePos::setRuntimeSettingsProvider
virtual void setRuntimeSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets runtime settings provider.
IDescriptor.h
Descriptor extractor and matcher interfaces.
fsdk::IFaceEnginePos::createDescriptorBatch
virtual ResultValue< FSDKError, IDescriptorBatchPtr > createDescriptorBatch(int32_t size, uint32_t version=0) noexcept=0
Creates Batch of descriptors.
Def.h
Common SDK definitions.
fsdk::ResultValue
Addon for Result to output some value aside the result. Specialization for copiable types...
Definition: ResultValue.h:21
fsdk::IFaceEnginePos::createMedicalMaskEstimator
virtual ResultValue< FSDKError, IMedicalMaskEstimatorPtr > createMedicalMaskEstimator() noexcept=0
Creates MedicalMask estimator.
IDetector.h
Face detector interfaces.
fsdk::IFaceEnginePos::createDescriptor
virtual ResultValue< FSDKError, IDescriptorPtr > createDescriptor(uint32_t version=0) noexcept=0
Creates Descriptor.
fsdk::IFaceEnginePos::createMatcher
virtual ResultValue< FSDKError, IDescriptorMatcherPtr > createMatcher(uint32_t version=0) noexcept=0
Creates descriptor matcher.
fsdk::Fingerprint
Fingreprint structure.
Definition: ILicense.h:47
fsdk::IFaceEnginePos::createWarper
virtual ResultValue< FSDKError, IWarperPtr > createWarper() noexcept=0
Creates warper.
fsdk::IFaceEnginePos::createExtractor
virtual ResultValue< FSDKError, IDescriptorExtractorPtr > createExtractor(uint32_t version=0) noexcept=0
Creates descriptor extractor.
fsdk::IFaceEnginePos::createHeadPoseEstimator
virtual ResultValue< FSDKError, IHeadPoseEstimatorPtr > createHeadPoseEstimator() noexcept=0
Creates Head pose estimator.
fsdk::IArchive
Archive interface.
Definition: IObject.h:38
fsdk::FSDKError
FSDKError
Common SDK error codes.
Definition: FSDKError.h:17
fsdk::IFaceEnginePos::createSubjectiveQualityEstimator
virtual ResultValue< FSDKError, ISubjectiveQualityEstimatorPtr > createSubjectiveQualityEstimator() noexcept=0
Creates Subjective quality estimator.
ISettingsProvider.h
Settings provider interface.
fsdk::IFaceEnginePos::getLicense
virtual ILicense * getLicense() const noexcept=0
Get current License object, which was set for FaceEngine object.
fsdk::createSettingsProvider
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProvider(const char *path) noexcept
Creates a settings provider.
fsdk::IFaceEnginePos::setSettingsProvider
virtual void setSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets settings provider.
fsdk::ISettingsProvider
SDK settings provider interface.
Definition: ISettingsProvider.h:32
fsdk::IFaceEnginePos::getSettingsProvider
virtual ISettingsProvider * getSettingsProvider() const noexcept=0
Gets settings provider.