PVerify.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015-2018 Digital Barriers plc. All rights reserved.
3  * Contact: http://www.digitalbarriers.com/
4  *
5  * This file is part of the Papillon SDK.
6  *
7  * You can't use, modify or distribute any part of this file without
8  * the explicit written agreements of Digital Barriers.
9  */
10 
15 #pragma once
16 #include <PObject.h>
17 
18 PAPILLON_BEGIN_NAMESPACE
19 
20 class PImage;
21 class PDescription;
22 class PEnrollment;
23 class PMatchScore;
24 
35 {
40 };
41 
62 class PAPILLON_API_CORE PVerify : public PObject
63 {
64 public:
68  PVerify();
69 
75  PVerify(const PEnrollment& enrollment,
77  double threshold = -1.0);
78 
82  PVerify(const PVerify& other);
83 
87  virtual ~PVerify();
88 
92  PVerify& operator=(const PVerify& other);
93 
97  bool IsConfigured() const;
98 
102  EVerificationSecurityLevel GetSecurityLevel(double& threshold) const;
103 
114  PResult SetSecurityLevel(EVerificationSecurityLevel securityLevel, double threshold = -1.0);
115 
120  PResult VerifyFromDescription(const PDescription& description1,
121  const PDescription& description2,
122  PMatchScore& matchScore ) const;
123 
128  PResult VerifyFromDescriptionFile(const PString& descriptionFile1,
129  const PString& descriptionFile2,
130  PMatchScore& matchScore ) const;
131 
139  PResult VerifyFromImage(const PImage& image1,
140  const PImage& image2,
141  PMatchScore& matchScore,
142  PDescription& outputDescription1,
143  PDescription& outputDescription2 ) const;
144 
152  PResult VerifyFromImageFile(const PString& imageFilename1,
153  const PString& imageFilename2,
154  PMatchScore & matchScore,
155  PDescription& outputDescription1,
156  PDescription& outputDescription2) const;
157 
169  PResult VerifyFromVideoFile(const PDescription& description,
170  const PString& videoFilename,
171  PMatchScore& matchScore,
172  PDescription& outputDescription,
173  papillon::int32 maxFrames = -1,
174  papillon::int32 maxExamples = 5) const;
175 };
176 
177 PAPILLON_END_NAMESPACE
EVerificationSecurityLevel
The different available security levels for the verification engine, corresponding to FaceRecognition...
Definition: PVerify.h:34
The PString class provides an Unicode character strings.
Definition: PString.h:37
The PDescription class represents a set of features that have been computed on an identity (it is a b...
Definition: PDescription.h:59
The PImage class represents a 2D-image; several pixel format and number of channels are supported (BG...
Definition: PImage.h:57
The PVerify class is a Face Recognition helper class which allows for easy verification/authenticatio...
Definition: PVerify.h:62
The PResult class represents the result returned by most of Papillon functions; this class is used to...
Definition: PResult.h:159
The PEnrollment class is an helper class for face recognition, used to enroll people from a video or ...
Definition: PEnrollment.h:58
The PObject class is the root class of all Papillon classes; all PObject behaves like shared referenc...
Definition: PObject.h:27
The PMatchScore class is used to represent a score between two descriptions.
Definition: PMatchScore.h:27
Class PObject: the root class of all Papillon classes.
PObject & operator=(const PObject &obj)
Performs a shared copy of other to this object.
Definition: PObject.h:45