SelphID Cpp SDK API
Loading...
Searching...
No Matches
SelphIDFacialExtractionResult.h
1#ifndef SELPHIDFACIALEXTRACTIONRESULT_H_
2#define SELPHIDFACIALEXTRACTIONRESULT_H_
3
4#include "FPhiDefines.hpp"
5#include "SelphIDFacialConstants.h"
6
7namespace FPhiSelphID {
8class SelphIDFacialExtractionResult_p;
9
15 private:
16 std::unique_ptr<SelphIDFacialExtractionResult_p> _selphIDFacialExtractionResult_p;
17
18 public:
24
30 DLL_PUBLIC SelphIDFacialExtractionResult(const SelphIDFacialExtractionResult &selphIDFacialExtractionResult);
31
38 const std::unique_ptr<SelphIDFacialExtractionResult_p> &selphIDFacialExtractionResult_p);
39
45
53 operator=(const SelphIDFacialExtractionResult &selphIDFacialExtractionResult);
54
60 const std::unique_ptr<SelphIDFacialExtractionResult_p> &GetSelphIDFacialExtractionResult_p() const;
61
67 DLL_PUBLIC bool GetExtractionOK() const;
68
74 DLL_PUBLIC void SetExtractionOK(bool extractionOK);
75
81 DLL_PUBLIC const Rectangle &GetFace() const;
82
88 DLL_PUBLIC void SetFace(const Rectangle &face);
89
95 DLL_PUBLIC float GetFaceConfidence() const;
96
102 DLL_PUBLIC void SetFaceConfidence(float faceConfidence);
103
109 DLL_PUBLIC const Point &GetLeftEye() const;
110
116 DLL_PUBLIC void SetLeftEye(const Point &leftEye);
117
123 DLL_PUBLIC const Point &GetRightEye() const;
124
130 DLL_PUBLIC void SetRightEye(const Point &rightEye);
131
137 DLL_PUBLIC int GetIOD() const;
138
144 DLL_PUBLIC void SetIOD(int IOD);
145
151 DLL_PUBLIC Point GetChin() const;
152
158 DLL_PUBLIC void SetChin(const Point &chin);
159
165 DLL_PUBLIC Point GetNose() const;
166
172 DLL_PUBLIC void SetNose(const Point &nose);
173
179 DLL_PUBLIC const Point &GetLeftMouth() const;
180
186 DLL_PUBLIC void SetLeftMouth(const Point &leftMouth);
187
193 DLL_PUBLIC const Point &GetRightMouth() const;
194
200 DLL_PUBLIC void SetRightMouth(const Point &rightMouth);
201
207 DLL_PUBLIC FacialPose GetFacialPose() const;
208
214 DLL_PUBLIC void SetFacialPose(const FacialPose &pose);
215
221 DLL_PUBLIC float GetYaw() const;
222
228 DLL_PUBLIC void SetYaw(float yaw);
229
235 DLL_PUBLIC float GetPitch() const;
236
242 DLL_PUBLIC void SetPitch(float pitch);
243
249 DLL_PUBLIC float GetRoll() const;
250
256 DLL_PUBLIC void SetRoll(float roll);
257
263 DLL_PUBLIC float GetImageQuality() const;
264
270 DLL_PUBLIC void SetImageQuality(float quality);
271
277 DLL_PUBLIC FacialQuality GetFacialQuality() const;
278
284 DLL_PUBLIC void SetFacialQuality(FacialQuality facialQuality);
285
291 DLL_PUBLIC FacialGlasses GetGlasses() const;
292
298 DLL_PUBLIC void SetGlasses(FacialGlasses glasses);
299
305 DLL_PUBLIC FacialLips GetLips() const;
306
312 DLL_PUBLIC void SetLips(FacialLips lips);
313
319 DLL_PUBLIC int GetAge() const;
320
326 DLL_PUBLIC void SetAge(int age);
327
333 DLL_PUBLIC FacialGender GetGender() const;
334
340 DLL_PUBLIC void SetGender(FacialGender gender);
341
347 DLL_PUBLIC const std::vector<unsigned char> &GetFacialTemplate() const;
348
354 DLL_PUBLIC void SetFacialTemplate(const std::vector<unsigned char> &facialtemplate);
355
361 DLL_PUBLIC const std::vector<unsigned char> &GetFacialTemplateRaw() const;
362
368 DLL_PUBLIC void SetFacialTemplateRaw(const std::vector<unsigned char> &facialTemplateRaw);
369
375 DLL_PUBLIC bool GetUpdatedTemplateRaw() const;
376
382 DLL_PUBLIC void SetUpdatedTemplateRaw(bool updated);
383
389 DLL_PUBLIC float GetEmotionAnger() const;
390
396 DLL_PUBLIC void SetEmotionAnger(float anger);
397
403 DLL_PUBLIC float GetEmotionDisgust() const;
404
410 DLL_PUBLIC void SetEmotionDisgust(float disgust);
411
417 DLL_PUBLIC float GetEmotionFear() const;
418
424 DLL_PUBLIC void SetEmotionFear(float fear);
425
431 DLL_PUBLIC float GetEmotionJoy() const;
432
438 DLL_PUBLIC void SetEmotionJoy(float joy);
439
445 DLL_PUBLIC float GetEmotionNeutral() const;
446
452 DLL_PUBLIC void SetEmotionNeutral(float neutral);
453
459 DLL_PUBLIC float GetEmotionSadness() const;
460
466 DLL_PUBLIC void SetEmotionSadness(float sadness);
467
473 DLL_PUBLIC float GetEmotionSurprise() const;
474
480 DLL_PUBLIC void SetEmotionSurprise(float surprise);
481
487 DLL_PUBLIC FacialEmotion GetEmotion() const;
488
494 DLL_PUBLIC void SetEmotion(FacialEmotion emotion);
495
501 DLL_PUBLIC bool GetIODCheck() const;
502
508 DLL_PUBLIC void SetIODCheck(bool iodCheck);
509
515 DLL_PUBLIC bool GetQualityCheck() const;
516
522 DLL_PUBLIC void SetQualityCheck(bool qualityCheck);
523
529 DLL_PUBLIC float GetFacialHair() const;
530
536 DLL_PUBLIC void SetFacialHair(float facialHair);
537
543 DLL_PUBLIC float GetFacialGeographicOriginAfrican() const;
544
550 DLL_PUBLIC void SetFacialGeographicOriginAfrican(float african);
551
557 DLL_PUBLIC float GetFacialGeographicOriginEuropean() const;
558
564 DLL_PUBLIC void SetFacialGeographicOriginEuropean(float european);
565
571 DLL_PUBLIC float GetFacialGeographicOriginEastAsian() const;
572
578 DLL_PUBLIC void SetFacialGeographicOriginEastAsian(float eastAsian);
579
585 DLL_PUBLIC float GetFacialGeographicOriginSouthAsian() const;
586
592 DLL_PUBLIC void SetFacialGeographicOriginSouthAsian(float southAsian);
593
600
606 DLL_PUBLIC void SetFacialGeographicOriginLatinAmerican(float latinAmerican);
607
614
620 DLL_PUBLIC void SetFacialGeographicOriginMiddleEastern(float middleEastern);
621
628
634 DLL_PUBLIC void SetFacialGeographicOriginSoutheastAsian(float southeastAsian);
635
641 DLL_PUBLIC FacialGeographicOrigin GetFacialGeographicOrigin() const;
642
648 DLL_PUBLIC void SetFacialGeographicOrigin(FacialGeographicOrigin geographicOrigin);
649
655 DLL_PUBLIC float GetArtworkHuman() const;
656
662 DLL_PUBLIC void SetArtworkHuman(float artworkHuman);
663
669 DLL_PUBLIC float GetArtworkCartoon() const;
670
676 DLL_PUBLIC void SetArtworkCartoon(float artworkCartoon);
677
683 DLL_PUBLIC float GetArtworkPainting() const;
684
690 DLL_PUBLIC void SetArtworkPainting(float artworkPainting);
691
697 DLL_PUBLIC FacialArtwork GetArtwork() const;
698
704 DLL_PUBLIC void SetArtwork(FacialArtwork artwork);
705
711 DLL_PUBLIC float GetFacialMask() const;
712
718 DLL_PUBLIC void SetFacialMask(float mask);
719
725 DLL_PUBLIC bool GetValidTimeStamp() const;
726
732 DLL_PUBLIC void SetValidTimeStamp(bool validTimeStamp);
733};
734} // namespace FPhiSelphID
735
736#endif
Point.
Definition SelphIDFacialConstants.h:347
Rectangle.
Definition SelphIDFacialConstants.h:382
SelphID Facial Extraction Result.
Definition SelphIDFacialExtractionResult.h:14
DLL_PUBLIC float GetFacialGeographicOriginSoutheastAsian() const
Gets facial geographic origin southeast asian probability.
DLL_PUBLIC const Point & GetLeftEye() const
Gets left eye coordinates.
DLL_PUBLIC void SetFacialGeographicOriginLatinAmerican(float latinAmerican)
Sets facial geographic origin latin american probability.
DLL_PUBLIC const Rectangle & GetFace() const
Gets facial coordinates.
DLL_PUBLIC void SetEmotionAnger(float anger)
Sets anger probability.
DLL_PUBLIC void SetEmotionFear(float fear)
Sets fear probability.
DLL_PUBLIC FacialLips GetLips() const
Gets facial lips status.
DLL_PUBLIC void SetFaceConfidence(float faceConfidence)
Sets facial facial confidence.
DLL_PUBLIC void SetGlasses(FacialGlasses glasses)
Sets facial glasses status.
DLL_PUBLIC void SetFacialGeographicOriginEastAsian(float eastAsian)
Sets facial geographic origin east asian probability.
DLL_PUBLIC void SetArtworkCartoon(float artworkCartoon)
Sets art work cartoon probability.
DLL_PUBLIC float GetFaceConfidence() const
Gets facial confidence.
DLL_PUBLIC void SetRightEye(const Point &rightEye)
Sets right eye coordinates.
DLL_PUBLIC void SetEmotionNeutral(float neutral)
Sets neutral probability.
DLL_PUBLIC void SetFacialGeographicOriginSouthAsian(float southAsian)
Sets facial geographic origin south asian probability.
DLL_PUBLIC void SetNose(const Point &nose)
Sets nose coordinates.
DLL_PUBLIC void SetFacialHair(float facialHair)
Sets facial hair quantity [0..100].
DLL_PUBLIC void SetExtractionOK(bool extractionOK)
Sets extraction status.
DLL_PUBLIC void SetFace(const Rectangle &face)
Sets facial coordinates.
DLL_PUBLIC const Point & GetLeftMouth() const
Gets left mouth corner coordinates.
DLL_PUBLIC float GetFacialMask() const
Gets facial mask probability.
DLL_PUBLIC float GetFacialGeographicOriginLatinAmerican() const
Gets facial geographic origin latin american probability.
DLL_PUBLIC float GetEmotionAnger() const
Gets anger probability.
DLL_PUBLIC void SetGender(FacialGender gender)
Sets facial gender.
DLL_PUBLIC bool GetValidTimeStamp() const
Gets if the time stamp is valid.
DLL_PUBLIC Point GetChin() const
Gets chin coordinates.
DLL_PUBLIC void SetFacialGeographicOriginSoutheastAsian(float southeastAsian)
Sets facial geographic origin southeast asian probability.
DLL_PUBLIC void SetImageQuality(float quality)
Sets image quality.
DLL_PUBLIC bool GetIODCheck() const
Gets interocular check.
DLL_PUBLIC void SetFacialTemplateRaw(const std::vector< unsigned char > &facialTemplateRaw)
Sets facial template raw.
DLL_PUBLIC int GetIOD() const
Gets interocular distance.
DLL_PUBLIC FacialArtwork GetArtwork() const
Gets art work summary.
DLL_PUBLIC void SetEmotionSadness(float sadness)
Sets sadness probability.
DLL_PUBLIC void SetRoll(float roll)
Sets facial roll.
DLL_PUBLIC float GetFacialGeographicOriginEuropean() const
Gets facial geographic origin european probability.
DLL_PUBLIC float GetFacialGeographicOriginSouthAsian() const
Gets facial geographic origin south asian probability.
DLL_PUBLIC void SetValidTimeStamp(bool validTimeStamp)
Sets if the time stamp is valid.
DLL_PUBLIC SelphIDFacialExtractionResult()
Creates a new instance of SelphIDFacialExtractionResult.
DLL_PUBLIC void SetEmotionDisgust(float disgust)
Sets disgust probability.
DLL_PUBLIC void SetRightMouth(const Point &rightMouth)
Sets right mouth corner coordinates.
DLL_PUBLIC float GetFacialGeographicOriginEastAsian() const
Gets facial geographic origin east asian probability.
DLL_PUBLIC void SetFacialQuality(FacialQuality facialQuality)
Sets facial quality.
DLL_PUBLIC void SetLips(FacialLips lips)
Sets facial lips status.
DLL_PUBLIC void SetLeftEye(const Point &leftEye)
Sets left eye coordinates.
DLL_PUBLIC float GetPitch() const
Gets facial pitch.
DLL_PUBLIC void SetArtworkHuman(float artworkHuman)
Sets art work human probability.
DLL_PUBLIC void SetFacialGeographicOriginMiddleEastern(float middleEastern)
Sets facial geographic origin middle eastern probability.
DLL_PUBLIC float GetEmotionSurprise() const
Gets surprise probability.
DLL_PUBLIC float GetArtworkCartoon() const
Gets art work cartoon probability.
DLL_PUBLIC void SetUpdatedTemplateRaw(bool updated)
Sets if facial template raw has been updated.
DLL_PUBLIC float GetEmotionNeutral() const
Gets neutral probability.
DLL_PUBLIC void SetPitch(float pitch)
Sets facial pitch.
DLL_PUBLIC void SetFacialTemplate(const std::vector< unsigned char > &facialtemplate)
Sets facial template.
DLL_PUBLIC float GetArtworkPainting() const
Gets art work painting probability.
DLL_PUBLIC void SetQualityCheck(bool qualityCheck)
Sets quality check.
DLL_PUBLIC bool GetQualityCheck() const
Gets quality check.
DLL_PUBLIC float GetArtworkHuman() const
Gets art work human probability.
DLL_PUBLIC SelphIDFacialExtractionResult(const SelphIDFacialExtractionResult &selphIDFacialExtractionResult)
Creates a new instance of SelphIDFacialExtractionResult.
DLL_PUBLIC ~SelphIDFacialExtractionResult()
SelphIDFacialExtractionResult destructor.
DLL_PUBLIC FacialEmotion GetEmotion() const
Gets facial emotion summary.
const std::unique_ptr< SelphIDFacialExtractionResult_p > & GetSelphIDFacialExtractionResult_p() const
Gets the inner implementation.
DLL_PUBLIC void SetFacialGeographicOriginAfrican(float african)
Sets facial geographic origin african probability.
DLL_PUBLIC SelphIDFacialExtractionResult(const std::unique_ptr< SelphIDFacialExtractionResult_p > &selphIDFacialExtractionResult_p)
Creates a new instance of SelphIDFacialExtractionResult.
DLL_PUBLIC FacialPose GetFacialPose() const
Gets facial pose.
DLL_PUBLIC bool GetUpdatedTemplateRaw() const
Gets if facial template raw has been updated.
DLL_PUBLIC void SetEmotionSurprise(float surprise)
Sets surprise probability.
DLL_PUBLIC float GetImageQuality() const
Gets image quality.
DLL_PUBLIC FacialQuality GetFacialQuality() const
Gets facial quality.
DLL_PUBLIC float GetYaw() const
Gets facial yaw.
DLL_PUBLIC float GetEmotionJoy() const
Gets joy probability.
DLL_PUBLIC void SetIODCheck(bool iodCheck)
Sets interocular check.
DLL_PUBLIC void SetFacialMask(float mask)
Sets facial mask probability.
DLL_PUBLIC int GetAge() const
Gets facial age.
DLL_PUBLIC FacialGender GetGender() const
Gets facial gender.
DLL_PUBLIC SelphIDFacialExtractionResult & operator=(const SelphIDFacialExtractionResult &selphIDFacialExtractionResult)
Assignment operator overload.
DLL_PUBLIC const std::vector< unsigned char > & GetFacialTemplate() const
Gets facial template.
DLL_PUBLIC FacialGlasses GetGlasses() const
Gets facial glasses status.
DLL_PUBLIC void SetArtworkPainting(float artworkPainting)
Sets art work painting probability.
DLL_PUBLIC float GetEmotionSadness() const
Gets sadness probability.
DLL_PUBLIC FacialGeographicOrigin GetFacialGeographicOrigin() const
Gets facial geographic origin summary.
DLL_PUBLIC void SetEmotion(FacialEmotion emotion)
Sets facial emotion summary.
DLL_PUBLIC void SetChin(const Point &chin)
Sets chin coordinates.
DLL_PUBLIC void SetFacialGeographicOriginEuropean(float european)
Sets facial geographic origin european probability.
DLL_PUBLIC float GetEmotionFear() const
Gets fear probability.
DLL_PUBLIC void SetArtwork(FacialArtwork artwork)
Sets art work summary.
DLL_PUBLIC void SetYaw(float yaw)
Sets facial yaw.
DLL_PUBLIC void SetFacialGeographicOrigin(FacialGeographicOrigin geographicOrigin)
Sets facial geographic origin.
DLL_PUBLIC Point GetNose() const
Gets nose coordinates.
DLL_PUBLIC void SetIOD(int IOD)
Sets interocular distance.
DLL_PUBLIC const std::vector< unsigned char > & GetFacialTemplateRaw() const
Gets facial template raw.
DLL_PUBLIC void SetFacialPose(const FacialPose &pose)
Sets facial pose.
DLL_PUBLIC float GetEmotionDisgust() const
Gets disgust probability.
DLL_PUBLIC float GetFacialHair() const
Gets facial hair quantity [0..100].
DLL_PUBLIC void SetAge(int age)
Sets facial age.
DLL_PUBLIC void SetLeftMouth(const Point &leftMouth)
Sets left mouth corner coordinates.
DLL_PUBLIC void SetEmotionJoy(float joy)
Sets joy probability.
DLL_PUBLIC const Point & GetRightEye() const
Gets right eye coordinates.
DLL_PUBLIC const Point & GetRightMouth() const
Gets right mouth corner coordinates.
DLL_PUBLIC float GetFacialGeographicOriginAfrican() const
Gets facial geographic origin african probability.
DLL_PUBLIC float GetFacialGeographicOriginMiddleEastern() const
Gets facial geographic origin middle eastern probability.
DLL_PUBLIC bool GetExtractionOK() const
Gets extraction status.
DLL_PUBLIC float GetRoll() const
Gets facial roll.