Class FaceAnnotation.Builder (3.40.0)

public static final class FaceAnnotation.Builder extends GeneratedMessageV3.Builder<FaceAnnotation.Builder> implements FaceAnnotationOrBuilder

A face annotation object contains the results of face detection.

Protobuf type google.cloud.vision.v1.FaceAnnotation

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllLandmarks(Iterable<? extends FaceAnnotation.Landmark> values)

public FaceAnnotation.Builder addAllLandmarks(Iterable<? extends FaceAnnotation.Landmark> values)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.vision.v1.FaceAnnotation.Landmark>
Returns
Type Description
FaceAnnotation.Builder

addLandmarks(FaceAnnotation.Landmark value)

public FaceAnnotation.Builder addLandmarks(FaceAnnotation.Landmark value)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameter
Name Description
value FaceAnnotation.Landmark
Returns
Type Description
FaceAnnotation.Builder

addLandmarks(FaceAnnotation.Landmark.Builder builderForValue)

public FaceAnnotation.Builder addLandmarks(FaceAnnotation.Landmark.Builder builderForValue)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameter
Name Description
builderForValue FaceAnnotation.Landmark.Builder
Returns
Type Description
FaceAnnotation.Builder

addLandmarks(int index, FaceAnnotation.Landmark value)

public FaceAnnotation.Builder addLandmarks(int index, FaceAnnotation.Landmark value)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameters
Name Description
index int
value FaceAnnotation.Landmark
Returns
Type Description
FaceAnnotation.Builder

addLandmarks(int index, FaceAnnotation.Landmark.Builder builderForValue)

public FaceAnnotation.Builder addLandmarks(int index, FaceAnnotation.Landmark.Builder builderForValue)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameters
Name Description
index int
builderForValue FaceAnnotation.Landmark.Builder
Returns
Type Description
FaceAnnotation.Builder

addLandmarksBuilder()

public FaceAnnotation.Landmark.Builder addLandmarksBuilder()

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Returns
Type Description
FaceAnnotation.Landmark.Builder

addLandmarksBuilder(int index)

public FaceAnnotation.Landmark.Builder addLandmarksBuilder(int index)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameter
Name Description
index int
Returns
Type Description
FaceAnnotation.Landmark.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FaceAnnotation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FaceAnnotation.Builder
Overrides

build()

public FaceAnnotation build()
Returns
Type Description
FaceAnnotation

buildPartial()

public FaceAnnotation buildPartial()
Returns
Type Description
FaceAnnotation

clear()

public FaceAnnotation.Builder clear()
Returns
Type Description
FaceAnnotation.Builder
Overrides

clearAngerLikelihood()

public FaceAnnotation.Builder clearAngerLikelihood()

Anger likelihood.

.google.cloud.vision.v1.Likelihood anger_likelihood = 11;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearBlurredLikelihood()

public FaceAnnotation.Builder clearBlurredLikelihood()

Blurred likelihood.

.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearBoundingPoly()

public FaceAnnotation.Builder clearBoundingPoly()

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.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;

Returns
Type Description
FaceAnnotation.Builder

clearDetectionConfidence()

public FaceAnnotation.Builder clearDetectionConfidence()

Detection confidence. Range [0, 1].

float detection_confidence = 7;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearFdBoundingPoly()

public FaceAnnotation.Builder clearFdBoundingPoly()

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 <code>fd</code> (face detection) prefix.

.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;

Returns
Type Description
FaceAnnotation.Builder

clearField(Descriptors.FieldDescriptor field)

public FaceAnnotation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FaceAnnotation.Builder
Overrides

clearHeadwearLikelihood()

public FaceAnnotation.Builder clearHeadwearLikelihood()

Headwear likelihood.

.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearJoyLikelihood()

public FaceAnnotation.Builder clearJoyLikelihood()

Joy likelihood.

.google.cloud.vision.v1.Likelihood joy_likelihood = 9;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearLandmarkingConfidence()

