AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the CompareFaces operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.Rekognition.Model.CompareFacesResponse

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

C#
public class CompareFacesResponse : AmazonWebServiceResponse

The CompareFacesResponse type exposes the following members

Constructors

NameDescription
Public Method CompareFacesResponse()

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property FaceMatches System.Collections.Generic.List<Amazon.Rekognition.Model.CompareFacesMatch>

Gets and sets the property 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.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property SourceImageFace Amazon.Rekognition.Model.ComparedSourceImageFace

Gets and sets the property SourceImageFace.

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

Public Property SourceImageOrientationCorrection Amazon.Rekognition.OrientationCorrection

Gets and sets the property 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.

Public Property TargetImageOrientationCorrection Amazon.Rekognition.OrientationCorrection

Gets and sets the property 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.

Public Property UnmatchedFaces System.Collections.Generic.List<Amazon.Rekognition.Model.ComparedFace>

Gets and sets the property UnmatchedFaces.

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

Examples

This operation compares the largest face detected in the source image with each face detected in the target image.

To compare two images


var response = client.CompareFaces(new CompareFacesRequest 
{
    SimilarityThreshold = 90,
    SourceImage = new Image { S3Object = new S3Object {
        Bucket = "mybucket",
        Name = "mysourceimage"
    } },
    TargetImage = new Image { S3Object = new S3Object {
        Bucket = "mybucket",
        Name = "mytargetimage"
    } }
});

List faceMatches = response.FaceMatches;
ComparedSourceImageFace sourceImageFace = response.SourceImageFace;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms