com.amazonaws.services.rekognition.model

Class CompareFacesResult

java.lang.Object

com.amazonaws.services.rekognition.model.CompareFacesResult

All Implemented Interfaces:

java.io.Serializable

public class CompareFacesResult
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompareFacesResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.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.
java.lang.String	getSourceImageOrientationCorrection() The value of SourceImageOrientationCorrection is always null.
java.lang.String	getTargetImageOrientationCorrection() The value of TargetImageOrientationCorrection is always null.
java.util.List<ComparedFace>	getUnmatchedFaces() An array of faces in the target image that did not match the source image face.
int	hashCode()
void	setFaceMatches(java.util.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 value of SourceImageOrientationCorrection is always null.
void	setSourceImageOrientationCorrection(java.lang.String sourceImageOrientationCorrection) The value of SourceImageOrientationCorrection is always null.
void	setTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection) The value of TargetImageOrientationCorrection is always null.
void	setTargetImageOrientationCorrection(java.lang.String targetImageOrientationCorrection) The value of TargetImageOrientationCorrection is always null.
void	setUnmatchedFaces(java.util.Collection<ComparedFace> unmatchedFaces) An array of faces in the target image that did not match the source image face.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CompareFacesResult	withFaceMatches(java.util.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 value of SourceImageOrientationCorrection is always null.
CompareFacesResult	withSourceImageOrientationCorrection(java.lang.String sourceImageOrientationCorrection) The value of SourceImageOrientationCorrection is always null.
CompareFacesResult	withTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection) The value of TargetImageOrientationCorrection is always null.
CompareFacesResult	withTargetImageOrientationCorrection(java.lang.String targetImageOrientationCorrection) The value of TargetImageOrientationCorrection is always null.
CompareFacesResult	withUnmatchedFaces(java.util.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CompareFacesResult

public CompareFacesResult()

Method Detail

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.

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.

withSourceImageFace

public CompareFacesResult withSourceImageFace(ComparedSourceImageFace sourceImageFace)

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

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

Parameters:

sourceImageFace -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getFaceMatches

public java.util.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(java.util.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.

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

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:

A reference to this updated object so that method calls can be chained together.

withFaceMatches

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

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

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:

A reference to this updated object so that method calls can be chained together.

getUnmatchedFaces

public java.util.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(java.util.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.

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

Parameters:

unmatchedFaces -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withUnmatchedFaces

public CompareFacesResult withUnmatchedFaces(java.util.Collection<ComparedFace> unmatchedFaces)

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

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

Parameters:

unmatchedFaces -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceImageOrientationCorrection

public java.lang.String getSourceImageOrientationCorrection()

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Returns:

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

setSourceImageOrientationCorrection

public void setSourceImageOrientationCorrection(java.lang.String sourceImageOrientationCorrection)

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

sourceImageOrientationCorrection -

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

withSourceImageOrientationCorrection

public CompareFacesResult withSourceImageOrientationCorrection(java.lang.String sourceImageOrientationCorrection)

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

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

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

sourceImageOrientationCorrection -

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OrientationCorrection

setSourceImageOrientationCorrection

public void setSourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection)

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

sourceImageOrientationCorrection -

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

withSourceImageOrientationCorrection

public CompareFacesResult withSourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection)

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

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

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

sourceImageOrientationCorrection -

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OrientationCorrection

getTargetImageOrientationCorrection

public java.lang.String getTargetImageOrientationCorrection()

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Returns:

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

setTargetImageOrientationCorrection

public void setTargetImageOrientationCorrection(java.lang.String targetImageOrientationCorrection)

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

targetImageOrientationCorrection -

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

withTargetImageOrientationCorrection

public CompareFacesResult withTargetImageOrientationCorrection(java.lang.String targetImageOrientationCorrection)

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

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

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

targetImageOrientationCorrection -

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OrientationCorrection

setTargetImageOrientationCorrection

public void setTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection)

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

targetImageOrientationCorrection -

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

withTargetImageOrientationCorrection

public CompareFacesResult withTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection)

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

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

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Parameters:

targetImageOrientationCorrection -

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OrientationCorrection

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object