kmp-bundle-sdk/io.scanbot.sdk.kmp.documentqualityanalyzer

Package-level declarations

Types

enum DocumentQuality : Enum<DocumentQuality>

Result of document quality analysis.

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 processByTileConfiguration: ProcessByTileConfiguration = ProcessByTileConfiguration( ), var minRequiredOrientationConfidence: Double = 0.0, var returnQualityHeatmap: Boolean = false)

Document Quality Analyzer configuration.

DocumentQualityAnalyzerResult

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

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.

DocumentQualityThreshold

data class DocumentQualityThreshold(val symbolQuality: Double, val symbolRatio: Double)

Point in the quality-number of symbols space to separate quality levels.

ProcessByTileConfiguration

data class ProcessByTileConfiguration(var enabled: Boolean = false, var minProcessedFraction: Double = 1.0, var maxProcessedFraction: Double = 1.0, var minNumberOfRequiredSymbols: Int = 100, var tileSize: Int = 300)

Configuration for processing image by tiles. This can be used to make the document quality analyzer processing faster with lower memory consumption, but prediction can be less accurate.