All Implemented Interfaces:: android.os.Parcelable


public final class DocumentScannerParameters
 implements Parcelable

Parameters for the document scanner.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Integer`	`acceptedAngleScore`
`private Integer`	`acceptedSizeScore`
`private Integer`	`acceptedBrightnessThreshold`
`private Integer`	`acceptedAspectRatioScore`
`private List<AspectRatio>`	`aspectRatios`
`private Boolean`	`ignoreOrientationMismatch`

Constructor Summary

Constructors
Constructor	Description
`DocumentScannerParameters(Map<String, Object> source)`
`DocumentScannerParameters(JSONObject json)`
`DocumentScannerParameters(Integer acceptedAngleScore, Integer acceptedSizeScore, Integer acceptedBrightnessThreshold, Integer acceptedAspectRatioScore, List<AspectRatio> aspectRatios, Boolean ignoreOrientationMismatch)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getAcceptedAngleScore()`	The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document.
`final Unit`	`setAcceptedAngleScore(Integer acceptedAngleScore)`	The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document.
`final Integer`	`getAcceptedSizeScore()`	The minimum size in percent (0 - 100) of the screen size to accept a detected document.
`final Unit`	`setAcceptedSizeScore(Integer acceptedSizeScore)`	The minimum size in percent (0 - 100) of the screen size to accept a detected document.
`final Integer`	`getAcceptedBrightnessThreshold()`	The minimum brightness value (0-255) to accept a detected document.
`final Unit`	`setAcceptedBrightnessThreshold(Integer acceptedBrightnessThreshold)`	The minimum brightness value (0-255) to accept a detected document.
`final Integer`	`getAcceptedAspectRatioScore()`	The minimum score in percent (0 - 100) that the aspect ratio of the document must match one of the required aspect ratios (if any) to accept a detected document.
`final Unit`	`setAcceptedAspectRatioScore(Integer acceptedAspectRatioScore)`	The minimum score in percent (0 - 100) that the aspect ratio of the document must match one of the required aspect ratios (if any) to accept a detected document.
`final List<AspectRatio>`	`getAspectRatios()`	The possible desired aspect ratios for the detected document.
`final Unit`	`setAspectRatios(List<AspectRatio> aspectRatios)`	The possible desired aspect ratios for the detected document.
`final Boolean`	`getIgnoreOrientationMismatch()`	If false, the document scanner will return OK_BUT_ORIENTATION_MISMATCH if the detected document orientation does not match the input image orientation, e.g.
`final Unit`	`setIgnoreOrientationMismatch(Boolean ignoreOrientationMismatch)`	If false, the document scanner will return OK_BUT_ORIENTATION_MISMATCH if the detected document orientation does not match the input image orientation, e.g.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final DocumentScannerParameters`	`clone()`
`final static DocumentScannerParameters`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentScannerParameters
```
DocumentScannerParameters(Map<String, Object> source)
```
  - DocumentScannerParameters
```
DocumentScannerParameters(JSONObject json)
```
  - DocumentScannerParameters
```
DocumentScannerParameters(Integer acceptedAngleScore, Integer acceptedSizeScore, Integer acceptedBrightnessThreshold, Integer acceptedAspectRatioScore, List<AspectRatio> aspectRatios, Boolean ignoreOrientationMismatch)
```
- Method Detail
  - getAcceptedAngleScore
```
 final Integer getAcceptedAngleScore()
```
    The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Set lower values to accept more perspective distortion.
    Warning: Lower values result in more blurred document images.
    Default is 75
  - setAcceptedAngleScore
```
 final Unit setAcceptedAngleScore(Integer acceptedAngleScore)
```
    The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Set lower values to accept more perspective distortion.
    Warning: Lower values result in more blurred document images.
    Default is 75
  - getAcceptedSizeScore
```
 final Integer getAcceptedSizeScore()
```
    The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score.
    Warning: Lower values result in low resolution document images.
    Default is 80
  - setAcceptedSizeScore
