facesdk::Pipeline Class Reference

Interface of liveness detection pipeline. More...

#include <facesdk/Pipeline.h>

Public Member Functions
virtual PipelineResult	checkLiveness (ImagePtr image, Meta meta={})=0
	Check liveness of face from input image.
virtual PipelineResult	checkLiveness (const ImageBatch &image_batch, Meta meta={})=0
	Perform liveness check on a sequence of photos (image batch). A single results corresponding to the whole image batch will be produced.
virtual std::vector< OptionalPipelineResult >	checkLivenessBatch (const std::vector< facesdk::ImagePtr > &images, const std::vector< Meta > &meta={})=0
	This method implements batched liveness check.

Detailed Description

Interface of liveness detection pipeline.

Member Function Documentation

checkLiveness() [1/2]

virtual PipelineResult facesdk::Pipeline::checkLiveness ( const ImageBatch &  image_batch, Meta  meta = {}  )

pure virtual

Perform liveness check on a sequence of photos (image batch). A single results corresponding to the whole image batch will be produced.

Parameters

image_batch	Input batch of images (a sequence of photos)
meta	Meta information about device

Returns

A single liveness detection result for a given sequence of photos

Exceptions

FaceException

checkLiveness() [2/2]

virtual PipelineResult facesdk::Pipeline::checkLiveness ( ImagePtr  image, Meta  meta = {}  )

pure virtual

Check liveness of face from input image.

Parameters

image	Input image
meta	Meta information about device

Returns

Result of liveness detection

Exceptions

FaceException

checkLivenessBatch()

virtual std::vector< OptionalPipelineResult > facesdk::Pipeline::checkLivenessBatch ( const std::vector< facesdk::ImagePtr > &  images, const std::vector< Meta > &  meta = {}  )

pure virtual

This method implements batched liveness check.

Parameters

images	Input images
meta	Meta information about device for all or none images

Returns

Optional liveness check 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 checkLiveness method.