public FaceAnnotation.Builder clearLandmarkingConfidence()

Face landmarking confidence. Range [0, 1].

float landmarking_confidence = 8;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearLandmarks()

public FaceAnnotation.Builder clearLandmarks()

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Returns
Type Description
FaceAnnotation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public FaceAnnotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FaceAnnotation.Builder
Overrides

clearPanAngle()

public FaceAnnotation.Builder clearPanAngle()

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 pan_angle = 5;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearRollAngle()

public FaceAnnotation.Builder clearRollAngle()

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 roll_angle = 4;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearSorrowLikelihood()

public FaceAnnotation.Builder clearSorrowLikelihood()

Sorrow likelihood.

.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearSurpriseLikelihood()

public FaceAnnotation.Builder clearSurpriseLikelihood()

Surprise likelihood.

.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearTiltAngle()

public FaceAnnotation.Builder clearTiltAngle()

Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].

float tilt_angle = 6;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clearUnderExposedLikelihood()

public FaceAnnotation.Builder clearUnderExposedLikelihood()

Under-exposed likelihood.

.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

clone()

public FaceAnnotation.Builder clone()
Returns
Type Description
FaceAnnotation.Builder
Overrides

getAngerLikelihood()

public Likelihood getAngerLikelihood()

Anger likelihood.

.google.cloud.vision.v1.Likelihood anger_likelihood = 11;

Returns
Type Description
Likelihood

The angerLikelihood.

getAngerLikelihoodValue()

public int getAngerLikelihoodValue()

Anger likelihood.

.google.cloud.vision.v1.Likelihood anger_likelihood = 11;

Returns
Type Description
int

The enum numeric value on the wire for angerLikelihood.

getBlurredLikelihood()

public Likelihood getBlurredLikelihood()

Blurred likelihood.

.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;

Returns
Type Description
Likelihood

The blurredLikelihood.

getBlurredLikelihoodValue()

public int getBlurredLikelihoodValue()

Blurred likelihood.

.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;

Returns
Type Description
int

The enum numeric value on the wire for blurredLikelihood.

getBoundingPoly()

public BoundingPoly 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.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;

Returns
Type Description
BoundingPoly

The boundingPoly.

getBoundingPolyBuilder()

public BoundingPoly.Builder getBoundingPolyBuilder()

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.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;

Returns
Type Description
BoundingPoly.Builder

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

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.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;

Returns
Type Description
BoundingPolyOrBuilder

getDefaultInstanceForType()

public FaceAnnotation getDefaultInstanceForType()
Returns
Type Description
FaceAnnotation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDetectionConfidence()

public float getDetectionConfidence()

Detection confidence. Range [0, 1].

float detection_confidence = 7;

Returns
Type Description
float

The detectionConfidence.

getFdBoundingPoly()

public BoundingPoly 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 <code>fd</code> (face detection) prefix.

.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;

Returns
Type Description
BoundingPoly

The fdBoundingPoly.

getFdBoundingPolyBuilder()

public BoundingPoly.Builder getFdBoundingPolyBuilder()

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 <code>fd</code> (face detection) prefix.

.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;

Returns
Type Description
BoundingPoly.Builder

getFdBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getFdBoundingPolyOrBuilder()

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 <code>fd</code> (face detection) prefix.

.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;

Returns
Type Description
BoundingPolyOrBuilder

getHeadwearLikelihood()

public Likelihood getHeadwearLikelihood()

Headwear likelihood.

.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;

Returns
Type Description
Likelihood

The headwearLikelihood.

getHeadwearLikelihoodValue()

public int getHeadwearLikelihoodValue()

Headwear likelihood.

.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;

Returns
Type Description
int

The enum numeric value on the wire for headwearLikelihood.

getJoyLikelihood()

public Likelihood getJoyLikelihood()

Joy likelihood.

.google.cloud.vision.v1.Likelihood joy_likelihood = 9;

Returns
Type Description
Likelihood

The joyLikelihood.

getJoyLikelihoodValue()

