Package com.regula.facesdk.detection.request

Class ImageQualityGroup.ImageCharacteristic

java.lang.Object

com.regula.facesdk.detection.request.ImageQualityGroup.ImageCharacteristic

Enclosing class:

ImageQualityGroup

public static class ImageQualityGroup.ImageCharacteristic
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ImageCharacteristic()

Method Summary

Modifier and Type	Method	Description
static java.util.List<ImageQualityCharacteristic>	allRecommended()	All Group characteristics with default (recommended) values.
static ImageQualityCharacteristic	artFace()	Whether the face in the image is a photo, not a drawing, sculpture, cartoon, etc.
static ImageQualityCharacteristic	imageChannelsNumberWithValue(double value)	The image RGB channels number.
static ImageQualityCharacteristic	imageHeightWithRange(double min, double max)	The image height, pixels.
static ImageQualityCharacteristic	imageWidthToHeightWithRange(double min, double max)	The image width to height proportion.
static ImageQualityCharacteristic	imageWidthWithRange(double min, double max)	The image width, pixels.
static ImageQualityCharacteristic	paddingRatio(double min, double max)	The percentage of the area of the image that was "padded" during alignment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageCharacteristic

public ImageCharacteristic()

Method Detail

imageWidthWithRange

public static ImageQualityCharacteristic imageWidthWithRange(double min,
                                                             double max)

The image width, pixels. Doesn't have recommended value.

Returns:

ImageQualityCharacteristic

imageHeightWithRange

public static ImageQualityCharacteristic imageHeightWithRange(double min,
                                                              double max)

The image height, pixels. Doesn't have recommended value.

Returns:

ImageQualityCharacteristic

imageWidthToHeightWithRange

public static ImageQualityCharacteristic imageWidthToHeightWithRange(double min,
                                                                     double max)

The image width to height proportion. Doesn't have recommended value.

Returns:

ImageQualityCharacteristic

imageChannelsNumberWithValue

public static ImageQualityCharacteristic imageChannelsNumberWithValue(double value)

The image RGB channels number. Doesn't have recommended value. Range value [3, 3] is for RGB images.

Returns:

ImageQualityCharacteristic

paddingRatio

public static ImageQualityCharacteristic paddingRatio(double min,
                                                      double max)

The percentage of the area of the image that was "padded" during alignment. The characteristic is needed to determine if the head goes beyond the image. The range is from 0 to 1 where 0 is 0% of the image is "padded".

Returns:

ImageQualityCharacteristic

artFace

public static ImageQualityCharacteristic artFace()

Whether the face in the image is a photo, not a drawing, sculpture, cartoon, etc. If the returned value is out of the recommended range, the image is not a photo. The range is from 0 to 1.

Returns:

ImageQualityCharacteristic

allRecommended

public static java.util.List<ImageQualityCharacteristic> allRecommended()

All Group characteristics with default (recommended) values. Doesn't include characteristics without default values.

Returns:

List