Package com.appliedrec.verid.core2.session

Class FaceCapture

java.lang.Object

com.appliedrec.verid.core2.session.FaceCapture

public class FaceCapture
extends java.lang.Object

Contains an image, face, bearing and diagnostic info captured during a Ver-ID session

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FaceCapture.DiagnosticInfo	Diagnostic information

Constructor Summary

Constructors

Constructor	Description
FaceCapture(RecognizableFace[] faces, Bearing bearing, android.graphics.Bitmap image, Image verIDImage)
FaceCapture(RecognizableFace face, Bearing bearing, android.graphics.Bitmap image, Image verIDImage)	Constructor
FaceCapture(java.util.ArrayList<RecognizableFace> faces, Bearing bearing, android.graphics.Bitmap image, Image verIDImage)

Method Summary

Modifier and Type	Method	Description
static FaceCapture	create(VerID verID, FaceDetectionResult faceDetectionResult)	Create face capture from face detection result
boolean	equals(java.lang.Object o)
Bearing	getBearing()
FaceCapture.DiagnosticInfo	getDiagnosticInfo()
RecognizableFace	getFace()
android.graphics.Bitmap	getFaceImage()
java.util.ArrayList<RecognizableFace>	getFaces()
android.graphics.Bitmap	getImage()
Image	getVerIDImage()
int	hashCode()
static io.reactivex.rxjava3.functions.BiConsumer<VerIDSessionResult,FaceCapture>	makeAccumulator(VerID verID, VerIDSessionSettings sessionSettings)
void	setDiagnosticInfo(FaceCapture.DiagnosticInfo diagnosticInfo)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaceCapture

@RestrictTo(LIBRARY_GROUP)
public FaceCapture(@NonNull
                   RecognizableFace face,
                   @NonNull
                   Bearing bearing,
                   @NonNull
                   android.graphics.Bitmap image,
                   @NonNull
                   Image verIDImage)

Constructor

Parameters:

face - Face

bearing - Bearing

image - Image

FaceCapture

public FaceCapture(@NonNull
                   java.util.ArrayList<RecognizableFace> faces,
                   @NonNull
                   Bearing bearing,
                   @NonNull
                   android.graphics.Bitmap image,
                   @NonNull
                   Image verIDImage)
            throws VerIDSessionException

Throws:

VerIDSessionException

FaceCapture

public FaceCapture(@NonNull
                   RecognizableFace[] faces,
                   @NonNull
                   Bearing bearing,
                   @NonNull
                   android.graphics.Bitmap image,
                   @NonNull
                   Image verIDImage)
            throws VerIDSessionException

Throws:

VerIDSessionException

Method Detail

create

public static FaceCapture create(VerID verID,
                                 FaceDetectionResult faceDetectionResult)
                          throws VerIDSessionException

Create face capture from face detection result

Parameters:

verID - Instance of VerID to use when converting the detected face to a face usable for face recognition

faceDetectionResult - Face detection result (status must be FaceDetectionStatus.FACE_ALIGNED)

Returns:

Face capture

Throws:

VerIDSessionException

makeAccumulator

public static io.reactivex.rxjava3.functions.BiConsumer<VerIDSessionResult,FaceCapture> makeAccumulator(@NonNull
                                                                                                              VerID verID,
                                                                                                              @NonNull
                                                                                                              VerIDSessionSettings sessionSettings)

getVerIDImage

public Image getVerIDImage()

getFace

@NonNull
public RecognizableFace getFace()

Returns:

Face detected in the image

getFaces

public java.util.ArrayList<RecognizableFace> getFaces()

Returns:

Faces detected in the image

Since:

2.6.0

getBearing

@NonNull
public Bearing getBearing()

Returns:

Bearing of the face

getImage

@NonNull
public android.graphics.Bitmap getImage()

Returns:

Image as bitmap

getFaceImage

@NonNull
public android.graphics.Bitmap getFaceImage()

Returns:

Image cropped to the face bounding box

getDiagnosticInfo

@NonNull
public FaceCapture.DiagnosticInfo getDiagnosticInfo()

Returns:

Diagnostic info (populated if VerIDSessionSettings.isSessionDiagnosticsEnabled() is set to true, otherwise FaceCapture.DiagnosticInfo.isEmpty() will return true)

setDiagnosticInfo

public void setDiagnosticInfo(FaceCapture.DiagnosticInfo diagnosticInfo)

equals

@RestrictTo(LIBRARY_GROUP)
public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

@RestrictTo(LIBRARY_GROUP)
public int hashCode()

Overrides:

hashCode in class java.lang.Object