You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Instance Attribute Summary collapse

Instance Attribute Details

#face_matchesArray<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:



252
253
254
255
256
257
258
259
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 252

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

#source_image_faceTypes::ComparedSourceImageFace

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



252
253
254
255
256
257
258
259
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 252

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

#source_image_orientation_correctionString

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:

  • (String)


252
253
254
255
256
257
258
259
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 252

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

#target_image_orientation_correctionString

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:

  • (String)


252
253
254
255
256
257
258
259
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 252

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

#unmatched_facesArray<Types::ComparedFace>

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

Returns:



252
253
254
255
256
257
258
259
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 252

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