Package software.amazon.awssdk.services.rekognition.model

Class CompareFacesResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.rekognition.model.CompareFacesResponse

All Implemented Interfaces:

ToCopyableBuilder<CompareFacesResponse.Builder,CompareFacesResponse>

@Generated("software.amazon.awssdk:codegen")
public class CompareFacesResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<CompareFacesResponse.Builder,CompareFacesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CompareFacesResponse.Builder

Method Summary

Modifier and Type	Method	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.
int	hashCode()
static Class<? extends CompareFacesResponse.Builder>	serializableBuilderClass()
ComparedSourceImageFace	sourceImageFace()	The face in the source image that was used for comparison.
String	sourceImageOrientationCorrection()	The orientation of the source image (counterclockwise direction).
String	targetImageOrientationCorrection()	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.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

sourceImageFace

public ComparedSourceImageFace sourceImageFace()

The face in the source image that was used for comparison.

Returns:

The face in the source image that was used for comparison.

faceMatches

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.

Returns:

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.

unmatchedFaces

public List<ComparedFace> unmatchedFaces()

An array of faces in the target image that did not match the source image face.

Returns:

An array of faces in the target image that did not match the source image face.

sourceImageOrientationCorrection

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

Returns:

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.

See Also:

OrientationCorrection

targetImageOrientationCorrection

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

Returns:

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.

See Also:

OrientationCorrection

toBuilder

public CompareFacesResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CompareFacesResponse.Builder,CompareFacesResponse>

Returns:

a builder for type T

builder

public static CompareFacesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CompareFacesResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object