docsdk::LivenessPipeline Class Reference

Document liveness checking pipeline. More...

#include <liveness_pipeline.h>

Public Types
using	Ptr = std::shared_ptr< LivenessPipeline >

Public Member Functions
virtual LivenessPipelineResult	CheckLiveness (Image::Ptr image, const LivenessCheckOptions &options={}) const =0
virtual LivenessPipelineResult	CheckLivenessSequence (const std::vector< Image::Ptr > &images, const LivenessCheckOptions &options={}) const =0
virtual	~LivenessPipeline () noexcept=default

Static Public Member Functions
static Ptr	Create (const std::string &path_to_config)

Detailed Description

Document liveness checking pipeline.

Member Typedef Documentation

Ptr

using docsdk::LivenessPipeline::Ptr = std::shared_ptr<LivenessPipeline>

Constructor & Destructor Documentation

~LivenessPipeline()

virtual docsdk::LivenessPipeline::~LivenessPipeline ( )

virtualdefaultnoexcept

Member Function Documentation

CheckLiveness()

virtual LivenessPipelineResult docsdk::LivenessPipeline::CheckLiveness ( Image::Ptr  image, const LivenessCheckOptions &  options = {}  ) const

pure virtual

Checks liveness using the provided document photo.

Parameters

image	Image containing the photo of document
options	Optional liveness check options

Returns

Liveness checking result

Exceptions

std::runtime_error
docsdk::LicenseException

CheckLivenessSequence()

virtual LivenessPipelineResult docsdk::LivenessPipeline::CheckLivenessSequence ( const std::vector< Image::Ptr > &  images, const LivenessCheckOptions &  options = {}  ) const

pure virtual

Performs liveness check using a sequence of photos (e.g. taken from video) producing a single aggregated liveness checking result.

Parameters

images	Photo sequence
options	Optional liveness check options

Returns

Liveness checking result

Exceptions

std::runtime_error
docsdk::LicenseException

Create()

static Ptr docsdk::LivenessPipeline::Create ( const std::string &  path_to_config )

static

Liveness pipeline factory method.

Parameters

path_to_config

Path to liveness pipeline configuration file

Returns

Smart pointer to created LivenessPipeline instance

Exceptions

std::runtime_error
docsdk::LicenseException

---

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

• liveness_pipeline.h