base_types.h File Reference

#include <idliveface/utility.h>

Classes
struct	idliveface::Point
	Two-dimensional point. More...
struct	idliveface::BoundingBox
	The bounding box around the face. More...
struct	idliveface::HeadPose
	The roll, pitch and yaw angles of the head, in degrees. More...
struct	idliveface::FaceAttributes
	Attributes of the detected face. More...
struct	idliveface::ImageAttributes
	General attributes of the image. More...
struct	idliveface::ImageQualityAttributes
	Quality attributes of the image. More...
struct	idliveface::RuntimeConfiguration
	The resource management and performance configuration. More...
struct	idliveface::CustomValidationParameters
	Overrides for the validation parameters. More...

Typedefs
typedef std::vector< Point >	idliveface::Landmarks
	The facial landmark points.

Enumerations
enum class	idliveface::Domain {   kGeneral ,   kDesktop }
	Defines a subset of characteristics that the face analysis should be sensitive to. More...
enum class	idliveface::Tolerance {   kRegular ,   kSoft ,   kHardened }
	Defines how strict the face analysis should be, which in return affects APCER / BPCER balance. More...
enum class	idliveface::Validation : uint8_t {   kFaceNotFound ,   kTooManyFaces ,   kSmallFaceSize ,   kSmallRelativeFaceSize ,   kSmallPupillaryDistance ,   kLargeFaceRotationAngle ,   kFaceTooClose ,   kFaceCloseToBorder ,   kFaceCropped ,   kFaceOccluded ,   kEyesClosed ,   kDarkImage }
	All possible criteria the image is being validated on. More...
enum class	idliveface::PixelFormat {   kRGB ,   kBGR ,   kGrayscale }
	The format of the image pixel. More...

Enumeration Type Documentation

Domain

enum class idliveface::Domain

strong

Defines a subset of characteristics that the face analysis should be sensitive to.

Correctly specified domain leads to more precise analysis results.

Enumerator
kGeneral	General case. Used by default.
kDesktop	Targets images taken via the desktop web-camera.

PixelFormat

enum class idliveface::PixelFormat

strong

The format of the image pixel.

Enumerator
kRGB	Red-Green-Blue, three bytes per pixel.
kBGR	Blue-Green-Red, three bytes per pixel (used by OpenCV).
kGrayscale	Grayscale, one byte per pixel.

Tolerance

enum class idliveface::Tolerance

strong

Defines how strict the face analysis should be, which in return affects APCER / BPCER balance.

Enumerator
kRegular	Targets low APCER. Used by default.
kSoft	Achieves lower BPCER while still having acceptable APCER.
kHardened	Targets extra low APCER with higher BPCER.

Validation

enum class idliveface::Validation : uint8_t

strong

All possible criteria the image is being validated on.

Enumerator
kFaceNotFound	No faces are found on the image.
kTooManyFaces	There is more than one face on the image.
kSmallFaceSize	The face box is too small.
kSmallRelativeFaceSize	The face relative size is too small.
kSmallPupillaryDistance	The distance between pupils on the face is too small.
kLargeFaceRotationAngle	The rotation angle of the head (inc. roll, pitch an yaw) is too big.
kFaceTooClose	The face is too close to the camera.
kFaceCloseToBorder	The face is too close to one or more image borders.
kFaceCropped	The face is cropped.
kFaceOccluded	The face is occluded, for example with a medical mask.
kEyesClosed	The eyes are closed.
kDarkImage	The image is too dark.