Face::Keypoints Class Reference

It holds all facial keypoints detected on a FaceCapture image. More...

#include <Face.h>

Collaboration diagram for Face::Keypoints:

Public Member Functions
Keypoint	RightEyeOuterCorner ()
	Key point for evaluating reliability of right eye outer corner.
Keypoint	RightEyeCentre ()
	Key point for evaluating reliability of right eye centre.
Keypoint	RightEyeInnerCorner ()
	Key point for evaluating reliability of inner corner of right eye.
Keypoint	LeftEyeInnerCorner ()
	Key point for evaluating reliability of inner corner of left eye.
Keypoint	LeftEyeCentre ()
	Key point for evaluating reliability of left eye centre.
Keypoint	LeftEyeOuterCorner ()
	Key point for evaluating reliability of outer corner of left eye.
Keypoint	NoseRoot ()
	Key point for evaluating reliability of nose root.
Keypoint	NoseRightBottom ()
	Key point for evaluating reliability of right bottom of nose.
Keypoint	NoseTip ()
	Key point for evaluating reliability of nose tip.
Keypoint	NoseLeftBottom ()
	Key point for evaluating reliability of left bottom of nose.
Keypoint	NoseBottom ()
	Key point for evaluating reliability of bottom of nose.
Keypoint	MouthRightCorner ()
	Key point for evaluating reliability of right corner of mouth.
Keypoint	MouthCenter ()
	Key point for evaluating reliability of center of mouth.
Keypoint	MouthLeftCorner ()
	Key point for evaluating reliability of left corner of mouth.
Keypoint	MouthUpperEdge ()
	Key point for evaluating reliability of upper edge of mouth.
Keypoint	MouthLowerEdge ()
	Key point for evaluating reliability of lower edge of mouth.
Keypoint	RightEyebrowOuterEnd ()
	Key point for evaluating reliability of outer end of right eyebrow.
Keypoint	RightEyebrowInnerEnd ()
	Key point for evaluating reliability of inner end of right eyebrow.
Keypoint	LeftEyebrowInnerEnd ()
	Key point for evaluating reliability of inner end of left eyebrow.
Keypoint	LeftEyebrowOuterEnd ()
	Key point for evaluating reliability of outer end of left eyebrow.
Keypoint	RightEdge ()
	Key point for evaluating reliability of right edge of face.
Keypoint	ChinTip ()
	Key point for evaluating reliability of tip of chin.
Keypoint	LeftEdge ()
	Key point for evaluating reliability of left edge of face.
std::shared_ptr< Image >	GetImage () const
	Get image related to the detected keypoints.
void	WriteTo (Writer &writer) const final
	Function serializes keypoints via provided Writer.

Friends
class	Face

Detailed Description

It holds all facial keypoints detected on a FaceCapture image.

The keypoint coordinates are always relative to the input image origin (one from which face was detected and segmented). Image origin is pixel[0,0] is upper left corner.

Member Function Documentation

ChinTip()

Keypoint ChinTip ( )

inline

Key point for evaluating reliability of tip of chin.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

GetImage()

std::shared_ptr< Image > GetImage ( ) const

inlinenodiscard

Get image related to the detected keypoints.

Returns

Face image

LeftEdge()

Keypoint LeftEdge ( )

inline

Key point for evaluating reliability of left edge of face.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's left side of face.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

LeftEyebrowInnerEnd()

Keypoint LeftEyebrowInnerEnd ( )

inline

Key point for evaluating reliability of inner end of left eyebrow.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's left eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

LeftEyebrowOuterEnd()

Keypoint LeftEyebrowOuterEnd ( )

inline

Key point for evaluating reliability of outer end of left eyebrow.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's left eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

LeftEyeCentre()

Keypoint LeftEyeCentre ( )

inline

Key point for evaluating reliability of left eye centre.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's left eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

LeftEyeInnerCorner()

Keypoint LeftEyeInnerCorner ( )

inline

Key point for evaluating reliability of inner corner of left eye.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's left eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

LeftEyeOuterCorner()

Keypoint LeftEyeOuterCorner ( )

inline

Key point for evaluating reliability of outer corner of left eye.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's left eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

MouthCenter()

Keypoint MouthCenter ( )

inline

Key point for evaluating reliability of center of mouth.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

MouthLeftCorner()

Keypoint MouthLeftCorner ( )

inline

Key point for evaluating reliability of left corner of mouth.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's left side of face.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

MouthLowerEdge()

Keypoint MouthLowerEdge ( )

inline

Key point for evaluating reliability of lower edge of mouth.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

MouthRightCorner()

Keypoint MouthRightCorner ( )

inline

Key point for evaluating reliability of right corner of mouth.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's right side of face.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

MouthUpperEdge()

Keypoint MouthUpperEdge ( )

inline

Key point for evaluating reliability of upper edge of mouth.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

NoseBottom()

Keypoint NoseBottom ( )

inline

Key point for evaluating reliability of bottom of nose.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

NoseLeftBottom()

Keypoint NoseLeftBottom ( )

inline

Key point for evaluating reliability of left bottom of nose.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's left side of face.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

NoseRightBottom()

Keypoint NoseRightBottom ( )

inline

Key point for evaluating reliability of right bottom of nose.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's right side of face.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

NoseRoot()

Keypoint NoseRoot ( )

inline

Key point for evaluating reliability of nose root.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

NoseTip()

Keypoint NoseTip ( )

inline

Key point for evaluating reliability of nose tip.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

RightEdge()

Keypoint RightEdge ( )

inline

Key point for evaluating reliability of right edge of face.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's right side of face.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

RightEyebrowInnerEnd()

Keypoint RightEyebrowInnerEnd ( )

inline

Key point for evaluating reliability of inner end of right eyebrow.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's right eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

RightEyebrowOuterEnd()

Keypoint RightEyebrowOuterEnd ( )

inline

Key point for evaluating reliability of outer end of right eyebrow.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's right eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

RightEyeCentre()

Keypoint RightEyeCentre ( )

inline

Key point for evaluating reliability of right eye centre.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's right eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

RightEyeInnerCorner()

Keypoint RightEyeInnerCorner ( )

inline

Key point for evaluating reliability of inner corner of right eye.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's right eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

RightEyeOuterCorner()

Keypoint RightEyeOuterCorner ( )

inline

Key point for evaluating reliability of right eye outer corner.

The key point represents the anatomical position on the face (not the position as seen in the image), i.e. the person's right eye.

Returns

Instance of the key point defined by its position in the image and reliability score.

Exceptions

EnrollmentException

when key point can not be calculated

WriteTo()

void WriteTo ( Writer & writer ) const

inlinefinalvirtual

Function serializes keypoints via provided Writer.

Parameters

writer

used to serialize keypoints.

Implements Serializable.

---

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

• Face/Face.h