face_sdk::face Class Reference

The face object. Face object contains information about face bounding box on the image and the original image. More...

#include <face.h>

Public Member Functions
virtual float	confidence () const =0
	Range is from 0.0f to 1.0f where 1.0f is definetely a face.
virtual int32_t	x () const =0
	x coordinate of face bounding box in pixels
virtual int32_t	y () const =0
	y coordinate of face bounding box in pixels
virtual int32_t	width () const =0
	width of face bounding box in pixels
virtual int32_t	height () const =0
	height of face bounding box in pixels
virtual std::shared_ptr< face_sdk::image >	img () const =0
	The original image.
virtual std::shared_ptr< face_sdk::image >	cropped_image () const =0
	The cropped image (Not all detector version supports this method. Please, check for nullptr before use it)
virtual bool	has_landmarks () const =0
	true if face has predicted landmarks
virtual std::vector< std::tuple< int32_t, int32_t > >	landmarks () const =0
	returns 10 predicted landmarks and its coordinates
virtual bool	is_out_of_bounds_set () const =0
	returns true if face can be out of bounds
virtual bool	out_of_bounds () const =0
	returns true if face out of bounds More...
virtual uint32_t	version () const =0
	returns version of face detector which produced face object. See Face Detector versions.

Detailed Description

The face object. Face object contains information about face bounding box on the image and the original image.

Use make_face() functions for instantiating of alignment object. face_sdk::serializer object allows to serialize and deserialize face_sdk::face objects.

Member Function Documentation

out_of_bounds()

virtual bool face_sdk::face::out_of_bounds ( ) const

pure virtual

returns true if face out of bounds

Exceptions

face_sdk::exception

If out of bounds is not set. See Exceptions handling

---

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

• face_sdk_base/face.h