MatchFacesComparedFacesPair

java.lang.Object
- com.regula.facesdk.model.results.matchfaces.MatchFacesComparedFacesPair

public final class MatchFacesComparedFacesPair
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MatchFacesComparedFacesPair.Builder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MatchFacesException`	`getException()`	Return exception of the comparing faces
`MatchFacesComparedFace`	`getFirst()`	The first face in the comparison pair.
`double`	`getScore()`	The raw value returned by the service without applying any thresholds or comparison rules.
`MatchFacesComparedFace`	`getSecond()`	The second face in the comparison pair.
`double`	`getSimilarity()`	Return the similarity value of the compared faces

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getFirst
```
public MatchFacesComparedFace getFirst()
```
    The first face in the comparison pair.
    
    Returns:
    
    MatchFacesComparedFace
  - getSecond
```
public MatchFacesComparedFace getSecond()
```
    The second face in the comparison pair.
    
    Returns:
    
    MatchFacesComparedFace
  - getSimilarity
```
public double getSimilarity()
```
    Return the similarity value of the compared faces
    
    Returns:
    
    similarity in the double format
  - getScore
```
public double getScore()
```
    The raw value returned by the service without applying any thresholds or comparison rules. The value shows the degree of similarity of compared faces, the lower - the more similar, and vice versa less similar. The `score` is used in conjunction with the input image `imageType` to evaluate `similarity`.
    
    Returns:
    
    score in the double format
    
    See Also:
    
    for checking how compared faces are similar to each other.
  - getException
```
public MatchFacesException getException()
```
    Return exception of the comparing faces
    
    Returns:
    
    MatchFacesException