public int getJoyLikelihoodValue()

Joy likelihood.

.google.cloud.vision.v1.Likelihood joy_likelihood = 9;

Returns
Type Description
int

The enum numeric value on the wire for joyLikelihood.

getLandmarkingConfidence()

public float getLandmarkingConfidence()

Face landmarking confidence. Range [0, 1].

float landmarking_confidence = 8;

Returns
Type Description
float

The landmarkingConfidence.

getLandmarks(int index)

public FaceAnnotation.Landmark getLandmarks(int index)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameter
Name Description
index int
Returns
Type Description
FaceAnnotation.Landmark

getLandmarksBuilder(int index)

public FaceAnnotation.Landmark.Builder getLandmarksBuilder(int index)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameter
Name Description
index int
Returns
Type Description
FaceAnnotation.Landmark.Builder

getLandmarksBuilderList()

public List<FaceAnnotation.Landmark.Builder> getLandmarksBuilderList()

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Returns
Type Description
List<Builder>

getLandmarksCount()

public int getLandmarksCount()

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Returns
Type Description
int

getLandmarksList()

public List<FaceAnnotation.Landmark> getLandmarksList()

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Returns
Type Description
List<Landmark>

getLandmarksOrBuilder(int index)

public FaceAnnotation.LandmarkOrBuilder getLandmarksOrBuilder(int index)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameter
Name Description
index int
Returns
Type Description
FaceAnnotation.LandmarkOrBuilder

getLandmarksOrBuilderList()

public List<? extends FaceAnnotation.LandmarkOrBuilder> getLandmarksOrBuilderList()

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Returns
Type Description
List<? extends com.google.cloud.vision.v1.FaceAnnotation.LandmarkOrBuilder>

getPanAngle()

public float 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 pan_angle = 5;

Returns
Type Description
float

The panAngle.

getRollAngle()

public float 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 roll_angle = 4;

Returns
Type Description
float

The rollAngle.

getSorrowLikelihood()

public Likelihood getSorrowLikelihood()

Sorrow likelihood.

.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;

Returns
Type Description
Likelihood

The sorrowLikelihood.

getSorrowLikelihoodValue()

public int getSorrowLikelihoodValue()

Sorrow likelihood.

.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;

Returns
Type Description
int

The enum numeric value on the wire for sorrowLikelihood.

getSurpriseLikelihood()

public Likelihood getSurpriseLikelihood()

Surprise likelihood.

.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;

Returns
Type Description
Likelihood

The surpriseLikelihood.

getSurpriseLikelihoodValue()

public int getSurpriseLikelihoodValue()

Surprise likelihood.

.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;

Returns
Type Description
int

The enum numeric value on the wire for surpriseLikelihood.

getTiltAngle()

public float 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 tilt_angle = 6;

Returns
Type Description
float

The tiltAngle.

getUnderExposedLikelihood()

public Likelihood getUnderExposedLikelihood()

Under-exposed likelihood.

.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;

Returns
Type Description
Likelihood

The underExposedLikelihood.

getUnderExposedLikelihoodValue()

public int getUnderExposedLikelihoodValue()

Under-exposed likelihood.

.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;

Returns
Type Description
int

The enum numeric value on the wire for underExposedLikelihood.

hasBoundingPoly()

public boolean hasBoundingPoly()

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.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;

Returns
Type Description
boolean

Whether the boundingPoly field is set.

hasFdBoundingPoly()

public boolean hasFdBoundingPoly()

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 <code>fd</code> (face detection) prefix.

.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;

Returns
Type Description
boolean

Whether the fdBoundingPoly field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBoundingPoly(BoundingPoly value)

public FaceAnnotation.Builder mergeBoundingPoly(BoundingPoly value)

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.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;

Parameter
Name Description
value BoundingPoly
Returns
Type Description
FaceAnnotation.Builder

mergeFdBoundingPoly(BoundingPoly value)

