DocSDK  2.4.1
Public Types | Public Member Functions | Static Public Member Functions
docsdk::LivenessPipelineComposition Class Referenceabstract

Document liveness checking pipeline composition. More...

#include <liveness_pipeline.h>

Public Types

using Ptr = std::shared_ptr< LivenessPipelineComposition >
 

Public Member Functions

virtual std::unordered_map< std::string, LivenessPipelineResult > CheckLiveness (Image::Ptr image, const std::unordered_map< std::string, LivenessCheckOptions > &options={}) const =0
 
virtual ~LivenessPipelineComposition () noexcept=default
 

Static Public Member Functions

static Ptr Create (const std::vector< std::string > &paths_to_configs)
 

Detailed Description

Document liveness checking pipeline composition.

Member Typedef Documentation

◆ Ptr

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

Constructor & Destructor Documentation

◆ ~LivenessPipelineComposition()

virtual docsdk::LivenessPipelineComposition::~LivenessPipelineComposition ( )
virtualdefaultnoexcept

Member Function Documentation

◆ CheckLiveness()

virtual std::unordered_map<std::string, LivenessPipelineResult> docsdk::LivenessPipelineComposition::CheckLiveness ( Image::Ptr  image,
const std::unordered_map< std::string, LivenessCheckOptions > &  options = {} 
) const
pure virtual

Checks liveness using the provided document photo.

Parameters
imageImage containing the photo of document
optionsOptional liveness check options. If empty all pipelines in composition are run, otherwise only pipelines in options are run
Returns
Liveness checking result
Exceptions
std::runtime_error
docsdk::LicenseException

◆ Create()

static Ptr docsdk::LivenessPipelineComposition::Create ( const std::vector< std::string > &  paths_to_configs)
static

Pipeline composition factory method.

Parameters
paths_to_configsPaths to liveness pipeline configuration files to use in composition
Returns
Smart pointer to created LivenessPipelineComposition instance
Exceptions
std::runtime_error
docsdk::LicenseException
The documentation for this class was generated from the following file: