facesdk::DetectEngine Class Reference

Interface of facial keypoint detector. More...

#include <facesdk/DetectorEngine.h>

Public Member Functions
virtual DetectionResult	detect (ImagePtr image)=0
	Facial keypoints and bbox detecting method.
virtual std::vector< OptionalDetectionResult >	detectBatch (const std::vector< ImagePtr > &images)=0
	Facial keypoints and bbox batch detecting method.
virtual std::vector< BoundingBox >	detectOnlyBoundingBox (ImagePtr image)=0
	Facial bbox detecting method.
virtual std::vector< facesdk::OptionalResult< std::vector< BoundingBox > > >	detectOnlyBoundingBoxBatch (const std::vector< ImagePtr > &images)=0
	Facial bbox batch detecting method.

Detailed Description

Interface of facial keypoint detector.

Member Function Documentation

detect()

virtual DetectionResult facesdk::DetectEngine::detect ( ImagePtr  image )

pure virtual

Facial keypoints and bbox detecting method.

Parameters

image

Reference to Image object

Returns

Detection result

Exceptions

FaceException

detectBatch()

virtual std::vector< OptionalDetectionResult > facesdk::DetectEngine::detectBatch ( const std::vector< ImagePtr > &  images )

pure virtual

Facial keypoints and bbox batch detecting method.

Parameters

images

Input image batch

Returns

Optional detection results. The size of the result vector is guaranteed equal to images vector size.

Exceptions

FaceException

Deprecated:

Using this method has no benefits compared to the usual detect method.

detectOnlyBoundingBox()

virtual std::vector< BoundingBox > facesdk::DetectEngine::detectOnlyBoundingBox ( ImagePtr  image )

pure virtual

Facial bbox detecting method.

Parameters

image

Reference to Image object

Returns

Facial bbox

Exceptions

FaceException

detectOnlyBoundingBoxBatch()

virtual std::vector< facesdk::OptionalResult< std::vector< BoundingBox > > > facesdk::DetectEngine::detectOnlyBoundingBoxBatch ( const std::vector< ImagePtr > &  images )

pure virtual

Facial bbox batch detecting method.

Parameters

images

Input image batch

Returns

Optional facial bboxes. The size of the result vector is guaranteed equal to images vector size.

Exceptions

FaceException

Deprecated:

Using this method has no benefits compared to the usual detectOnlyBoundingBox method.