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

IFaceEngine.h
1
8 #pragma once
9
32 #include <fsdk/Log.h>
33 #include <fsdk/Version.h>
34 #include <fsdk/MemoryTrim.h>
35 #include <fsdk/RuntimeStatistics.h>
36 #include <fsdk/IObject.h>
37 #include <fsdk/ISettingsProvider.h>
38 #include <fsdk/IEstimator.h>
39 #include <fsdk/IDetector.h>
40 #include <fsdk/IFaceLandmarksDetector.h>
41 #include <fsdk/IHeadDetector.h>
42 #include <fsdk/IDescriptor.h>
43 #include <fsdk/IWarper.h>
44 #include <fsdk/IImageTransfer.h>
45 #include <fsdk/IHumanDetector.h>
46 #include <fsdk/IHumanFaceDetector.h>
47 #include <fsdk/IHumanWarper.h>
48 #include <fsdk/IIndex.h>
49 #include <fsdk/IAsyncContext.h>
50 #include <fsdk/ILicense.h>
51 #include <fsdk/LaunchOptions.h>
52 #include <fsdk/Exception.h>
53 #include <fsdk/Types/FaceEngineEdition.h>
54
56 namespace fsdk {
57
58 #ifndef DOXYGEN_SHOULD_SKIP_THIS
59 DECLARE_SMARTPTR(IFaceEngine);
60 #endif
61
71 struct IFaceEngine : IRefCounted {
72
81 virtual ResultValue<FSDKError, IDetectorPtr> createDetector(
82 ObjectDetectorClassType type = FACE_DET_DEFAULT,
83 SensorType mode = SensorType::Visible,
84 const LaunchOptions* launchOptions = nullptr) noexcept = 0;
85
92 virtual ResultValue<FSDKError, IHeadDetectorPtr>
93 createHeadDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
94
102 virtual ResultValue<FSDKError, IFaceLandmarksDetectorPtr> createFaceLandmarksDetector(
103 SensorType mode = SensorType::Visible,
104 const LaunchOptions* launchOptions = nullptr) noexcept = 0;
105
106
107 virtual ResultValue<FSDKError, IOrientationEstimatorPtr>
108 createOrientationEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
109
116 virtual ResultValue<FSDKError, IHumanDetectorPtr>
117 createHumanDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
118
125 virtual ResultValue<FSDKError, IHumanFaceDetectorPtr>
126 createHumanFaceDetector(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
127
134 virtual ResultValue<FSDKError, IHeadPoseEstimatorPtr>
135 createHeadPoseEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
136
143 virtual ResultValue<FSDKError, IOverlapEstimatorPtr>
144 createOverlapEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
145
152 virtual ResultValue<FSDKError, IAGSEstimatorPtr>
153 createAGSEstimator(const LaunchOptions* options = nullptr) noexcept = 0;
154
161 virtual ResultValue<FSDKError, IAttributeEstimatorPtr>
162 createAttributeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
163
170 virtual ResultValue<FSDKError, IHumanAttributeEstimatorPtr>
171 createHumanAttributeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
172
179 FSDK_DEPRECATED("createQualityEstimator is deprecated since v.5.32.0, "
180 "use createSubjectiveQualityEstimator instead!")
181 virtual ResultValue<FSDKError, IQualityEstimatorPtr>
182 createQualityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
183
190 virtual ResultValue<FSDKError, ISubjectiveQualityEstimatorPtr>
191 createSubjectiveQualityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
192
199 virtual ResultValue<FSDKError, IBlackWhiteEstimatorPtr>
200 createBlackWhiteEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
201
208 virtual ResultValue<FSDKError, IDepthLivenessEstimatorPtr>
209 createDepthLivenessEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
210
217 virtual ResultValue<FSDKError, IImageModificationEstimatorPtr>
218 createImageModificationEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
219
226 virtual ResultValue<FSDKError, ILivenessOneShotRGBEstimatorPtr>
227 createLivenessOneShotRGBEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
228
235 virtual ResultValue<FSDKError, IMouthEstimatorPtr>
236 createMouthEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
237
244 virtual ResultValue<FSDKError, IMedicalMaskEstimatorPtr>
245 createMedicalMaskEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
246
253 virtual ResultValue<FSDKError, ILivenessFlyingFacesEstimatorPtr>
254 createLivenessFlyingFacesEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
255
256
264 virtual ResultValue<FSDKError, ILivenessRGBMEstimatorPtr>
265 createLivenessRGBMEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
266
274 virtual ResultValue<FSDKError, IEyeEstimatorPtr> createEyeEstimator(
275 SensorType mode = SensorType::Visible,
276 const LaunchOptions* launchOptions = nullptr) noexcept = 0;
277
284 virtual ResultValue<FSDKError, IEmotionsEstimatorPtr>
285 createEmotionsEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
286
294 virtual ResultValue<FSDKError, IGazeEstimatorPtr> createGazeEstimator(
295 SensorType mode = SensorType::Visible,
296 const LaunchOptions* launchOptions = nullptr) noexcept = 0;
297
304 virtual ResultValue<FSDKError, IGlassesEstimatorPtr>
305 createGlassesEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
306
313 virtual ResultValue<FSDKError, IFaceOcclusionEstimatorPtr>
314 createFaceOcclusionEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
315
322 virtual ResultValue<FSDKError, IBestShotQualityEstimatorPtr>
323 createBestShotQualityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
324
331 virtual ResultValue<FSDKError, ICredibilityCheckEstimatorPtr>
332 createCredibilityCheckEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
333
340 virtual ResultValue<FSDKError, IHeadWearEstimatorPtr>
341 createHeadWearEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
342
349 virtual ResultValue<FSDKError, IFacialHairEstimatorPtr>
350 createFacialHairEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
351
358 virtual ResultValue<FSDKError, IFishEyeEstimatorPtr>
359 createFishEyeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
360
367 virtual ResultValue<FSDKError, INaturalLightEstimatorPtr>
368 createNaturalLightEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
369
376 virtual ResultValue<FSDKError, IPPEEstimatorPtr>
377 createPPEEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
378
385 virtual ResultValue<FSDKError, IPortraitStyleEstimatorPtr>
386 createPortraitStyleEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
387
394 virtual ResultValue<FSDKError, IDynamicRangeEstimatorPtr>
395 createDynamicRangeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
396
403 virtual ResultValue<FSDKError, IBackgroundEstimatorPtr>
404 createBackgroundEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
405
412 virtual ResultValue<FSDKError, IRedEyeEstimatorPtr>
413 createRedEyeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
414
421 virtual ResultValue<FSDKError, IEyeBrowEstimatorPtr>
422 createEyeBrowEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
423
424 virtual ResultValue<FSDKError, IEthnicityEstimatorPtr>
425 createEthnicityEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
426
434 virtual ResultValue<FSDKError, ICrowdEstimatorPtr> createCrowdEstimator(
435 fsdk::CrowdEstimatorType type = fsdk::CrowdEstimatorType::CET_DEFAULT,
436 const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
437
438
448 virtual ResultValue<FSDKError, experimental::IDeepFakeEstimatorPtr>
449 createDeepFakeEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
450
458 virtual ResultValue<FSDKError, INIRLivenessEstimatorPtr> createNIRLivenessEstimator(
459 const NIRLivenessMode mode = NIRLivenessMode::Default,
460 const LaunchOptions* launchOptions = nullptr) noexcept = 0;
461
468 virtual ResultValue<FSDKError, IFightsEstimatorPtr>
469 createFightsEstimator(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
470
477 virtual ResultValue<FSDKError, IDutyUniformEstimatorPtr>
478 createDutyUniformEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
479
486 virtual ResultValue<FSDKError, ILightColoredClothesEstimatorPtr>
487 createLightColoredClothesEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
488
495 virtual ResultValue<FSDKError, IPhotorealisticFaceEstimatorPtr>
496 createPhotorealisticFaceEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
497
504 virtual ResultValue<FSDKError, INeckOcclusionEstimatorPtr>
505 createNeckOcclusionEstimator(const LaunchOptions* launchOptions = nullptr) noexcept = 0;
506
515 virtual ResultValue<FSDKError, IDescriptorPtr> createDescriptor(uint32_t version = 0) noexcept = 0;
516
524 virtual ResultValue<FSDKError, IDescriptorPtr>
525 createDescriptor(IArchive* archive, uint32_t flags = 0) noexcept = 0;
526
537 virtual ResultValue<FSDKError, IDescriptorBatchPtr>
538 createDescriptorBatch(int32_t size, uint32_t version = 0) noexcept = 0;
539
550 virtual ResultValue<FSDKError, IDescriptorExtractorPtr>
551 createExtractor(uint32_t version = 0, const LaunchOptions* launchOptions = nullptr) noexcept = 0;
552
562 virtual ResultValue<FSDKError, IDescriptorMatcherPtr> createMatcher(uint32_t version = 0) noexcept = 0;
563
571 virtual ResultValue<FSDKError, IIndexBuilderPtr>
572 createIndexBuilder(const size_t capacity = 0, uint32_t version = 0) noexcept = 0;
573
581 virtual ResultValue<FSDKError, IDenseIndexPtr> loadDenseIndex(const char* indexPath) noexcept = 0;
582
590 virtual ResultValue<FSDKError, IDynamicIndexPtr> loadDynamicIndex(const char* indexPath) noexcept = 0;
591
597 virtual ResultValue<FSDKError, IWarperPtr> createWarper() noexcept = 0;
598
604 virtual ResultValue<FSDKError, IHumanWarperPtr> createHumanWarper() noexcept = 0;
605
612 virtual ResultValue<FSDKError, IImageTransferPtr>
613 createImageTransfer(const LaunchOptions* LaunchOptions = nullptr) noexcept = 0;
614
621 virtual ResultValue<FSDKError, IAsyncContextPtr>
622 createAsyncContext(const int8_t threadCount) noexcept = 0;
623
631 virtual FaceEngineEdition getFaceEngineEdition() const noexcept = 0;
632
637 virtual void setDataDirectory(const char* path) noexcept = 0;
638
644 virtual const char* getDataDirectory() const noexcept = 0;
645
650 virtual void setSettingsProvider(ISettingsProvider* provider) noexcept = 0;
651
656 virtual void setRuntimeSettingsProvider(ISettingsProvider* provider) noexcept = 0;
657
662 virtual ISettingsProvider* getSettingsProvider() const noexcept = 0;
663
668 virtual ISettingsProvider* getRuntimeSettingsProvider() const noexcept = 0;
669
674 virtual ILicense* getLicense() const noexcept = 0;
675 };
676
686 FSDK_API Result<FSDKError>
687 activateLicense(ILicense* license, const char* configPath, const char* json = nullptr) noexcept;
688
698 FSDK_API Result<FSDKError>
699 activateLicense(ILicense* license, ISettingsProvider* settings, const char* json = nullptr) noexcept;
700
706 FSDK_API ResultValue<FSDKError, Fingerprint> getFingerprint(const ISettingsProvider* settings) noexcept;
707
719 FSDK_API ResultValue<FSDKError, IFaceEnginePtr> createFaceEngine(
720 const char* dataPath = nullptr,
721 const char* configPath = nullptr,
722 const char* runtimePath = nullptr) noexcept;
723
729 FSDK_API ResultValue<FSDKError, ISettingsProviderPtr> createSettingsProvider(const char* path) noexcept;
730
737 FSDK_API ResultValue<FSDKError, ISettingsProviderPtr>
738 createSettingsProviderFromString(const char* content) noexcept;
739
740
743 } // namespace fsdk
fsdk::IFaceEngine::createHeadWearEstimator
virtual ResultValue< FSDKError, IHeadWearEstimatorPtr > createHeadWearEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates HeadWear estimator.
fsdk::IFaceEngine::createWarper
virtual ResultValue< FSDKError, IWarperPtr > createWarper() noexcept=0
Creates warper.
fsdk::IFaceEngine::createHumanDetector
virtual ResultValue< FSDKError, IHumanDetectorPtr > createHumanDetector(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a human detector.
fsdk::IFaceEngine::createPortraitStyleEstimator
virtual ResultValue< FSDKError, IPortraitStyleEstimatorPtr > createPortraitStyleEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates PortraitStyle 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::IFaceEngine::createAGSEstimator
virtual ResultValue< FSDKError, IAGSEstimatorPtr > createAGSEstimator(const LaunchOptions *options=nullptr) noexcept=0
Creates AGS estimator.
fsdk::IFaceEngine::createDutyUniformEstimator
virtual ResultValue< FSDKError, IDutyUniformEstimatorPtr > createDutyUniformEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates DutyUniformEstimator estimator.
fsdk::IFaceEngine::createFacialHairEstimator
virtual ResultValue< FSDKError, IFacialHairEstimatorPtr > createFacialHairEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates FacialHair estimator.
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
fsdk::LaunchOptions
LaunchOptions struct configures inference options on per-estimator/detector basis, giving user fine grained control over cpu/gpu utilisation.
Definition: LaunchOptions.h:34
fsdk::IFaceEngine::createFishEyeEstimator
virtual ResultValue< FSDKError, IFishEyeEstimatorPtr > createFishEyeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates FishEye estimator.
fsdk::FACE_DET_DEFAULT
Default detector cpecified in config file.
Definition: IDetector.h:37
IWarper.h
Image and landmarks warping.
fsdk::IFaceEngine::createDynamicRangeEstimator
virtual ResultValue< FSDKError, IDynamicRangeEstimatorPtr > createDynamicRangeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates DynamicRange estimator.
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
fsdk::IFaceEngine::createHeadPoseEstimator
virtual ResultValue< FSDKError, IHeadPoseEstimatorPtr > createHeadPoseEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Head pose estimator.
fsdk::IFaceEngine::createDescriptorBatch
virtual ResultValue< FSDKError, IDescriptorBatchPtr > createDescriptorBatch(int32_t size, uint32_t version=0) noexcept=0
Creates Batch of descriptors.
fsdk::IFaceEngine::createLivenessFlyingFacesEstimator
virtual ResultValue< FSDKError, ILivenessFlyingFacesEstimatorPtr > createLivenessFlyingFacesEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates LivenessFlyingFaces estimator.
fsdk::IFaceEngine::createFaceLandmarksDetector
virtual ResultValue< FSDKError, IFaceLandmarksDetectorPtr > createFaceLandmarksDetector(SensorType mode=SensorType::Visible, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a face landmark detector.
fsdk::IFaceEngine::createCredibilityCheckEstimator
virtual ResultValue< FSDKError, ICredibilityCheckEstimatorPtr > createCredibilityCheckEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates CredibilityCheck estimator.
fsdk::IFaceEngine::createRedEyeEstimator
virtual ResultValue< FSDKError, IRedEyeEstimatorPtr > createRedEyeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Red Eye estimator.
fsdk::IFaceEngine::createMouthEstimator
virtual ResultValue< FSDKError, IMouthEstimatorPtr > createMouthEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Mouth estimator.
fsdk::IFaceEngine::createLivenessOneShotRGBEstimator
virtual ResultValue< FSDKError, ILivenessOneShotRGBEstimatorPtr > createLivenessOneShotRGBEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Liveness OneShot estimator.
fsdk::IFaceEngine::getSettingsProvider
virtual ISettingsProvider * getSettingsProvider() const noexcept=0
Gets settings provider.
IHumanWarper.h
Image warping base on Human detection.
fsdk::IFaceEngine::createEyeBrowEstimator
virtual ResultValue< FSDKError, IEyeBrowEstimatorPtr > createEyeBrowEstimator(const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates EyeBrow estimator .
fsdk::IFaceEngine::createPPEEstimator
virtual ResultValue< FSDKError, IPPEEstimatorPtr > createPPEEstimator(const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates Personal Protection Equipment (PPE) estimator.
fsdk::IFaceEngine::createCrowdEstimator
virtual ResultValue< FSDKError, ICrowdEstimatorPtr > createCrowdEstimator(fsdk::CrowdEstimatorType type=fsdk::CrowdEstimatorType::CET_DEFAULT, const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates Crowd estimator.
fsdk::IFaceEngine::createHumanWarper
virtual ResultValue< FSDKError, IHumanWarperPtr > createHumanWarper() noexcept=0
Creates human warper.
fsdk::IFaceEngine::FSDK_DEPRECATED
FSDK_DEPRECATED("createQualityEstimator is deprecated since v.5.32.0, " "use createSubjectiveQualityEstimator instead!") virtual ResultValue< FSDKError
Creates Quality estimator.
IObject.h
Object system types and interfaces.
fsdk::IFaceEngine::createMatcher
virtual ResultValue< FSDKError, IDescriptorMatcherPtr > createMatcher(uint32_t version=0) noexcept=0
Creates descriptor matcher.
fsdk::NIRLivenessMode
NIRLivenessMode
NIRLiveness estimation mode. Currently, available values to select the estimation mode are: Default...
Definition: INIRLivenessEstimator.h:23
fsdk::ILicense
License objects interface.
Definition: ILicense.h:84
fsdk::IFaceEngine::createGlassesEstimator
virtual ResultValue< FSDKError, IGlassesEstimatorPtr > createGlassesEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Glasses estimator.
fsdk::IFaceEngine::createFaceOcclusionEstimator
virtual ResultValue< FSDKError, IFaceOcclusionEstimatorPtr > createFaceOcclusionEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates FaceOcclusion estimator.
fsdk::IFaceEngine::createDepthLivenessEstimator
virtual ResultValue< FSDKError, IDepthLivenessEstimatorPtr > createDepthLivenessEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates universal DepthLiveness estimator.
fsdk::createSettingsProviderFromString
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProviderFromString(const char *content) noexcept
Creates a settings provider from the xml-formatted string.
fsdk::IFaceEngine::createBestShotQualityEstimator
virtual ResultValue< FSDKError, IBestShotQualityEstimatorPtr > createBestShotQualityEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates BestShotQuality estimator.
fsdk::IFaceEngine::getLicense
virtual ILicense * getLicense() const noexcept=0
Get current License object, which was set for FaceEngine object.
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::IFaceEngine::setSettingsProvider
virtual void setSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets settings provider.
fsdk::IFaceEngine
Root LUNA SDK object interface.
Definition: IFaceEngine.h:71
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:37
fsdk::CET_DEFAULT
Default type which is specified in config file.
Definition: ICrowdEstimator.h:28
fsdk::IFaceEngine::createHumanFaceDetector
virtual ResultValue< FSDKError, IHumanFaceDetectorPtr > createHumanFaceDetector(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a HumanFace detector, which detects humans, faces and associations between them...
fsdk::IFaceEngine::createFightsEstimator
virtual ResultValue< FSDKError, IFightsEstimatorPtr > createFightsEstimator(const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates FightsEstimator estimator.
fsdk::IFaceEngine::createIndexBuilder
virtual ResultValue< FSDKError, IIndexBuilderPtr > createIndexBuilder(const size_t capacity=0, uint32_t version=0) noexcept=0
Creates index builder.
Version.h
SDK version information routines.
Log.h
Log interfaces.
IEstimator.h
Image analysis and attribute estimation interfaces.
fsdk::createFaceEngine
FSDK_API ResultValue< FSDKError, IFaceEnginePtr > createFaceEngine(const char *dataPath=nullptr, const char *configPath=nullptr, const char *runtimePath=nullptr) noexcept
Create the LUNA SDK root object.
fsdk::SensorType
SensorType
Sensor type structure. Determines which type of camera sensor is used to perform face recognition...
Definition: SensorType.h:9
fsdk::IFaceEngine::createExtractor
virtual ResultValue< FSDKError, IDescriptorExtractorPtr > createExtractor(uint32_t version=0, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates descriptor extractor.
IDescriptor.h
Descriptor extractor and matcher interfaces.
fsdk::IFaceEngine::createLivenessRGBMEstimator
virtual ResultValue< FSDKError, ILivenessRGBMEstimatorPtr > createLivenessRGBMEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Liveness RGBM estimator.
fsdk::IFaceEngine::createGazeEstimator
virtual ResultValue< FSDKError, IGazeEstimatorPtr > createGazeEstimator(SensorType mode=SensorType::Visible, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Gaze estimator.
fsdk::IFaceEngine::createDescriptor
virtual ResultValue< FSDKError, IDescriptorPtr > createDescriptor(uint32_t version=0) noexcept=0
Creates Descriptor.
fsdk::IFaceEngine::getRuntimeSettingsProvider
virtual ISettingsProvider * getRuntimeSettingsProvider() const noexcept=0
Gets runtime settings provider.
fsdk::IFaceEngine::createHeadDetector
virtual ResultValue< FSDKError, IHeadDetectorPtr > createHeadDetector(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a head detector.
fsdk::IFaceEngine::createOverlapEstimator
virtual ResultValue< FSDKError, IOverlapEstimatorPtr > createOverlapEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Overlap estimator.
fsdk::IFaceEngine::createPhotorealisticFaceEstimator
virtual ResultValue< FSDKError, IPhotorealisticFaceEstimatorPtr > createPhotorealisticFaceEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates PhotorealisticFaceEstimator estimator.
fsdk::IFaceEngine::loadDenseIndex
virtual ResultValue< FSDKError, IDenseIndexPtr > loadDenseIndex(const char *indexPath) noexcept=0
Loads dense index.
fsdk::ResultValue
Addon for Result to output some value aside the result. Specialization for copiable types...
Definition: ResultValue.h:21
IDetector.h
Face detector interfaces.
fsdk::SensorType::Visible
Visible sensor type.
fsdk::Fingerprint
Fingreprint structure.
Definition: ILicense.h:47
fsdk::IFaceEngine::createDetector
virtual ResultValue< FSDKError, IDetectorPtr > createDetector(ObjectDetectorClassType type=FACE_DET_DEFAULT, SensorType mode=SensorType::Visible, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates a detector of a given type.
fsdk::IFaceEngine::createEmotionsEstimator
virtual ResultValue< FSDKError, IEmotionsEstimatorPtr > createEmotionsEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Emotions estimator.
fsdk::IFaceEngine::createLightColoredClothesEstimator
virtual ResultValue< FSDKError, ILightColoredClothesEstimatorPtr > createLightColoredClothesEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates LightColoredClothesEstimator estimator.
IAsyncContext.h
Async context interface.
fsdk::IFaceEngine::loadDynamicIndex
virtual ResultValue< FSDKError, IDynamicIndexPtr > loadDynamicIndex(const char *indexPath) noexcept=0
Loads dynamic index.
fsdk::IFaceEngine::createNaturalLightEstimator
virtual ResultValue< FSDKError, INaturalLightEstimatorPtr > createNaturalLightEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates NaturalLight estimator.
fsdk::IFaceEngine::setRuntimeSettingsProvider
virtual void setRuntimeSettingsProvider(ISettingsProvider *provider) noexcept=0
Sets runtime settings provider.
fsdk::IFaceEngine::createSubjectiveQualityEstimator
virtual ResultValue< FSDKError, ISubjectiveQualityEstimatorPtr > createSubjectiveQualityEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Subjective quality estimator.
fsdk::IFaceEngine::createMedicalMaskEstimator
virtual ResultValue< FSDKError, IMedicalMaskEstimatorPtr > createMedicalMaskEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates MedicalMask estimator.
fsdk::IFaceEngine::getDataDirectory
virtual const char * getDataDirectory() const noexcept=0
Gets data directory.
fsdk::IFaceEngine::createEyeEstimator
virtual ResultValue< FSDKError, IEyeEstimatorPtr > createEyeEstimator(SensorType mode=SensorType::Visible, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Eye estimator.
fsdk::IFaceEngine::createAsyncContext
virtual ResultValue< FSDKError, IAsyncContextPtr > createAsyncContext(const int8_t threadCount) noexcept=0
Creates async context.
fsdk::ObjectDetectorClassType
ObjectDetectorClassType
Object detector type enumeration.
Definition: IDetector.h:36
fsdk::IArchive
Archive interface.
Definition: IObject.h:38
fsdk::IFaceEngine::createNIRLivenessEstimator
virtual ResultValue< FSDKError, INIRLivenessEstimatorPtr > createNIRLivenessEstimator(const NIRLivenessMode mode=NIRLivenessMode::Default, const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates NIRLiveness estimator.
fsdk::IFaceEngine::getFaceEngineEdition
virtual FaceEngineEdition getFaceEngineEdition() const noexcept=0
Get LUNA SDK ditribution edition.
fsdk::FSDKError
FSDKError
Common SDK error codes.
Definition: FSDKError.h:17
fsdk::IFaceEngine::createImageModificationEstimator
virtual ResultValue< FSDKError, IImageModificationEstimatorPtr > createImageModificationEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates image modification estimator.
fsdk::IFaceEngine::createDeepFakeEstimator
virtual ResultValue< FSDKError, experimental::IDeepFakeEstimatorPtr > createDeepFakeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates DeepFake estimator. The current implementation is experimental, and does not support backward...
fsdk::IFaceEngine::createBackgroundEstimator
virtual ResultValue< FSDKError, IBackgroundEstimatorPtr > createBackgroundEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Background estimator.
ISettingsProvider.h
Settings provider interface.
fsdk::IFaceEngine::createImageTransfer
virtual ResultValue< FSDKError, IImageTransferPtr > createImageTransfer(const LaunchOptions *LaunchOptions=nullptr) noexcept=0
Creates Image transfer facility.
fsdk::createSettingsProvider
FSDK_API ResultValue< FSDKError, ISettingsProviderPtr > createSettingsProvider(const char *path) noexcept
Creates a settings provider.
fsdk::IFaceEngine::createBlackWhiteEstimator
virtual ResultValue< FSDKError, IBlackWhiteEstimatorPtr > createBlackWhiteEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates BlackWhite estimator.
fsdk::IFaceEngine::setDataDirectory
virtual void setDataDirectory(const char *path) noexcept=0
Sets data directory.
fsdk::IFaceEngine::createAttributeEstimator
virtual ResultValue< FSDKError, IAttributeEstimatorPtr > createAttributeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates Attribute estimator.
fsdk::IFaceEngine::createNeckOcclusionEstimator
virtual ResultValue< FSDKError, INeckOcclusionEstimatorPtr > createNeckOcclusionEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates NeckOcclusionEstimator estimator.
fsdk::CrowdEstimatorType
CrowdEstimatorType
CrowdEstimator type enumeration.
Definition: ICrowdEstimator.h:27
fsdk::IFaceEngine::createHumanAttributeEstimator
virtual ResultValue< FSDKError, IHumanAttributeEstimatorPtr > createHumanAttributeEstimator(const LaunchOptions *launchOptions=nullptr) noexcept=0
Creates HumanAttribute estimator.
fsdk::ISettingsProvider
SDK settings provider interface.
Definition: ISettingsProvider.h:32