Android Scanbot SDK API reference/io.scanbot.sdk.process/DocumentQualityAnalyzerConfiguration

DocumentQualityAnalyzerConfiguration

data class DocumentQualityAnalyzerConfiguration(var qualityThresholds: List<DocumentQualityThreshold> = listOf( DocumentQualityThreshold( symbolQuality = 0.5, symbolRatio = 0.5 ), DocumentQualityThreshold( symbolQuality = 0.7, symbolRatio = 0.3 ), DocumentQualityThreshold( symbolQuality = 0.85, symbolRatio = 0.3 ), DocumentQualityThreshold( symbolQuality = 0.9, symbolRatio = 0.1 ) ), var qualityIndices: List<DocumentQuality> = listOf( DocumentQuality.VERY_POOR, DocumentQuality.POOR, DocumentQuality.REASONABLE, DocumentQuality.GOOD, DocumentQuality.EXCELLENT ), var detectOrientation: Boolean = false, var inspectSmallText: Boolean = false, var maxImageSize: Int = 2000, var minEstimatedNumberOfSymbolsForDocument: Int = 20, var minProcessedFraction: Double = 0.0, var maxProcessedFraction: Double = 0.5, var earlyStopIfNSymbolsFound: Int = 100, var tileSize: Int = 300, var returnQualityHeatmap: Boolean = false) : Parcelable

Document Quality Analyzer configuration.

Constructors

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(qualityThresholds: List<DocumentQualityThreshold> = listOf( DocumentQualityThreshold( symbolQuality = 0.5, symbolRatio = 0.5 ), DocumentQualityThreshold( symbolQuality = 0.7, symbolRatio = 0.3 ), DocumentQualityThreshold( symbolQuality = 0.85, symbolRatio = 0.3 ), DocumentQualityThreshold( symbolQuality = 0.9, symbolRatio = 0.1 ) ), qualityIndices: List<DocumentQuality> = listOf( DocumentQuality.VERY_POOR, DocumentQuality.POOR, DocumentQuality.REASONABLE, DocumentQuality.GOOD, DocumentQuality.EXCELLENT ), detectOrientation: Boolean = false, inspectSmallText: Boolean = false, maxImageSize: Int = 2000, minEstimatedNumberOfSymbolsForDocument: Int = 20, minProcessedFraction: Double = 0.0, maxProcessedFraction: Double = 0.5, earlyStopIfNSymbolsFound: Int = 100, tileSize: Int = 300, returnQualityHeatmap: Boolean = false)

Types

Companion

object Companion

Properties

detectOrientation

var detectOrientation: Boolean

Enable orientation detection. Document orientation will be returned in DocumentQualityAnalyzerResult.orientation.

earlyStopIfNSymbolsFound

var earlyStopIfNSymbolsFound: Int

If this number of symbols is found and minProcessedFraction of the image is processed, the processing stops.

inspectSmallText

var inspectSmallText: Boolean

Inspect small text (typically less than 12 pixels height) when analyzing the document quality. If true, processing will be slower, but when the quality issue with a document is the low resolution of the text, then the issue will be caught.

maxImageSize

var maxImageSize: Int

Maximum image size in pixels, if image is bigger, it will be resized.

maxProcessedFraction

var maxProcessedFraction: Double

At most this fraction of the image will be processed, range is from 0 to 1.

minEstimatedNumberOfSymbolsForDocument

var minEstimatedNumberOfSymbolsForDocument: Int

If estimated number of symbols is less than this value, return that document is not found.

minProcessedFraction

var minProcessedFraction: Double

At least this fraction of the image will be processed, range is from 0 to 1.

qualityIndices

var qualityIndices: List<DocumentQuality>

quality levels.

qualityThresholds

var qualityThresholds: List<DocumentQualityThreshold>

Quality thresholds to separate quality levels.

returnQualityHeatmap

var returnQualityHeatmap: Boolean

If true, will return the quality heatmap as a part of the result. In this case, the entire image will be processed and the minProcessedFraction will be ignored. Useful for debugging situations where the returned quality doesn't appear to match the perceived quality.

tileSize

var tileSize: Int

Image will be processed in tiles of this size; will be ignored if image is small.

Functions

clone

fun clone(): DocumentQualityAnalyzerConfiguration

toJson

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject