/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.rekognition.model;
import java.io.Serializable;
import javax.annotation.Generated;
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CompareFacesResult extends com.amazonaws.AmazonWebServiceResult
* The face in the source image that was used for comparison.
*
* An array of faces in the target image that match the source image face. Each
* An array of faces in the target image that did not match the source image face.
*
* The value of
* 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.
*
* The value of
* 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.
*
* The face in the source image that was used for comparison.
*
* The face in the source image that was used for comparison.
*
* The face in the source image that was used for comparison.
*
* An array of faces in the target image that match the source image face. Each
* An array of faces in the target image that match the source image face. Each
* An array of faces in the target image that match the source image face. Each
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFaceMatches(java.util.Collection)} or {@link #withFaceMatches(java.util.Collection)} if you want to
* override the existing values.
*
* An array of faces in the target image that match the source image face. Each
* An array of faces in the target image that did not match the source image face.
*
* An array of faces in the target image that did not match the source image face.
*
* 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
* {@link #setUnmatchedFaces(java.util.Collection)} or {@link #withUnmatchedFaces(java.util.Collection)} if you want
* to override the existing values.
*
* An array of faces in the target image that did not match the source image face.
*
* The value of
* 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.
* 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.
* SourceImageOrientationCorrection
is always null.
* TargetImageOrientationCorrection
is always null.
* 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.
* 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 java.util.ListCompareFacesMatch
* 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.
* 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 void setFaceMatches(java.util.CollectionCompareFacesMatch
* 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.
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CompareFacesResult withFaceMatches(CompareFacesMatch... faceMatches) {
if (this.faceMatches == null) {
setFaceMatches(new java.util.ArrayListCompareFacesMatch
* 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.
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CompareFacesResult withFaceMatches(java.util.CollectionSourceImageOrientationCorrection
is always null.
* 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 OrientationCorrection */ public void setSourceImageOrientationCorrection(String sourceImageOrientationCorrection) { this.sourceImageOrientationCorrection = 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. *
* * @return The value ofSourceImageOrientationCorrection
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 OrientationCorrection */ public String getSourceImageOrientationCorrection() { return this.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. *
* * @param sourceImageOrientationCorrection * The value ofSourceImageOrientationCorrection
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. * @return Returns a reference to this object so that method calls can be chained together. * @see OrientationCorrection */ public CompareFacesResult withSourceImageOrientationCorrection(String sourceImageOrientationCorrection) { setSourceImageOrientationCorrection(sourceImageOrientationCorrection); return this; } /** *
* 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. *
* * @param sourceImageOrientationCorrection * The value ofSourceImageOrientationCorrection
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 OrientationCorrection */ public void setSourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection) { withSourceImageOrientationCorrection(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. *
* * @param sourceImageOrientationCorrection * The value ofSourceImageOrientationCorrection
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. * @return Returns a reference to this object so that method calls can be chained together. * @see OrientationCorrection */ public CompareFacesResult withSourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection) { this.sourceImageOrientationCorrection = sourceImageOrientationCorrection.toString(); return this; } /** *
* 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. *
* * @param targetImageOrientationCorrection * The value ofTargetImageOrientationCorrection
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 OrientationCorrection */ public void setTargetImageOrientationCorrection(String targetImageOrientationCorrection) { this.targetImageOrientationCorrection = 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. *
* * @return The value ofTargetImageOrientationCorrection
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 OrientationCorrection */ public String getTargetImageOrientationCorrection() { return this.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. *
* * @param targetImageOrientationCorrection * The value ofTargetImageOrientationCorrection
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. * @return Returns a reference to this object so that method calls can be chained together. * @see OrientationCorrection */ public CompareFacesResult withTargetImageOrientationCorrection(String targetImageOrientationCorrection) { setTargetImageOrientationCorrection(targetImageOrientationCorrection); return this; } /** *
* 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. *
* * @param targetImageOrientationCorrection * The value ofTargetImageOrientationCorrection
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 OrientationCorrection */ public void setTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection) { withTargetImageOrientationCorrection(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. *
* * @param targetImageOrientationCorrection * The value ofTargetImageOrientationCorrection
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. * @return Returns a reference to this object so that method calls can be chained together. * @see OrientationCorrection */ public CompareFacesResult withTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection) { this.targetImageOrientationCorrection = targetImageOrientationCorrection.toString(); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getSourceImageFace() != null) sb.append("SourceImageFace: ").append(getSourceImageFace()).append(","); if (getFaceMatches() != null) sb.append("FaceMatches: ").append(getFaceMatches()).append(","); if (getUnmatchedFaces() != null) sb.append("UnmatchedFaces: ").append(getUnmatchedFaces()).append(","); if (getSourceImageOrientationCorrection() != null) sb.append("SourceImageOrientationCorrection: ").append(getSourceImageOrientationCorrection()).append(","); if (getTargetImageOrientationCorrection() != null) sb.append("TargetImageOrientationCorrection: ").append(getTargetImageOrientationCorrection()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CompareFacesResult == false) return false; CompareFacesResult other = (CompareFacesResult) obj; if (other.getSourceImageFace() == null ^ this.getSourceImageFace() == null) return false; if (other.getSourceImageFace() != null && other.getSourceImageFace().equals(this.getSourceImageFace()) == false) return false; if (other.getFaceMatches() == null ^ this.getFaceMatches() == null) return false; if (other.getFaceMatches() != null && other.getFaceMatches().equals(this.getFaceMatches()) == false) return false; if (other.getUnmatchedFaces() == null ^ this.getUnmatchedFaces() == null) return false; if (other.getUnmatchedFaces() != null && other.getUnmatchedFaces().equals(this.getUnmatchedFaces()) == false) return false; if (other.getSourceImageOrientationCorrection() == null ^ this.getSourceImageOrientationCorrection() == null) return false; if (other.getSourceImageOrientationCorrection() != null && other.getSourceImageOrientationCorrection().equals(this.getSourceImageOrientationCorrection()) == false) return false; if (other.getTargetImageOrientationCorrection() == null ^ this.getTargetImageOrientationCorrection() == null) return false; if (other.getTargetImageOrientationCorrection() != null && other.getTargetImageOrientationCorrection().equals(this.getTargetImageOrientationCorrection()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getSourceImageFace() == null) ? 0 : getSourceImageFace().hashCode()); hashCode = prime * hashCode + ((getFaceMatches() == null) ? 0 : getFaceMatches().hashCode()); hashCode = prime * hashCode + ((getUnmatchedFaces() == null) ? 0 : getUnmatchedFaces().hashCode()); hashCode = prime * hashCode + ((getSourceImageOrientationCorrection() == null) ? 0 : getSourceImageOrientationCorrection().hashCode()); hashCode = prime * hashCode + ((getTargetImageOrientationCorrection() == null) ? 0 : getTargetImageOrientationCorrection().hashCode()); return hashCode; } @Override public CompareFacesResult clone() { try { return (CompareFacesResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }