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

DocumentQualityAnalyzerResult

data class DocumentQualityAnalyzerResult(val documentFound: Boolean, val quality: DocumentQuality?, val orientation: Double?, val cumulativeQualityHistogram: List<Int>, val qualityHeatmap: ImageRef? = null) : AutoCloseable, Parcelable

Result of document quality analysis. It can be used to determine, e.g., if a document is good enough to be used for OCR processing.

Constructors

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

constructor(json: JSONObject)

constructor(documentFound: Boolean, quality: DocumentQuality?, orientation: Double?, cumulativeQualityHistogram: List<Int>, qualityHeatmap: ImageRef? = null)

Properties

cumulativeQualityHistogram

val cumulativeQualityHistogram: List<Int>

Cumulative histogram where every entry is equal to the number of symbols with quality equal or lower than N percent, where N is the index of the entry in the array.

documentFound

val documentFound: Boolean

True if a document was found.

orientation

val orientation: Double?

Dominant orientation of the document, if found and if orientation detection is enabled. The value is in degrees counter-clockwise, where 0 corresponds to the document being straight, and the value is in the range of -180, 180. To rotate the document to be straight, rotate the image clockwise by this value.

quality

val quality: DocumentQuality?

Quality of the document, if found.

qualityHeatmap

val qualityHeatmap: ImageRef? = null

Quality heatmap. Black marks areas of no detected text. Colors represent the quality of detected text, with red meaning the lowest quality and yellow and green meaning progressively higher quality.

Functions

clone

fun clone(): DocumentQualityAnalyzerResult

open override fun close()

toJson

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