Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
com.tech5.FaceSDK.Face Class Reference
Inheritance diagram for com.tech5.FaceSDK.Face:

Public Member Functions

float getConfidence ()
 
int getX ()
 
int getY ()
 
int getWidth ()
 
int getHeight ()
 
Image getImg ()
 
Image getCroppedImage ()
 
boolean hasLandmarks ()
 
LandmarkSet getLandmarks ()
 
boolean isOutOfBoundsSet ()
 
boolean outOfBounds ()
 
int getVersion ()
 
boolean equals (Object o)
 
int hashCode ()
 
void close () throws Exception
 
 Face (Image img) throws FaceSDKException
 
 Face (Image img, int version) throws FaceSDKException
 
 Face (Image img, boolean outOfBounds, int version) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence, int version) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence, boolean outOfBounds, int version) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence, LandmarkSet landmarkSet) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence, LandmarkSet landmarkSet, int version) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence, LandmarkSet landmarkSet, boolean outOfBounds, int version) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence, LandmarkSet landmarkSet, Image croppedImage) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence, LandmarkSet landmarkSet, Image croppedImage, int version) throws FaceSDKException
 
 Face (Image img, int x, int y, int width, int height, float confidence, LandmarkSet landmarkSet, Image croppedImage, boolean outOfBounds, int version) throws FaceSDKException
 

Static Public Attributes

static final float FACE_SDK__UNKNOWN_CONFIDENCE = 0.0f
 
static final int FACE_SDK__UNKNOWN_VERSION = 0
 

Protected Member Functions

void finalize () throws Throwable
 

Detailed Description

Face object contains information about face bounding box on the image and the original (or cropped) image. FaceDetector produces Face objects, which can be serialized (and deserialized) using Serializer class. In special cases Face object can be created manually using ctors.

Constructor & Destructor Documentation

◆ Face() [1/12]

com.tech5.FaceSDK.Face.Face ( Image  img) throws FaceSDKException
inline

Makes the face object with specified Image. Bounding box size is set equal to the original image size.

Parameters
imgImage with face.
Exceptions
IllegalArgumentExceptionif img is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [2/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  version 
) throws FaceSDKException
inline

Makes the face object with specified version. Bounding box size is set equal to the original image size.

Parameters
imgImage with face.
versionFace object version.
Exceptions
IllegalArgumentExceptionif img is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [3/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
boolean  outOfBounds,
int  version 
) throws FaceSDKException
inline

Makes the face object with specified out of bound flag and version. Bounding box size is set equal to the original image size.

Parameters
imgImage with face.
outOfBoundsFace out of bounds flag.
versionFace object version.
Exceptions
IllegalArgumentExceptionif img is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [4/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box and confidence.

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthwidth of face bounding box in pixels.
heightheight of face bounding box in pixels.
confidenceface detection confidence.
Exceptions
IllegalArgumentExceptionif img is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [5/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence,
int  version 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box, confidence and version

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthWidth of face bounding box in pixels.
heightHeight of face bounding box in pixels.
confidenceface detection confidence.
versionFace object version.
Exceptions
IllegalArgumentExceptionif img is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [6/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence,
boolean  outOfBounds,
int  version 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box, confidence, outOfBounds flag and version

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthWidth of face bounding box in pixels.
heightHeight of face bounding box in pixels.
confidenceface detection confidence.
outOfBoundsFace out of bounds flag.
versionFace object version.
Exceptions
IllegalArgumentExceptionif img is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [7/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence,
LandmarkSet  landmarkSet 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box, confidence and landmarks

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthWidth of face bounding box in pixels.
heightHeight of face bounding box in pixels.
confidenceface detection confidence.
landmarkSetFace landmarks.
Exceptions
IllegalArgumentExceptionif img is null of if landmarkSet is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [8/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence,
LandmarkSet  landmarkSet,
int  version 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box, confidence, landmarks and version

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthWidth of face bounding box in pixels.
heightHeight of face bounding box in pixels.
confidenceface detection confidence.
landmarkSetFace landmarks.
versionFace object version.
Exceptions
IllegalArgumentExceptionif img is null of if landmarkSet is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [9/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence,
LandmarkSet  landmarkSet,
boolean  outOfBounds,
int  version 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box, confidence, landmarks, outOfBounds flag and version.

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthWidth of face bounding box in pixels.
heightHeight of face bounding box in pixels.
confidenceface detection confidence.
landmarkSetFace landmarks.
outOfBoundsFace out of bounds flag.
versionFace object version.
Exceptions
IllegalArgumentExceptionif img is null of if landmarkSet is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [10/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence,
LandmarkSet  landmarkSet,
Image  croppedImage 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box, confidence, landmarks and cropped image.

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthWidth of face bounding box in pixels.
heightHeight of face bounding box in pixels.
confidenceface detection confidence.
landmarkSetFace landmarks.
croppedImageCropped face.
Exceptions
IllegalArgumentExceptionif img is null of if landmarkSet is null or croppedImage is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [11/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence,
LandmarkSet  landmarkSet,
Image  croppedImage,
int  version 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box, confidence, landmarks, croppedImage version.

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthWidth of face bounding box in pixels.
heightHeight of face bounding box in pixels.
confidenceface detection confidence.
landmarkSetFace landmarks.
croppedImageCropped face.
versionFace object version.
Exceptions
IllegalArgumentExceptionif img is null of if landmarkSet is null or croppedImage is null.
FaceSDKExceptionin case of an error in native code.

◆ Face() [12/12]

com.tech5.FaceSDK.Face.Face ( Image  img,
int  x,
int  y,
int  width,
int  height,
float  confidence,
LandmarkSet  landmarkSet,
Image  croppedImage,
boolean  outOfBounds,
int  version 
) throws FaceSDKException
inline

Makes the face object with specified coordinates of bounding box, landmarks, croppedImage, outOfBounds flag and version.

Parameters
imgImage with face.
xX coordinate of face bounding box in pixels.
yY coordinate of face bounding box in pixels.
widthWidth of face bounding box in pixels.
heightHeight of face bounding box in pixels.
confidenceface detection confidence.
landmarkSetFace landmarks.
croppedImageCropped face.
outOfBoundsFace out of bounds flag.
versionFace object version.
Exceptions
IllegalArgumentExceptionif img is null of if landmarkSet is null or croppedImage is null.
FaceSDKExceptionin case of an error in native code.

Member Data Documentation

◆ FACE_SDK__UNKNOWN_CONFIDENCE

final float com.tech5.FaceSDK.Face.FACE_SDK__UNKNOWN_CONFIDENCE = 0.0f
static

The value of FACE_SDK__UNKNOWN_CONFIDENCE constant is {}.

◆ FACE_SDK__UNKNOWN_VERSION

final int com.tech5.FaceSDK.Face.FACE_SDK__UNKNOWN_VERSION = 0
static

The value of FACE_SDK__UNKNOWN_VERSION constant is {}.


The documentation for this class was generated from the following file: