SelphID Cpp SDK API
Loading...
Searching...
No Matches
SelphIDVerifierOptions.h
1#ifndef SELPHIDVERIFIEROPTIONS_H_
2#define SELPHIDVERIFIEROPTIONS_H_
3
4#include "FPhiDefines.hpp"
5#include "SelphIDFacialConstants.h"
6
7namespace FPhiSelphID {
8class SelphIDVerifierOptions_p;
9
15 private:
16 std::unique_ptr<SelphIDVerifierOptions_p> _selphIDVerifierOptions_p;
17
18 public:
24
29 DLL_PUBLIC SelphIDVerifierOptions(const SelphIDVerifierOptions &selphIDVerifierOptions);
30
36
42 DLL_PUBLIC const std::unique_ptr<SelphIDVerifierOptions_p> &GetSelphIDVerifierOptions_p() const;
43
49 DLL_PUBLIC int GetElapsedTimeAllowed() const;
50
56 DLL_PUBLIC void SetElapsedTimeAllowed(int elapsedTimeAllowed);
57
63 DLL_PUBLIC FacialDetectionType GetFacialDetectionType() const;
64
70 DLL_PUBLIC void SetFacialDetectionType(FacialDetectionType faceDetectionType);
71
77 DLL_PUBLIC int GetMinFaceAbs() const;
78
84 DLL_PUBLIC void SetMinFaceAbs(int minFaceAbs);
85
91 DLL_PUBLIC float GetMinFaceRel() const;
92
98 DLL_PUBLIC void SetMinFaceRel(float minFaceRel);
99
105 DLL_PUBLIC float GetFalseDetectRate() const;
106
112 DLL_PUBLIC void SetFalseDetectRate(float rate);
113
119 DLL_PUBLIC int GetMinIODThreshold() const;
120
126 DLL_PUBLIC void SetMinIODThreshold(int minIODThreshold);
127
133 DLL_PUBLIC int GetMaxPoseThreshold() const;
134
140 DLL_PUBLIC void SetMaxPoseThreshold(int maxPoseThreshold);
141
147 DLL_PUBLIC FPhiSelphID::FacialQuality GetMinimumFacialQuality() const;
148
154 DLL_PUBLIC void SetMinimumFacialQuality(FacialQuality minimumFacialQuality);
155
161 DLL_PUBLIC bool GetAnalyticsDetection() const;
162
168 DLL_PUBLIC void SetAnalyticsDetection(bool analyticsDetection);
169
175 DLL_PUBLIC bool GetFacialTemplateRawExtraction() const;
176
182 DLL_PUBLIC void SetFacialTemplateRawExtraction(bool facialTemplateRawExtraction);
183
189 DLL_PUBLIC std::string GetOptionalDataClientInformation() const;
190
196 DLL_PUBLIC void SetOptionalDataClientInformation(const std::string &json);
197
204
210 DLL_PUBLIC void SetCustomFacialAuthenticationThreshold(int customFacialAuthenticationThreshold);
211};
212} // namespace FPhiSelphID
213
214#endif
SelphID Verifier Options.
Definition SelphIDVerifierOptions.h:14
DLL_PUBLIC int GetMinIODThreshold() const
Gets the minimum interocular threshold.
DLL_PUBLIC bool GetAnalyticsDetection() const
Gets analytics detection.
DLL_PUBLIC void SetMinFaceRel(float minFaceRel)
Sets the relative minimum face size for detection.
DLL_PUBLIC void SetMinFaceAbs(int minFaceAbs)
Sets the absolute minimum face size for detection.
DLL_PUBLIC void SetOptionalDataClientInformation(const std::string &json)
Sets a well-formed JSON which contains the personal information used to identify a client.
DLL_PUBLIC void SetFacialDetectionType(FacialDetectionType faceDetectionType)
Sets the facial detection type.
DLL_PUBLIC void SetMaxPoseThreshold(int maxPoseThreshold)
Sets the maximum pose threshold in degrees.
DLL_PUBLIC void SetAnalyticsDetection(bool analyticsDetection)
Sets analytics detection.
DLL_PUBLIC SelphIDVerifierOptions(const SelphIDVerifierOptions &selphIDVerifierOptions)
Creates a copy of SelphIDVerifierOptions.
DLL_PUBLIC void SetCustomFacialAuthenticationThreshold(int customFacialAuthenticationThreshold)
Sets the custom facial authentication threshold.
DLL_PUBLIC float GetFalseDetectRate() const
Gets false detection rate.
DLL_PUBLIC void SetMinimumFacialQuality(FacialQuality minimumFacialQuality)
Sets the minimum facial quality.
DLL_PUBLIC void SetFacialTemplateRawExtraction(bool facialTemplateRawExtraction)
Sets facial template raw extraction.
DLL_PUBLIC void SetMinIODThreshold(int minIODThreshold)
Sets the minimum interocular threshold.
DLL_PUBLIC int GetMaxPoseThreshold() const
Gets the maximum pose threshold in degrees.
DLL_PUBLIC FPhiSelphID::FacialQuality GetMinimumFacialQuality() const
Gets the minimum facial quality.
DLL_PUBLIC SelphIDVerifierOptions()
Creates a new instance of SelphIDVerifierOptions.
DLL_PUBLIC const std::unique_ptr< SelphIDVerifierOptions_p > & GetSelphIDVerifierOptions_p() const
Gets the inner implementation.
DLL_PUBLIC void SetElapsedTimeAllowed(int elapsedTimeAllowed)
Sets the elapsed time allowed in seconds.
DLL_PUBLIC int GetElapsedTimeAllowed() const
Gets the elapsed time allowed in seconds.
DLL_PUBLIC void SetFalseDetectRate(float rate)
Sets the false detection rate.
DLL_PUBLIC bool GetFacialTemplateRawExtraction() const
Gets facial template raw extraction.
DLL_PUBLIC FacialDetectionType GetFacialDetectionType() const
Gets the facial detection type..
DLL_PUBLIC int GetMinFaceAbs() const
Gets the absolute minimum face size for detection.
DLL_PUBLIC float GetMinFaceRel() const
Gets the relative minimum face size for detection.
DLL_PUBLIC ~SelphIDVerifierOptions()
SelphIDVerifierOptions destructor.
DLL_PUBLIC std::string GetOptionalDataClientInformation() const
Gets a well-formed JSON which contains the personal information used to identify a client.
DLL_PUBLIC int GetCustomFacialAuthenticationThreshold() const
Gets the custom facial authentication threshold.