public FaceAnnotation.Builder mergeFdBoundingPoly(BoundingPoly value)

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 <code>fd</code> (face detection) prefix.

.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;

Parameter
Name Description
value BoundingPoly
Returns
Type Description
FaceAnnotation.Builder

mergeFrom(FaceAnnotation other)

public FaceAnnotation.Builder mergeFrom(FaceAnnotation other)
Parameter
Name Description
other FaceAnnotation
Returns
Type Description
FaceAnnotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FaceAnnotation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FaceAnnotation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FaceAnnotation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FaceAnnotation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FaceAnnotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FaceAnnotation.Builder
Overrides

removeLandmarks(int index)

public FaceAnnotation.Builder removeLandmarks(int index)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameter
Name Description
index int
Returns
Type Description
FaceAnnotation.Builder

setAngerLikelihood(Likelihood value)

public FaceAnnotation.Builder setAngerLikelihood(Likelihood value)

Anger likelihood.

.google.cloud.vision.v1.Likelihood anger_likelihood = 11;

Parameter
Name Description
value Likelihood

The angerLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setAngerLikelihoodValue(int value)

public FaceAnnotation.Builder setAngerLikelihoodValue(int value)

Anger likelihood.

.google.cloud.vision.v1.Likelihood anger_likelihood = 11;

Parameter
Name Description
value int

The enum numeric value on the wire for angerLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setBlurredLikelihood(Likelihood value)

public FaceAnnotation.Builder setBlurredLikelihood(Likelihood value)

Blurred likelihood.

.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;

Parameter
Name Description
value Likelihood

The blurredLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setBlurredLikelihoodValue(int value)

public FaceAnnotation.Builder setBlurredLikelihoodValue(int value)

Blurred likelihood.

.google.cloud.vision.v1.Likelihood blurred_likelihood = 14;

Parameter
Name Description
value int

The enum numeric value on the wire for blurredLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setBoundingPoly(BoundingPoly value)

public FaceAnnotation.Builder setBoundingPoly(BoundingPoly value)

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.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;

Parameter
Name Description
value BoundingPoly
Returns
Type Description
FaceAnnotation.Builder

setBoundingPoly(BoundingPoly.Builder builderForValue)

public FaceAnnotation.Builder setBoundingPoly(BoundingPoly.Builder builderForValue)

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.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 1;

Parameter
Name Description
builderForValue BoundingPoly.Builder
Returns
Type Description
FaceAnnotation.Builder

setDetectionConfidence(float value)

public FaceAnnotation.Builder setDetectionConfidence(float value)

Detection confidence. Range [0, 1].

float detection_confidence = 7;

Parameter
Name Description
value float

The detectionConfidence to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setFdBoundingPoly(BoundingPoly value)

public FaceAnnotation.Builder setFdBoundingPoly(BoundingPoly value)

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 <code>fd</code> (face detection) prefix.

.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;

Parameter
Name Description
value BoundingPoly
Returns
Type Description
FaceAnnotation.Builder

setFdBoundingPoly(BoundingPoly.Builder builderForValue)

public FaceAnnotation.Builder setFdBoundingPoly(BoundingPoly.Builder builderForValue)

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 <code>fd</code> (face detection) prefix.

.google.cloud.vision.v1.BoundingPoly fd_bounding_poly = 2;

Parameter
Name Description
builderForValue BoundingPoly.Builder
Returns
Type Description
FaceAnnotation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FaceAnnotation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FaceAnnotation.Builder
Overrides

setHeadwearLikelihood(Likelihood value)

public FaceAnnotation.Builder setHeadwearLikelihood(Likelihood value)

Headwear likelihood.

.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;

Parameter
Name Description
value Likelihood

The headwearLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setHeadwearLikelihoodValue(int value)

public FaceAnnotation.Builder setHeadwearLikelihoodValue(int value)

Headwear likelihood.

.google.cloud.vision.v1.Likelihood headwear_likelihood = 15;

Parameter
Name Description
value int

The enum numeric value on the wire for headwearLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setJoyLikelihood(Likelihood value)

public FaceAnnotation.Builder setJoyLikelihood(Likelihood value)

Joy likelihood.

.google.cloud.vision.v1.Likelihood joy_likelihood = 9;

Parameter
Name Description
value Likelihood

The joyLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setJoyLikelihoodValue(int value)

public FaceAnnotation.Builder setJoyLikelihoodValue(int value)

Joy likelihood.

.google.cloud.vision.v1.Likelihood joy_likelihood = 9;

Parameter
Name Description
value int

The enum numeric value on the wire for joyLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setLandmarkingConfidence(float value)

public FaceAnnotation.Builder setLandmarkingConfidence(float value)

Face landmarking confidence. Range [0, 1].

float landmarking_confidence = 8;

Parameter
Name Description
value float

The landmarkingConfidence to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setLandmarks(int index, FaceAnnotation.Landmark value)

public FaceAnnotation.Builder setLandmarks(int index, FaceAnnotation.Landmark value)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameters
Name Description
index int
value FaceAnnotation.Landmark
Returns
Type Description
FaceAnnotation.Builder

setLandmarks(int index, FaceAnnotation.Landmark.Builder builderForValue)

public FaceAnnotation.Builder setLandmarks(int index, FaceAnnotation.Landmark.Builder builderForValue)

Detected face landmarks.

repeated .google.cloud.vision.v1.FaceAnnotation.Landmark landmarks = 3;

Parameters
Name Description
index int
builderForValue FaceAnnotation.Landmark.Builder
Returns
Type Description
FaceAnnotation.Builder

setPanAngle(float value)

public FaceAnnotation.Builder setPanAngle(float value)

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 pan_angle = 5;

Parameter
Name Description
value float

The panAngle to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FaceAnnotation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FaceAnnotation.Builder
Overrides

setRollAngle(float value)

public FaceAnnotation.Builder setRollAngle(float value)

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 roll_angle = 4;

Parameter
Name Description
value float

The rollAngle to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setSorrowLikelihood(Likelihood value)

public FaceAnnotation.Builder setSorrowLikelihood(Likelihood value)

Sorrow likelihood.

.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;

Parameter
Name Description
value Likelihood

The sorrowLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setSorrowLikelihoodValue(int value)

public FaceAnnotation.Builder setSorrowLikelihoodValue(int value)

Sorrow likelihood.

.google.cloud.vision.v1.Likelihood sorrow_likelihood = 10;

Parameter
Name Description
value int

The enum numeric value on the wire for sorrowLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setSurpriseLikelihood(Likelihood value)

public FaceAnnotation.Builder setSurpriseLikelihood(Likelihood value)

Surprise likelihood.

.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;

Parameter
Name Description
value Likelihood

The surpriseLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setSurpriseLikelihoodValue(int value)

public FaceAnnotation.Builder setSurpriseLikelihoodValue(int value)

Surprise likelihood.

.google.cloud.vision.v1.Likelihood surprise_likelihood = 12;

Parameter
Name Description
value int

The enum numeric value on the wire for surpriseLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setTiltAngle(float value)

public FaceAnnotation.Builder setTiltAngle(float value)

Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].

float tilt_angle = 6;

Parameter
Name Description
value float

The tiltAngle to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setUnderExposedLikelihood(Likelihood value)

public FaceAnnotation.Builder setUnderExposedLikelihood(Likelihood value)

Under-exposed likelihood.

.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;

Parameter
Name Description
value Likelihood

The underExposedLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setUnderExposedLikelihoodValue(int value)

public FaceAnnotation.Builder setUnderExposedLikelihoodValue(int value)

Under-exposed likelihood.

.google.cloud.vision.v1.Likelihood under_exposed_likelihood = 13;

Parameter
Name Description
value int

The enum numeric value on the wire for underExposedLikelihood to set.

Returns
Type Description
FaceAnnotation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FaceAnnotation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FaceAnnotation.Builder
Overrides