Package com.regula.documentreader.api.params

Class ImageQA

java.lang.Object

com.regula.documentreader.api.params.ImageQA

public class ImageQA
extends Object

Structure contains options for incoming image quality assurance checks

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageQA.GlaresCheckParams	Class containing additional parameters for glare checking

Field Summary

Fields

Modifier and Type	Field	Description
Integer	angleThreshold	This parameter sets threshold for Image QA check of the presented document perspective angle in degrees.
Double	brightnessThreshold	Set the threshold for an actual document brightness below which the check fails
Boolean	colornessCheck	This option disabled colorness check during performing image quality validation
Integer	documentPositionIndent	Specify the minimum indent from the corners of the document to the borders of the image.
Integer	dpiThreshold	This parameter sets threshold for Image QA check of the presented document physical dpi.
int[]	expectedPass	This option controls the quality checks that the image should pass in order to be considered a valid input during the scanning process.
Boolean	focusCheck	This option disabled focus check during performing image quality validation
Boolean	glaresCheck	This option disabled glares check during performing image quality validation
ImageQA.GlaresCheckParams	glaresCheckParams	See ImageQA.GlaresCheckParams
Boolean	screenCapture	This option disabled moire patterns check during performing image quality validation

Constructor Summary

Constructors

Constructor	Description
ImageQA()

Method Summary

Modifier and Type	Method	Description
void	fromJson(JSONObject object)	Converts JSON object to class instance
JSONObject	toJsonObject()	Method convert object to JSONObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dpiThreshold

public Integer dpiThreshold

This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.

angleThreshold

public Integer angleThreshold

This parameter sets threshold for Image QA check of the presented document perspective angle in degrees. If actual document perspective angle is above this threshold, check will fail.

focusCheck

public Boolean focusCheck

This option disabled focus check during performing image quality validation

glaresCheck

public Boolean glaresCheck

This option disabled glares check during performing image quality validation

colornessCheck

public Boolean colornessCheck

This option disabled colorness check during performing image quality validation

screenCapture

public Boolean screenCapture

This option disabled moire patterns check during performing image quality validation

expectedPass

public int[] expectedPass

This option controls the quality checks that the image should pass in order to be considered a valid input during the scanning process.

glaresCheckParams

public ImageQA.GlaresCheckParams glaresCheckParams

See ImageQA.GlaresCheckParams

documentPositionIndent

public Integer documentPositionIndent

Specify the minimum indent from the corners of the document to the borders of the image. The value reflects the allowed percentage for the indent relative to the width of the document. If it is detected that the corners of the document are closer than the specified value, the status will contain an error in the DocumentReaderResults.imageQuality list at ImageQualityGroup.result field.

brightnessThreshold

public Double brightnessThreshold

Set the threshold for an actual document brightness below which the check fails

Constructor Details

ImageQA

public ImageQA()

Method Details

toJsonObject

public JSONObject toJsonObject()

Method convert object to JSONObject

Returns:

object to JSONObject

fromJson

public void fromJson(JSONObject object)

Converts JSON object to class instance