Package io.scanbot.sdk.documentdata

Class AutoFocusConfiguration

  • public class AutoFocusConfiguration
extends DocumentDataExtractorConfigurationElement
    Auto-focus configuration. The recognizer will ignore frames that are not focused. This option is enabled by default. This configuration has no effect in SINGLE_SHOT mode.

    • Constructor Summary

      Constructors 
      Constructor Description
      AutoFocusConfiguration()
      Constructs AutoFocusConfiguration with default parameters.
      AutoFocusConfiguration​(double sensitivityThreshold)
      Constructs AutoFocusConfiguration with the given params.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getSensitivityThreshold()
      Getter for sensitivityThreshold field.
      void setSensitivityThreshold​(double sensitivityThreshold)
      Setter for sensitivityThreshold field.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AutoFocusConfiguration

        public AutoFocusConfiguration​(double sensitivityThreshold)
        Constructs AutoFocusConfiguration with the given params.
        Parameters:
        sensitivityThreshold - Sensitivity threshold for detecting that autofocus is in progress. The value should be in the range [0.0, 1.0]. The lower the value, the more frames might be discarded as not focused. The higher the value, the earlier the focus might be considered as focused. If set to 0.0, the feature is disabled. Default is 0.02

      • AutoFocusConfiguration

        public AutoFocusConfiguration()
        Constructs AutoFocusConfiguration with default parameters.

    • Method Detail

      • getSensitivityThreshold

        public double getSensitivityThreshold()
        Getter for sensitivityThreshold field. See constructor documentation for more information about the field.
        Returns:
        sensitivityThreshold

      • setSensitivityThreshold

        public void setSensitivityThreshold​(double sensitivityThreshold)
        Setter for sensitivityThreshold field. See constructor documentation for more information about the field.
        Parameters:
        sensitivityThreshold - Value to set.