com.amazonaws.services.rekognition.model

Class CompareFacesResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.rekognition.model.CompareFacesResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CompareFacesResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompareFacesResult()

Method Summary

Modifier and Type	Method and Description
CompareFacesResult	clone()
boolean	equals(Object obj)
List<CompareFacesMatch>	getFaceMatches() An array of faces in the target image that match the source image face.
ComparedSourceImageFace	getSourceImageFace() The face in the source image that was used for comparison.
String	getSourceImageOrientationCorrection() The orientation of the source image (counterclockwise direction).
String	getTargetImageOrientationCorrection() The orientation of the target image (in counterclockwise direction).
List<ComparedFace>	getUnmatchedFaces() An array of faces in the target image that did not match the source image face.
int	hashCode()
void	setFaceMatches(Collection<CompareFacesMatch> faceMatches) An array of faces in the target image that match the source image face.
void	setSourceImageFace(ComparedSourceImageFace sourceImageFace) The face in the source image that was used for comparison.
void	setSourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection) The orientation of the source image (counterclockwise direction).
void	setSourceImageOrientationCorrection(String sourceImageOrientationCorrection) The orientation of the source image (counterclockwise direction).
void	setTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection) The orientation of the target image (in counterclockwise direction).
void	setTargetImageOrientationCorrection(String targetImageOrientationCorrection) The orientation of the target image (in counterclockwise direction).
void	setUnmatchedFaces(Collection<ComparedFace> unmatchedFaces) An array of faces in the target image that did not match the source image face.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CompareFacesResult	withFaceMatches(Collection<CompareFacesMatch> faceMatches) An array of faces in the target image that match the source image face.
CompareFacesResult	withFaceMatches(CompareFacesMatch... faceMatches) An array of faces in the target image that match the source image face.
CompareFacesResult	withSourceImageFace(ComparedSourceImageFace sourceImageFace) The face in the source image that was used for comparison.
CompareFacesResult	withSourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection) The orientation of the source image (counterclockwise direction).
CompareFacesResult	withSourceImageOrientationCorrection(String sourceImageOrientationCorrection) The orientation of the source image (counterclockwise direction).
CompareFacesResult	withTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection) The orientation of the target image (in counterclockwise direction).
CompareFacesResult	withTargetImageOrientationCorrection(String targetImageOrientationCorrection) The orientation of the target image (in counterclockwise direction).
CompareFacesResult	withUnmatchedFaces(Collection<ComparedFace> unmatchedFaces) An array of faces in the target image that did not match the source image face.
CompareFacesResult	withUnmatchedFaces(ComparedFace... unmatchedFaces) An array of faces in the target image that did not match the source image face.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CompareFacesResult

public CompareFacesResult()

Method Detail

setSourceImageFace

public void setSourceImageFace(ComparedSourceImageFace sourceImageFace)

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

Parameters:

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

getSourceImageFace

public ComparedSourceImageFace getSourceImageFace()

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

Returns:

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

withSourceImageFace

public CompareFacesResult withSourceImageFace(ComparedSourceImageFace sourceImageFace)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getFaceMatches

public List<CompareFacesMatch> getFaceMatches()

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.

setFaceMatches

public void setFaceMatches(Collection<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.

Parameters:

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.

withFaceMatches

public CompareFacesResult withFaceMatches(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.

NOTE: This method appends the values to the existing list (if any). Use setFaceMatches(java.util.Collection) or withFaceMatches(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

withFaceMatches

public CompareFacesResult withFaceMatches(Collection<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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getUnmatchedFaces

public List<ComparedFace> getUnmatchedFaces()

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.

setUnmatchedFaces

public void setUnmatchedFaces(Collection<ComparedFace> unmatchedFaces)

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

Parameters:

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

withUnmatchedFaces

public CompareFacesResult withUnmatchedFaces(ComparedFace... unmatchedFaces)

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

NOTE: This method appends the values to the existing list (if any). Use setUnmatchedFaces(java.util.Collection) or withUnmatchedFaces(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withUnmatchedFaces

public CompareFacesResult withUnmatchedFaces(Collection<ComparedFace> unmatchedFaces)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceImageOrientationCorrection

public void setSourceImageOrientationCorrection(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.

Parameters:

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.

See Also:

OrientationCorrection

getSourceImageOrientationCorrection

public String getSourceImageOrientationCorrection()

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

withSourceImageOrientationCorrection

public CompareFacesResult withSourceImageOrientationCorrection(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

OrientationCorrection

setSourceImageOrientationCorrection

public void setSourceImageOrientationCorrection(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.

Parameters:

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.

See Also:

OrientationCorrection

withSourceImageOrientationCorrection

public CompareFacesResult withSourceImageOrientationCorrection(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

OrientationCorrection

setTargetImageOrientationCorrection

public void setTargetImageOrientationCorrection(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.

Parameters:

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.

See Also:

OrientationCorrection

getTargetImageOrientationCorrection

public String getTargetImageOrientationCorrection()

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

withTargetImageOrientationCorrection

public CompareFacesResult withTargetImageOrientationCorrection(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

OrientationCorrection

setTargetImageOrientationCorrection

public void setTargetImageOrientationCorrection(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.

Parameters:

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.

See Also:

OrientationCorrection

withTargetImageOrientationCorrection

public CompareFacesResult withTargetImageOrientationCorrection(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

OrientationCorrection

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CompareFacesResult clone()

Overrides:

clone in class Object