Class MatchFacesDetectionFace

Represents face detection information as a part of MatchFacesResponse.

Index

Accessors

crop faceIndex faceRect landmarks originalRect rotationAngle

Accessors

crop

get crop(): string | null
String image of the aligned and cropped portrait. Returned if MatchFacesRequest.outputImageParams is set or predefined scenario is used.

Returns string | null
- Defined in match_faces/match_faces_detection_face.d.ts:40

faceIndex

get faceIndex(): number
The index of the face detection object in the array of detections.

Returns number
- Defined in match_faces/match_faces_detection_face.d.ts:11

faceRect

get faceRect(): Rect
Rectangular area of the detected face in the original image.

Returns Rect
- Defined in match_faces/match_faces_detection_face.d.ts:21

landmarks

get landmarks(): Point[]
Main coordinates of the detected face (eyes, nose, lips, ears and etc.).

Returns Point[]
- Defined in match_faces/match_faces_detection_face.d.ts:16

originalRect

get originalRect(): Rect | null
Coordinates of the rectangle with the face on the original image prepared for the face crop. Requires OutputImageCrop.returnOriginalRect is set. Returns null if OutputImageCrop.returnOriginalRect isn't set.

Returns Rect | null
- Defined in match_faces/match_faces_detection_face.d.ts:34

rotationAngle

get rotationAngle(): number | null
Rotation is measured counterclockwise in degrees, with zero indicating that a line drawn between the eyes is horizontal relative to the image orientation.

Returns number | null
- Defined in match_faces/match_faces_detection_face.d.ts:27