Package com.regula.documentreader.api.params

Class ImageQA

  • public class ImageQA
extends java.lang.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
      java.lang.Integer angleThreshold
      This parameter sets threshold for Image QA check of the presented document perspective angle in degrees.
      java.lang.Double brightnessThreshold
      Set the threshold for an actual document brightness below which the check fails
      java.lang.Boolean colornessCheck
      This option disabled colorness check during performing image quality validation
      java.lang.Integer documentPositionIndent
      Specify the minimum indent from the corners of the document to the borders of the image.
      java.lang.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.
      java.lang.Boolean focusCheck
      This option disabled focus check during performing image quality validation
      java.lang.Boolean glaresCheck
      This option disabled glares check during performing image quality validation
      ImageQA.GlaresCheckParams glaresCheckParams
      See ImageQA.GlaresCheckParams
      java.lang.Boolean screenCapture
      This option disabled moire patterns check during performing image quality validation

    • Constructor Summary

      Constructors 
      Constructor Description
      ImageQA()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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 Detail

      • dpiThreshold

        public java.lang.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 java.lang.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 java.lang.Boolean focusCheck
        This option disabled focus check during performing image quality validation

      • glaresCheck

        public java.lang.Boolean glaresCheck
        This option disabled glares check during performing image quality validation

      • colornessCheck

        public java.lang.Boolean colornessCheck
        This option disabled colorness check during performing image quality validation

      • screenCapture

        public java.lang.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.

      • documentPositionIndent

        public java.lang.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 java.lang.Double brightnessThreshold
        Set the threshold for an actual document brightness below which the check fails

    • Constructor Detail

      • ImageQA

        public ImageQA()

    • Method Detail

      • 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