```
 final Unit setAcceptedSizeScore(Integer acceptedSizeScore)
```
    The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score.
    Warning: Lower values result in low resolution document images.
    Default is 80
  - getAcceptedBrightnessThreshold
```
 final Integer getAcceptedBrightnessThreshold()
```
    The minimum brightness value (0-255) to accept a detected document.
    Default is 0
  - setAcceptedBrightnessThreshold
```
 final Unit setAcceptedBrightnessThreshold(Integer acceptedBrightnessThreshold)
```
    The minimum brightness value (0-255) to accept a detected document.
    Default is 0
  - getAcceptedAspectRatioScore
```
 final Integer getAcceptedAspectRatioScore()
```
    The minimum score in percent (0 - 100) that the aspect ratio of the document must match one of the required aspect ratios (if any) to accept a detected document. If acceptedAspectRatioScore is more than 0, then the document is only accepted if the aspect ratio matches one of the given aspect ratios (if any), otherwise OK_BUT_BAD_ASPECT_RATIO is returned.
    Default is 85
  - setAcceptedAspectRatioScore
```
 final Unit setAcceptedAspectRatioScore(Integer acceptedAspectRatioScore)
```
    The minimum score in percent (0 - 100) that the aspect ratio of the document must match one of the required aspect ratios (if any) to accept a detected document. If acceptedAspectRatioScore is more than 0, then the document is only accepted if the aspect ratio matches one of the given aspect ratios (if any), otherwise OK_BUT_BAD_ASPECT_RATIO is returned.
    Default is 85
  - getAspectRatios
```
 final List<AspectRatio> getAspectRatios()
```
    The possible desired aspect ratios for the detected document. A document matches if its aspect ratio matches any of the given aspect ratios. If acceptedAspectRatioScore is more than 0, then the document is only accepted if the aspect ratio matches one of the given aspect ratios, otherwise OK_BUT_BAD_ASPECT_RATIO is returned. If empty, no aspect ratio is preferred.
  - setAspectRatios
```
 final Unit setAspectRatios(List<AspectRatio> aspectRatios)
```
    The possible desired aspect ratios for the detected document. A document matches if its aspect ratio matches any of the given aspect ratios. If acceptedAspectRatioScore is more than 0, then the document is only accepted if the aspect ratio matches one of the given aspect ratios, otherwise OK_BUT_BAD_ASPECT_RATIO is returned. If empty, no aspect ratio is preferred.
  - getIgnoreOrientationMismatch
```
 final Boolean getIgnoreOrientationMismatch()
```
    If false, the document scanner will return OK_BUT_ORIENTATION_MISMATCH if the detected document orientation does not match the input image orientation, e.g. if the document is detected as landscape but the input image is portrait. If true, the document scanner will ignore orientation mismatches.
    Default is false
  - setIgnoreOrientationMismatch
```
 final Unit setIgnoreOrientationMismatch(Boolean ignoreOrientationMismatch)
```
    If false, the document scanner will return OK_BUT_ORIENTATION_MISMATCH if the detected document orientation does not match the input image orientation, e.g. if the document is detected as landscape but the input image is portrait. If true, the document scanner will ignore orientation mismatches.
    Default is false
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final DocumentScannerParameters clone()
```
  - default
```
 final static DocumentScannerParameters default()
```

Class DocumentScannerParameters

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentScannerParameters

DocumentScannerParameters

DocumentScannerParameters

Method Detail

getAcceptedAngleScore

setAcceptedAngleScore

getAcceptedSizeScore

setAcceptedSizeScore

getAcceptedBrightnessThreshold

setAcceptedBrightnessThreshold

getAcceptedAspectRatioScore

setAcceptedAspectRatioScore

getAspectRatios

setAspectRatios

getIgnoreOrientationMismatch

setIgnoreOrientationMismatch

toJson

clone

default