Inheritance diagram for FaceSDK.Base.Face:

Public Member Functions
	Face (IImage image)
	Create a Face More...

	Face (IImage image, uint version)
	Create a Face More...

	Face (IImage image, bool outOfBounds, uint version)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence, uint version)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence, bool outOfBounds, uint version)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence, IEnumerable< ILandmark > landmarks)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence, IEnumerable< ILandmark > landmarks, uint version)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence, IEnumerable< ILandmark > landmarks, bool outOfBounds, uint version)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence, IEnumerable< ILandmark > landmarks, IImage croppedImage)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence, IEnumerable< ILandmark > landmarks, IImage croppedImage, uint version)
	Create a Face More...

	Face (IImage image, int x, int y, int width, int height, float confidence, IEnumerable< ILandmark > landmarks, IImage croppedImage, bool outOfBounds, uint version)
	Create a Face More...

Public Member Functions inherited from FaceSDK.FaceSDKBase
override bool	Equals (object obj)

override int	GetHashCode ()

void	CheckValidity (string objectName=null)
	Throw an ObjectDisposedException adding a given name to exception's Message in case that object is not valid More...

void	Dispose ()

Static Public Attributes
static readonly float	FACE_SDK__UNKNOWN_CONFIDENCE = .0f

static readonly uint	FACE_SDK__UNKNOWN_VERSION = 0

Properties
float	Confidence `[get]`

int	X `[get]`

int	Y `[get]`

int	Width `[get]`

int	Height `[get]`

IImage	Image `[get]`

IImage	CroppedImage `[get]`

bool	HasLandmarks `[get]`

IFaceSDKSet< ILandmark >	Landmarks `[get]`

bool	IsOutOfBoundsSet `[get]`

bool	OutOfBounds `[get]`

uint	Version `[get]`

Properties inherited from FaceSDK.FaceSDKBase
IntPtr	Handle `[get, protected set]`

bool	Valid `[get]`

Properties inherited from FaceSDK.IFaceSDKBase
bool	Valid `[get]`
	True if object is valid, false if disposed or not created properly More...

Properties inherited from FaceSDK.Base.IFace
uint	Version `[get]`
	Version of Face Detector that produced this face object More...

int	X `[get]`
	x coordinate of face bounding box in pixels More...

int	Y `[get]`
	y coordinate of face bounding box in pixels More...

int	Height `[get]`
	Height of face bounding box in pixels More...

int	Width `[get]`
	Width of face bounding box in pixels More...

float	Confidence `[get]`
	Range is from 0.0f to 1.0f where 1.0f is definetely a face More...

IImage	Image `[get]`
	The original image More...

IImage	CroppedImage `[get]`
	The cropped image (Not all detector version supports this method. Please, check for nullptr before use it) More...

bool	HasLandmarks `[get]`
	True if face has predicted landmarks More...

IFaceSDKSet< ILandmark >	Landmarks `[get]`
	10 predicted landmarks and its coordinates More...

bool	IsOutOfBoundsSet `[get]`
	True if face can be out of bounds More...

bool	OutOfBounds `[get]`
	True if face is out of bounds More...

Constructor & Destructor Documentation

◆ Face() [1/12]

FaceSDK.Base.Face.Face ( IImage image )

inline

Create a Face

Parameters

image Initial image

◆ Face() [2/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		uint	version
	)

inline

Create a Face

Parameters

image	Initial image
version	Face detector version

◆ Face() [3/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		bool	outOfBounds,
		uint	version
	)

inline

Create a Face

Parameters

image	Initial image
outOfBounds	True if face is out of bounds
version	Face detector version

◆ Face() [4/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	Confidence

◆ Face() [5/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence,
		uint	version
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	Confidence
version	Face detector version

◆ Face() [6/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence,
		bool	outOfBounds,
		uint	version
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	Confidence
outOfBounds	True if face is out of bounds
version	Face detector version

◆ Face() [7/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence,
		IEnumerable< ILandmark >	landmarks
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	Confidence
landmarks	Landmarks

◆ Face() [8/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence,
		IEnumerable< ILandmark >	landmarks,
		uint	version
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	Confidence
landmarks	Landmarks
version	Face detector version

◆ Face() [9/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence,
		IEnumerable< ILandmark >	landmarks,
		bool	outOfBounds,
		uint	version
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	Confidence
landmarks	Landmarks
outOfBounds	True if face is out of bounds
version	Face detector version

◆ Face() [10/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence,
		IEnumerable< ILandmark >	landmarks,
		IImage	croppedImage
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	Confidence
landmarks	Landmarks
croppedImage	Cropped image

◆ Face() [11/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence,
		IEnumerable< ILandmark >	landmarks,
		IImage	croppedImage,
		uint	version
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	Confidence
landmarks	Landmarks
croppedImage	Cropped image
version	Face detector version

◆ Face() [12/12]

FaceSDK.Base.Face.Face	(	IImage	image,
		int	x,
		int	y,
		int	width,
		int	height,
		float	confidence,
		IEnumerable< ILandmark >	landmarks,
		IImage	croppedImage,
		bool	outOfBounds,
		uint	version
	)

inline

Create a Face

Parameters

image	Initial image
x	X coordinate
y	Y coordinate
width	Image width
height	Image height
confidence	>Confidence
landmarks	Landmarks
croppedImage	Cropped image
outOfBounds	True if face is out of bounds
version	Face detector version

The documentation for this class was generated from the following file:

Base/Face.cs

Public Member Functions

Static Public Attributes

Properties

Constructor & Destructor Documentation

◆ Face() [1/12]

◆ Face() [2/12]

◆ Face() [3/12]

◆ Face() [4/12]

◆ Face() [5/12]

◆ Face() [6/12]

◆ Face() [7/12]

◆ Face() [8/12]

◆ Face() [9/12]

◆ Face() [10/12]

◆ Face() [11/12]

◆ Face() [12/12]