Reference documentation and code samples for the Cloud Vision V1p4beta1 API class Google::Cloud::Vision::V1p4beta1::FaceAnnotation.
A face annotation object contains the results of face detection.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#anger_likelihood
def anger_likelihood() -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Anger likelihood.
#anger_likelihood=
def anger_likelihood=(value) -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Parameter
- value (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Anger likelihood.
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Anger likelihood.
#blurred_likelihood
def blurred_likelihood() -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Blurred likelihood.
#blurred_likelihood=
def blurred_likelihood=(value) -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Parameter
- value (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Blurred likelihood.
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Blurred likelihood.
#bounding_poly
def bounding_poly() -> ::Google::Cloud::Vision::V1p4beta1::BoundingPoly
Returns
-
(::Google::Cloud::Vision::V1p4beta1::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.
#bounding_poly=
def bounding_poly=(value) -> ::Google::Cloud::Vision::V1p4beta1::BoundingPoly
Parameter
-
value (::Google::Cloud::Vision::V1p4beta1::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.
Returns
-
(::Google::Cloud::Vision::V1p4beta1::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.
#detection_confidence
def detection_confidence() -> ::Float
Returns
- (::Float) — Detection confidence. Range [0, 1].
#detection_confidence=
def detection_confidence=(value) -> ::Float
Parameter
- value (::Float) — Detection confidence. Range [0, 1].
Returns
- (::Float) — Detection confidence. Range [0, 1].
#fd_bounding_poly
def fd_bounding_poly() -> ::Google::Cloud::Vision::V1p4beta1::BoundingPoly
Returns
-
(::Google::Cloud::Vision::V1p4beta1::BoundingPoly) — The
fd_bounding_poly
bounding polygon is tighter than theboundingPoly
, 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 thefd
(face detection) prefix.
#fd_bounding_poly=
def fd_bounding_poly=(value) -> ::Google::Cloud::Vision::V1p4beta1::BoundingPoly
Parameter
-
value (::Google::Cloud::Vision::V1p4beta1::BoundingPoly) — The
fd_bounding_poly
bounding polygon is tighter than theboundingPoly
, 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 thefd
(face detection) prefix.
Returns
-
(::Google::Cloud::Vision::V1p4beta1::BoundingPoly) — The
fd_bounding_poly
bounding polygon is tighter than theboundingPoly
, 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 thefd
(face detection) prefix.
#headwear_likelihood
def headwear_likelihood() -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Headwear likelihood.
#headwear_likelihood=
def headwear_likelihood=(value) -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Parameter
- value (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Headwear likelihood.
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Headwear likelihood.
#joy_likelihood
def joy_likelihood() -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Joy likelihood.
#joy_likelihood=
def joy_likelihood=(value) -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Parameter
- value (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Joy likelihood.
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Joy likelihood.
#landmarking_confidence
def landmarking_confidence() -> ::Float
Returns
- (::Float) — Face landmarking confidence. Range [0, 1].
#landmarking_confidence=
def landmarking_confidence=(value) -> ::Float
Parameter
- value (::Float) — Face landmarking confidence. Range [0, 1].
Returns
- (::Float) — Face landmarking confidence. Range [0, 1].
#landmarks
def landmarks() -> ::Array<::Google::Cloud::Vision::V1p4beta1::FaceAnnotation::Landmark>
Returns
- (::Array<::Google::Cloud::Vision::V1p4beta1::FaceAnnotation::Landmark>) — Detected face landmarks.
#landmarks=
def landmarks=(value) -> ::Array<::Google::Cloud::Vision::V1p4beta1::FaceAnnotation::Landmark>
Parameter
- value (::Array<::Google::Cloud::Vision::V1p4beta1::FaceAnnotation::Landmark>) — Detected face landmarks.
Returns
- (::Array<::Google::Cloud::Vision::V1p4beta1::FaceAnnotation::Landmark>) — Detected face landmarks.
#pan_angle
def pan_angle() -> ::Float
Returns
- (::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].
#pan_angle=
def pan_angle=(value) -> ::Float
Parameter
- value (::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].
Returns
- (::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].
#recognition_result
def recognition_result() -> ::Array<::Google::Cloud::Vision::V1p4beta1::FaceRecognitionResult>
Returns
- (::Array<::Google::Cloud::Vision::V1p4beta1::FaceRecognitionResult>) — Additional recognition information. Only computed if image_context.face_recognition_params is provided, and a match is found to a Celebrity in the input [CelebritySet][google.cloud.vision.v1p4beta1.CelebritySet]. This field is sorted in order of decreasing confidence values.
#recognition_result=
def recognition_result=(value) -> ::Array<::Google::Cloud::Vision::V1p4beta1::FaceRecognitionResult>
Parameter
- value (::Array<::Google::Cloud::Vision::V1p4beta1::FaceRecognitionResult>) — Additional recognition information. Only computed if image_context.face_recognition_params is provided, and a match is found to a Celebrity in the input [CelebritySet][google.cloud.vision.v1p4beta1.CelebritySet]. This field is sorted in order of decreasing confidence values.
Returns
- (::Array<::Google::Cloud::Vision::V1p4beta1::FaceRecognitionResult>) — Additional recognition information. Only computed if image_context.face_recognition_params is provided, and a match is found to a Celebrity in the input [CelebritySet][google.cloud.vision.v1p4beta1.CelebritySet]. This field is sorted in order of decreasing confidence values.
#roll_angle
def roll_angle() -> ::Float
Returns
- (::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].
#roll_angle=
def roll_angle=(value) -> ::Float
Parameter
- value (::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].
Returns
- (::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].
#sorrow_likelihood
def sorrow_likelihood() -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Sorrow likelihood.
#sorrow_likelihood=
def sorrow_likelihood=(value) -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Parameter
- value (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Sorrow likelihood.
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Sorrow likelihood.
#surprise_likelihood
def surprise_likelihood() -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Surprise likelihood.
#surprise_likelihood=
def surprise_likelihood=(value) -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Parameter
- value (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Surprise likelihood.
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Surprise likelihood.
#tilt_angle
def tilt_angle() -> ::Float
Returns
- (::Float) — Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
#tilt_angle=
def tilt_angle=(value) -> ::Float
Parameter
- value (::Float) — Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
Returns
- (::Float) — Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
#under_exposed_likelihood
def under_exposed_likelihood() -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Under-exposed likelihood.
#under_exposed_likelihood=
def under_exposed_likelihood=(value) -> ::Google::Cloud::Vision::V1p4beta1::Likelihood
Parameter
- value (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Under-exposed likelihood.
Returns
- (::Google::Cloud::Vision::V1p4beta1::Likelihood) — Under-exposed likelihood.