@Generated(value="software.amazon.awssdk:codegen") public class CompareFacesResponse extends RekognitionResponse implements ToCopyableBuilder<CompareFacesResponse.Builder,CompareFacesResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
CompareFacesResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static CompareFacesResponse.Builder |
builder() |
boolean |
equals(Object obj) |
List<CompareFacesMatch> |
faceMatches()
An array of faces in the target image that match the source image face.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
static Class<? extends CompareFacesResponse.Builder> |
serializableBuilderClass() |
ComparedSourceImageFace |
sourceImageFace()
The face in the source image that was used for comparison.
|
OrientationCorrection |
sourceImageOrientationCorrection()
The orientation of the source image (counterclockwise direction).
|
String |
sourceImageOrientationCorrectionString()
The orientation of the source image (counterclockwise direction).
|
OrientationCorrection |
targetImageOrientationCorrection()
The orientation of the target image (in counterclockwise direction).
|
String |
targetImageOrientationCorrectionString()
The orientation of the target image (in counterclockwise direction).
|
CompareFacesResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<ComparedFace> |
unmatchedFaces()
An array of faces in the target image that did not match the source image face.
|
copy
public ComparedSourceImageFace sourceImageFace()
The face in the source image that was used for comparison.
public List<CompareFacesMatch> faceMatches()
An array of faces in the target image that match the source image face. Each CompareFacesMatch
object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity
score for the face in the bounding box and the face in the source image.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
CompareFacesMatch
object provides the bounding box, the confidence level that the bounding
box contains a face, and the similarity score for the face in the bounding box and the face in the source
image.public List<ComparedFace> unmatchedFaces()
An array of faces in the target image that did not match the source image face.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public OrientationCorrection sourceImageOrientationCorrection()
The orientation of the source image (counterclockwise direction). If your application displays the source image,
you can use this value to correct image orientation. The bounding box coordinates returned in
SourceImageFace
represent the location of the face before the image orientation is corrected.
If the source image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the
image's orientation. If the Exif metadata for the source image populates the orientation field, the value of
OrientationCorrection
is null and the SourceImageFace
bounding box coordinates
represent the location of the face after Exif metadata is used to correct the orientation. Images in .png format
don't contain Exif metadata.
If the service returns an enum value that is not available in the current SDK version,
sourceImageOrientationCorrection
will return OrientationCorrection.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from sourceImageOrientationCorrectionString()
.
SourceImageFace
represent the location of the face before the image orientation is
corrected.
If the source image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes
the image's orientation. If the Exif metadata for the source image populates the orientation field, the
value of OrientationCorrection
is null and the SourceImageFace
bounding box
coordinates represent the location of the face after Exif metadata is used to correct the orientation.
Images in .png format don't contain Exif metadata.
OrientationCorrection
public String sourceImageOrientationCorrectionString()
The orientation of the source image (counterclockwise direction). If your application displays the source image,
you can use this value to correct image orientation. The bounding box coordinates returned in
SourceImageFace
represent the location of the face before the image orientation is corrected.
If the source image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the
image's orientation. If the Exif metadata for the source image populates the orientation field, the value of
OrientationCorrection
is null and the SourceImageFace
bounding box coordinates
represent the location of the face after Exif metadata is used to correct the orientation. Images in .png format
don't contain Exif metadata.
If the service returns an enum value that is not available in the current SDK version,
sourceImageOrientationCorrection
will return OrientationCorrection.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from sourceImageOrientationCorrectionString()
.
SourceImageFace
represent the location of the face before the image orientation is
corrected.
If the source image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes
the image's orientation. If the Exif metadata for the source image populates the orientation field, the
value of OrientationCorrection
is null and the SourceImageFace
bounding box
coordinates represent the location of the face after Exif metadata is used to correct the orientation.
Images in .png format don't contain Exif metadata.
OrientationCorrection
public OrientationCorrection targetImageOrientationCorrection()
The orientation of the target image (in counterclockwise direction). If your application displays the target
image, you can use this value to correct the orientation of the image. The bounding box coordinates returned in
FaceMatches
and UnmatchedFaces
represent face locations before the image orientation is
corrected.
If the target image is in .jpg format, it might contain Exif metadata that includes the orientation of the image.
If the Exif metadata for the target image populates the orientation field, the value of
OrientationCorrection
is null and the bounding box coordinates in FaceMatches
and
UnmatchedFaces
represent the location of the face after Exif metadata is used to correct the
orientation. Images in .png format don't contain Exif metadata.
If the service returns an enum value that is not available in the current SDK version,
targetImageOrientationCorrection
will return OrientationCorrection.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from targetImageOrientationCorrectionString()
.
FaceMatches
and UnmatchedFaces
represent face locations
before the image orientation is corrected.
If the target image is in .jpg format, it might contain Exif metadata that includes the orientation of
the image. If the Exif metadata for the target image populates the orientation field, the value of
OrientationCorrection
is null and the bounding box coordinates in FaceMatches
and UnmatchedFaces
represent the location of the face after Exif metadata is used to correct
the orientation. Images in .png format don't contain Exif metadata.
OrientationCorrection
public String targetImageOrientationCorrectionString()
The orientation of the target image (in counterclockwise direction). If your application displays the target
image, you can use this value to correct the orientation of the image. The bounding box coordinates returned in
FaceMatches
and UnmatchedFaces
represent face locations before the image orientation is
corrected.
If the target image is in .jpg format, it might contain Exif metadata that includes the orientation of the image.
If the Exif metadata for the target image populates the orientation field, the value of
OrientationCorrection
is null and the bounding box coordinates in FaceMatches
and
UnmatchedFaces
represent the location of the face after Exif metadata is used to correct the
orientation. Images in .png format don't contain Exif metadata.
If the service returns an enum value that is not available in the current SDK version,
targetImageOrientationCorrection
will return OrientationCorrection.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from targetImageOrientationCorrectionString()
.
FaceMatches
and UnmatchedFaces
represent face locations
before the image orientation is corrected.
If the target image is in .jpg format, it might contain Exif metadata that includes the orientation of
the image. If the Exif metadata for the target image populates the orientation field, the value of
OrientationCorrection
is null and the bounding box coordinates in FaceMatches
and UnmatchedFaces
represent the location of the face after Exif metadata is used to correct
the orientation. Images in .png format don't contain Exif metadata.
OrientationCorrection
public CompareFacesResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CompareFacesResponse.Builder,CompareFacesResponse>
toBuilder
in class AwsResponse
public static CompareFacesResponse.Builder builder()
public static Class<? extends CompareFacesResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.