Class: Aws::Rekognition::Types::CompareFacesResponse

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::CompareFacesResponse

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #face_matches ⇒ Array<Types::CompareFacesMatch>

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

• #source_image_face ⇒ Types::ComparedSourceImageFace

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

• #source_image_orientation_correction ⇒ String

  The value of ‘SourceImageOrientationCorrection` is always null.

• #target_image_orientation_correction ⇒ String

  The value of ‘TargetImageOrientationCorrection` is always null.

• #unmatched_faces ⇒ Array<Types::ComparedFace>

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

Instance Attribute Details

#face_matches ⇒ Array<Types::CompareFacesMatch>

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:

• (Array<Types::CompareFacesMatch>)

# File 'lib/aws-sdk-rekognition/types.rb', line 560

class CompareFacesResponse < Struct.new(
  :source_image_face,
  :face_matches,
  :unmatched_faces,
  :source_image_orientation_correction,
  :target_image_orientation_correction)
  SENSITIVE = []
  include Aws::Structure
end

#source_image_face ⇒ Types::ComparedSourceImageFace

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

Returns:

• (Types::ComparedSourceImageFace)

# File 'lib/aws-sdk-rekognition/types.rb', line 560

class CompareFacesResponse < Struct.new(
  :source_image_face,
  :face_matches,
  :unmatched_faces,
  :source_image_orientation_correction,
  :target_image_orientation_correction)
  SENSITIVE = []
  include Aws::Structure
end

#source_image_orientation_correction ⇒ String

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:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 560

class CompareFacesResponse < Struct.new(
  :source_image_face,
  :face_matches,
  :unmatched_faces,
  :source_image_orientation_correction,
  :target_image_orientation_correction)
  SENSITIVE = []
  include Aws::Structure
end

#target_image_orientation_correction ⇒ String

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:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 560

class CompareFacesResponse < Struct.new(
  :source_image_face,
  :face_matches,
  :unmatched_faces,
  :source_image_orientation_correction,
  :target_image_orientation_correction)
  SENSITIVE = []
  include Aws::Structure
end

#unmatched_faces ⇒ Array<Types::ComparedFace>

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

Returns:

• (Array<Types::ComparedFace>)

# File 'lib/aws-sdk-rekognition/types.rb', line 560

class CompareFacesResponse < Struct.new(
  :source_image_face,
  :face_matches,
  :unmatched_faces,
  :source_image_orientation_correction,
  :target_image_orientation_correction)
  SENSITIVE = []
  include Aws::Structure
end