Package com.regula.facesdk.model

Class MatchFacesImage

java.lang.Object

com.regula.facesdk.model.MatchFacesImage

public final class MatchFacesImage
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
MatchFacesImage(Bitmap bitmap, ImageType imageType)
MatchFacesImage(Bitmap bitmap, ImageType imageType, boolean detectAll)
MatchFacesImage(ImageType imageType, Bitmap bitmap)
MatchFacesImage(ImageType imageType, Bitmap bitmap, boolean detectAll)
MatchFacesImage(Image image)
MatchFacesImage(Image image, boolean detectAll)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBase64Image()	Return image in base64 format
Bitmap	getBitmap()	The underlying image.
java.lang.String	getIdentifier()	Unique identifier for Image object.
ImageType	getImageType()	The image type.
boolean	isDetectAll()	Defines whether the comparison and detection should apply for all faces found on the image.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchFacesImage

public MatchFacesImage(Bitmap bitmap,
                       ImageType imageType)

MatchFacesImage

public MatchFacesImage(ImageType imageType,
                       Bitmap bitmap)

MatchFacesImage

public MatchFacesImage(ImageType imageType,
                       Bitmap bitmap,
                       boolean detectAll)

MatchFacesImage

public MatchFacesImage(Bitmap bitmap,
                       ImageType imageType,
                       boolean detectAll)

MatchFacesImage

public MatchFacesImage(Image image,
                       boolean detectAll)

MatchFacesImage

public MatchFacesImage(Image image)

Method Detail

getImageType

public ImageType getImageType()

The image type. The imageType influences matching results, therefore this field is required.

Returns:

int value one of ImageType

getBase64Image

public java.lang.String getBase64Image()

Return image in base64 format

Returns:

converted String in the base64

getBitmap

public Bitmap getBitmap()

The underlying image.

Returns:

Returns a bitmap of the underlying image.

isDetectAll

public boolean isDetectAll()

Defines whether the comparison and detection should apply for all faces found on the image. Defaults to `false`. When set to `false`, only the most centered faces are compared and detected. Otherwise, all the faces are compared and detected.

Returns:

Default: 'false'.

getIdentifier

public java.lang.String getIdentifier()

Unique identifier for Image object.

Returns:

UUID with RFC 4122 version 4 random by such as "E621E1F8-C36C-495A-93FC-0C247A3E6E5F".