DocSDK  2.4.1
Public Member Functions | Data Fields | Friends
docsdk::LivenessPipelineResult::Value Struct Reference

Document liveness check result. More...

#include <liveness_pipeline.h>

Public Member Functions

 Value ()=default
 
 Value (float liveness_probability, float liveness_score, float quality_score, std::vector< ImageQualityWarning > image_quality_warnings={})
 

Data Fields

float liveness_probability
 
float liveness_score
 
float quality_score = 0
 Image quality checking score. More...
 
std::vector< ImageQualityWarning > image_quality_warnings
 

Friends

std::ostream & operator<< (std::ostream &os, const Value &result)
 

Detailed Description

Document liveness check result.

Constructor & Destructor Documentation

◆ Value() [1/2]

docsdk::LivenessPipelineResult::Value::Value ( )
default

◆ Value() [2/2]

docsdk::LivenessPipelineResult::Value::Value ( float  liveness_probability,
float  liveness_score,
float  quality_score,
std::vector< ImageQualityWarning >  image_quality_warnings = {} 
)
inline

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const Value &  result 
)
friend

Field Documentation

◆ image_quality_warnings

std::vector<ImageQualityWarning> docsdk::LivenessPipelineResult::Value::image_quality_warnings

Image quality warnings

◆ liveness_probability

float docsdk::LivenessPipelineResult::Value::liveness_probability

Document liveness probability from 0 to 1

◆ liveness_score

float docsdk::LivenessPipelineResult::Value::liveness_score

Raw liveness checking score, can be used for calibration

◆ quality_score

float docsdk::LivenessPipelineResult::Value::quality_score = 0

Image quality checking score.

Deprecated:
This value is always zero. Use image_quality_warnings instead
The documentation for this struct was generated from the following file: