@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FaceDetail extends Object implements Serializable, Cloneable, StructuredPojo
Structure containing attributes of the face that the algorithm detected.
A FaceDetail
object contains either the default facial attributes or all facial attributes. The default
attributes are BoundingBox
, Confidence
, Landmarks
, Pose
, and
Quality
.
GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a
FaceDetail
object with all attributes. To specify which attributes to return, use the
FaceAttributes
input parameter for StartFaceDetection. The following Amazon Rekognition Video
operations return only the default attributes. The corresponding Start operations don't have a
FaceAttributes
input parameter:
GetCelebrityRecognition
GetPersonTracking
GetFaceSearch
The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To
specify which attributes to return, use the Attributes
input parameter for DetectFaces
. For
IndexFaces
, use the DetectAttributes
input parameter.
Constructor and Description |
---|
FaceDetail() |
Modifier and Type | Method and Description |
---|---|
FaceDetail |
clone() |
boolean |
equals(Object obj) |
AgeRange |
getAgeRange()
The estimated age range, in years, for the face.
|
Beard |
getBeard()
Indicates whether or not the face has a beard, and the confidence level in the determination.
|
BoundingBox |
getBoundingBox()
Bounding box of the face.
|
Float |
getConfidence()
Confidence level that the bounding box contains a face (and not a different object such as a tree).
|
List<Emotion> |
getEmotions()
The emotions that appear to be expressed on the face, and the confidence level in the determination.
|
EyeDirection |
getEyeDirection()
Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
|
Eyeglasses |
getEyeglasses()
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
|
EyeOpen |
getEyesOpen()
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
|
FaceOccluded |
getFaceOccluded()
FaceOccluded should return "true" with a high confidence score if a detected face’s eyes, nose, and
mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other
objects. |
Gender |
getGender()
The predicted gender of a detected face.
|
List<Landmark> |
getLandmarks()
Indicates the location of landmarks on the face.
|
MouthOpen |
getMouthOpen()
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
|
Mustache |
getMustache()
Indicates whether or not the face has a mustache, and the confidence level in the determination.
|
Pose |
getPose()
Indicates the pose of the face as determined by its pitch, roll, and yaw.
|
ImageQuality |
getQuality()
Identifies image brightness and sharpness.
|
Smile |
getSmile()
Indicates whether or not the face is smiling, and the confidence level in the determination.
|
Sunglasses |
getSunglasses()
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAgeRange(AgeRange ageRange)
The estimated age range, in years, for the face.
|
void |
setBeard(Beard beard)
Indicates whether or not the face has a beard, and the confidence level in the determination.
|
void |
setBoundingBox(BoundingBox boundingBox)
Bounding box of the face.
|
void |
setConfidence(Float confidence)
Confidence level that the bounding box contains a face (and not a different object such as a tree).
|
void |
setEmotions(Collection<Emotion> emotions)
The emotions that appear to be expressed on the face, and the confidence level in the determination.
|
void |
setEyeDirection(EyeDirection eyeDirection)
Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
|
void |
setEyeglasses(Eyeglasses eyeglasses)
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
|
void |
setEyesOpen(EyeOpen eyesOpen)
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
|
void |
setFaceOccluded(FaceOccluded faceOccluded)
FaceOccluded should return "true" with a high confidence score if a detected face’s eyes, nose, and
mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other
objects. |
void |
setGender(Gender gender)
The predicted gender of a detected face.
|
void |
setLandmarks(Collection<Landmark> landmarks)
Indicates the location of landmarks on the face.
|
void |
setMouthOpen(MouthOpen mouthOpen)
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
|
void |
setMustache(Mustache mustache)
Indicates whether or not the face has a mustache, and the confidence level in the determination.
|
void |
setPose(Pose pose)
Indicates the pose of the face as determined by its pitch, roll, and yaw.
|
void |
setQuality(ImageQuality quality)
Identifies image brightness and sharpness.
|
void |
setSmile(Smile smile)
Indicates whether or not the face is smiling, and the confidence level in the determination.
|
void |
setSunglasses(Sunglasses sunglasses)
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
|
String |
toString()
Returns a string representation of this object.
|
FaceDetail |
withAgeRange(AgeRange ageRange)
The estimated age range, in years, for the face.
|
FaceDetail |
withBeard(Beard beard)
Indicates whether or not the face has a beard, and the confidence level in the determination.
|
FaceDetail |
withBoundingBox(BoundingBox boundingBox)
Bounding box of the face.
|
FaceDetail |
withConfidence(Float confidence)
Confidence level that the bounding box contains a face (and not a different object such as a tree).
|
FaceDetail |
withEmotions(Collection<Emotion> emotions)
The emotions that appear to be expressed on the face, and the confidence level in the determination.
|
FaceDetail |
withEmotions(Emotion... emotions)
The emotions that appear to be expressed on the face, and the confidence level in the determination.
|
FaceDetail |
withEyeDirection(EyeDirection eyeDirection)
Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
|
FaceDetail |
withEyeglasses(Eyeglasses eyeglasses)
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
|
FaceDetail |
withEyesOpen(EyeOpen eyesOpen)
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
|
FaceDetail |
withFaceOccluded(FaceOccluded faceOccluded)
FaceOccluded should return "true" with a high confidence score if a detected face’s eyes, nose, and
mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other
objects. |
FaceDetail |
withGender(Gender gender)
The predicted gender of a detected face.
|
FaceDetail |
withLandmarks(Collection<Landmark> landmarks)
Indicates the location of landmarks on the face.
|
FaceDetail |
withLandmarks(Landmark... landmarks)
Indicates the location of landmarks on the face.
|
FaceDetail |
withMouthOpen(MouthOpen mouthOpen)
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
|
FaceDetail |
withMustache(Mustache mustache)
Indicates whether or not the face has a mustache, and the confidence level in the determination.
|
FaceDetail |
withPose(Pose pose)
Indicates the pose of the face as determined by its pitch, roll, and yaw.
|
FaceDetail |
withQuality(ImageQuality quality)
Identifies image brightness and sharpness.
|
FaceDetail |
withSmile(Smile smile)
Indicates whether or not the face is smiling, and the confidence level in the determination.
|
FaceDetail |
withSunglasses(Sunglasses sunglasses)
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
|
public void setBoundingBox(BoundingBox boundingBox)
Bounding box of the face. Default attribute.
boundingBox
- Bounding box of the face. Default attribute.public BoundingBox getBoundingBox()
Bounding box of the face. Default attribute.
public FaceDetail withBoundingBox(BoundingBox boundingBox)
Bounding box of the face. Default attribute.
boundingBox
- Bounding box of the face. Default attribute.public void setAgeRange(AgeRange ageRange)
The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
ageRange
- The estimated age range, in years, for the face. Low represents the lowest estimated age and High
represents the highest estimated age.public AgeRange getAgeRange()
The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
public FaceDetail withAgeRange(AgeRange ageRange)
The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
ageRange
- The estimated age range, in years, for the face. Low represents the lowest estimated age and High
represents the highest estimated age.public void setSmile(Smile smile)
Indicates whether or not the face is smiling, and the confidence level in the determination.
smile
- Indicates whether or not the face is smiling, and the confidence level in the determination.public Smile getSmile()
Indicates whether or not the face is smiling, and the confidence level in the determination.
public FaceDetail withSmile(Smile smile)
Indicates whether or not the face is smiling, and the confidence level in the determination.
smile
- Indicates whether or not the face is smiling, and the confidence level in the determination.public void setEyeglasses(Eyeglasses eyeglasses)
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
eyeglasses
- Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.public Eyeglasses getEyeglasses()
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
public FaceDetail withEyeglasses(Eyeglasses eyeglasses)
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
eyeglasses
- Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.public void setSunglasses(Sunglasses sunglasses)
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
sunglasses
- Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.public Sunglasses getSunglasses()
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
public FaceDetail withSunglasses(Sunglasses sunglasses)
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
sunglasses
- Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.public void setGender(Gender gender)
The predicted gender of a detected face.
gender
- The predicted gender of a detected face.public Gender getGender()
The predicted gender of a detected face.
public FaceDetail withGender(Gender gender)
The predicted gender of a detected face.
gender
- The predicted gender of a detected face.public void setBeard(Beard beard)
Indicates whether or not the face has a beard, and the confidence level in the determination.
beard
- Indicates whether or not the face has a beard, and the confidence level in the determination.public Beard getBeard()
Indicates whether or not the face has a beard, and the confidence level in the determination.
public FaceDetail withBeard(Beard beard)
Indicates whether or not the face has a beard, and the confidence level in the determination.
beard
- Indicates whether or not the face has a beard, and the confidence level in the determination.public void setMustache(Mustache mustache)
Indicates whether or not the face has a mustache, and the confidence level in the determination.
mustache
- Indicates whether or not the face has a mustache, and the confidence level in the determination.public Mustache getMustache()
Indicates whether or not the face has a mustache, and the confidence level in the determination.
public FaceDetail withMustache(Mustache mustache)
Indicates whether or not the face has a mustache, and the confidence level in the determination.
mustache
- Indicates whether or not the face has a mustache, and the confidence level in the determination.public void setEyesOpen(EyeOpen eyesOpen)
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
eyesOpen
- Indicates whether or not the eyes on the face are open, and the confidence level in the determination.public EyeOpen getEyesOpen()
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
public FaceDetail withEyesOpen(EyeOpen eyesOpen)
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
eyesOpen
- Indicates whether or not the eyes on the face are open, and the confidence level in the determination.public void setMouthOpen(MouthOpen mouthOpen)
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
mouthOpen
- Indicates whether or not the mouth on the face is open, and the confidence level in the determination.public MouthOpen getMouthOpen()
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
public FaceDetail withMouthOpen(MouthOpen mouthOpen)
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
mouthOpen
- Indicates whether or not the mouth on the face is open, and the confidence level in the determination.public List<Emotion> getEmotions()
The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
public void setEmotions(Collection<Emotion> emotions)
The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
emotions
- The emotions that appear to be expressed on the face, and the confidence level in the determination. The
API is only making a determination of the physical appearance of a person's face. It is not a
determination of the person’s internal emotional state and should not be used in such a way. For example,
a person pretending to have a sad face might not be sad emotionally.public FaceDetail withEmotions(Emotion... emotions)
The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
NOTE: This method appends the values to the existing list (if any). Use
setEmotions(java.util.Collection)
or withEmotions(java.util.Collection)
if you want to override
the existing values.
emotions
- The emotions that appear to be expressed on the face, and the confidence level in the determination. The
API is only making a determination of the physical appearance of a person's face. It is not a
determination of the person’s internal emotional state and should not be used in such a way. For example,
a person pretending to have a sad face might not be sad emotionally.public FaceDetail withEmotions(Collection<Emotion> emotions)
The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
emotions
- The emotions that appear to be expressed on the face, and the confidence level in the determination. The
API is only making a determination of the physical appearance of a person's face. It is not a
determination of the person’s internal emotional state and should not be used in such a way. For example,
a person pretending to have a sad face might not be sad emotionally.public List<Landmark> getLandmarks()
Indicates the location of landmarks on the face. Default attribute.
public void setLandmarks(Collection<Landmark> landmarks)
Indicates the location of landmarks on the face. Default attribute.
landmarks
- Indicates the location of landmarks on the face. Default attribute.public FaceDetail withLandmarks(Landmark... landmarks)
Indicates the location of landmarks on the face. Default attribute.
NOTE: This method appends the values to the existing list (if any). Use
setLandmarks(java.util.Collection)
or withLandmarks(java.util.Collection)
if you want to
override the existing values.
landmarks
- Indicates the location of landmarks on the face. Default attribute.public FaceDetail withLandmarks(Collection<Landmark> landmarks)
Indicates the location of landmarks on the face. Default attribute.
landmarks
- Indicates the location of landmarks on the face. Default attribute.public void setPose(Pose pose)
Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
pose
- Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.public Pose getPose()
Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
public FaceDetail withPose(Pose pose)
Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
pose
- Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.public void setQuality(ImageQuality quality)
Identifies image brightness and sharpness. Default attribute.
quality
- Identifies image brightness and sharpness. Default attribute.public ImageQuality getQuality()
Identifies image brightness and sharpness. Default attribute.
public FaceDetail withQuality(ImageQuality quality)
Identifies image brightness and sharpness. Default attribute.
quality
- Identifies image brightness and sharpness. Default attribute.public void setConfidence(Float confidence)
Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
confidence
- Confidence level that the bounding box contains a face (and not a different object such as a tree).
Default attribute.public Float getConfidence()
Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
public FaceDetail withConfidence(Float confidence)
Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
confidence
- Confidence level that the bounding box contains a face (and not a different object such as a tree).
Default attribute.public void setFaceOccluded(FaceOccluded faceOccluded)
FaceOccluded
should return "true" with a high confidence score if a detected face’s eyes, nose, and
mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other
objects. FaceOccluded
should return "false" with a high confidence score if common occurrences that
do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair,
and others.
faceOccluded
- FaceOccluded
should return "true" with a high confidence score if a detected face’s eyes,
nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones,
hands, or other objects. FaceOccluded
should return "false" with a high confidence score if
common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted
sunglasses, strands of hair, and others.public FaceOccluded getFaceOccluded()
FaceOccluded
should return "true" with a high confidence score if a detected face’s eyes, nose, and
mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other
objects. FaceOccluded
should return "false" with a high confidence score if common occurrences that
do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair,
and others.
FaceOccluded
should return "true" with a high confidence score if a detected face’s eyes,
nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones,
hands, or other objects. FaceOccluded
should return "false" with a high confidence score if
common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted
sunglasses, strands of hair, and others.public FaceDetail withFaceOccluded(FaceOccluded faceOccluded)
FaceOccluded
should return "true" with a high confidence score if a detected face’s eyes, nose, and
mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other
objects. FaceOccluded
should return "false" with a high confidence score if common occurrences that
do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair,
and others.
faceOccluded
- FaceOccluded
should return "true" with a high confidence score if a detected face’s eyes,
nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones,
hands, or other objects. FaceOccluded
should return "false" with a high confidence score if
common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted
sunglasses, strands of hair, and others.public void setEyeDirection(EyeDirection eyeDirection)
Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
eyeDirection
- Indicates the direction the eyes are gazing in, as defined by pitch and yaw.public EyeDirection getEyeDirection()
Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
public FaceDetail withEyeDirection(EyeDirection eyeDirection)
Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
eyeDirection
- Indicates the direction the eyes are gazing in, as defined by pitch and yaw.public String toString()
toString
in class Object
Object.toString()
public FaceDetail clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.