Reference documentation and code samples for the Cloud Vision V1 Client class FaceAnnotation.
A face annotation object contains the results of face detection.
Generated from protobuf message google.cloud.vision.v1.FaceAnnotation
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ bounding_poly
Google\Cloud\Vision\V1\BoundingPoly
The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the BoundingPoly
(the polygon will be unbounded) if only a partial face appears in the image to be annotated.
↳ fd_bounding_poly
Google\Cloud\Vision\V1\BoundingPoly
The fd_bounding_poly
bounding polygon is tighter than the boundingPoly
, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd
(face detection) prefix.
↳ landmarks
↳ roll_angle
float
Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].
↳ pan_angle
float
Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].
↳ tilt_angle
float
Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
↳ detection_confidence
float
Detection confidence. Range [0, 1].
↳ landmarking_confidence
float
Face landmarking confidence. Range [0, 1].
↳ joy_likelihood
int
Joy likelihood.
↳ sorrow_likelihood
int
Sorrow likelihood.
↳ anger_likelihood
int
Anger likelihood.
↳ surprise_likelihood
int
Surprise likelihood.
↳ under_exposed_likelihood
int
Under-exposed likelihood.
↳ blurred_likelihood
int
Blurred likelihood.
↳ headwear_likelihood
int
Headwear likelihood.
getBoundingPoly
The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale.
The bounding box is computed to "frame" the face in accordance with human
expectations. It is based on the landmarker results.
Note that one or more x and/or y coordinates may not be generated in the BoundingPoly
(the polygon will be unbounded) if only a partial face
appears in the image to be annotated.
hasBoundingPoly
clearBoundingPoly
setBoundingPoly
The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale.
The bounding box is computed to "frame" the face in accordance with human
expectations. It is based on the landmarker results.
Note that one or more x and/or y coordinates may not be generated in the BoundingPoly
(the polygon will be unbounded) if only a partial face
appears in the image to be annotated.
$this
getFdBoundingPoly
The fd_bounding_poly
bounding polygon is tighter than the boundingPoly
, and encloses only the skin part of the face. Typically, it
is used to eliminate the face from any image analysis that detects the
"amount of skin" visible in an image. It is not based on the
landmarker results, only on the initial face detection, hence
the fd
(face detection) prefix.
hasFdBoundingPoly
clearFdBoundingPoly
setFdBoundingPoly
The fd_bounding_poly
bounding polygon is tighter than the boundingPoly
, and encloses only the skin part of the face. Typically, it
is used to eliminate the face from any image analysis that detects the
"amount of skin" visible in an image. It is not based on the
landmarker results, only on the initial face detection, hence
the fd
(face detection) prefix.
$this
getLandmarks
Detected face landmarks.
setLandmarks
Detected face landmarks.
$this
getRollAngle
Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].
float
setRollAngle
Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].
var
float
$this
getPanAngle
Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].
float
setPanAngle
Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].
var
float
$this
getTiltAngle
Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
float
setTiltAngle
Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
var
float
$this
getDetectionConfidence
Detection confidence. Range [0, 1].
float
setDetectionConfidence
Detection confidence. Range [0, 1].
var
float
$this
getLandmarkingConfidence
Face landmarking confidence. Range [0, 1].
float
setLandmarkingConfidence
Face landmarking confidence. Range [0, 1].
var
float
$this
getJoyLikelihood
Joy likelihood.
int
setJoyLikelihood
Joy likelihood.
var
int
$this
getSorrowLikelihood
Sorrow likelihood.
int
setSorrowLikelihood
Sorrow likelihood.
var
int
$this
getAngerLikelihood
Anger likelihood.
int
setAngerLikelihood
Anger likelihood.
var
int
$this
getSurpriseLikelihood
Surprise likelihood.
int
setSurpriseLikelihood
Surprise likelihood.
var
int
$this
getUnderExposedLikelihood
Under-exposed likelihood.
int
setUnderExposedLikelihood
Under-exposed likelihood.
var
int
$this
getBlurredLikelihood
Blurred likelihood.
int
setBlurredLikelihood
Blurred likelihood.
var
int
$this
getHeadwearLikelihood
Headwear likelihood.
int
setHeadwearLikelihood
Headwear likelihood.
var
int
$this
