Android Scanbot SDK/io.scanbot.sdk.documentqualityanalyzer

Package-level declarations

Types

data class CharacterLevelAnnotation(val plotCenter: PointF, val plotWidth: Double, val plotHeight: Double, val ocrability: Double, val contrast: Double, val fontSize: Double, val orientation: Double, val orientationNormalized: Double, val orientationDeviation: Double) : Parcelable

Character level annotation, contains information about the quality of a character in the document.

CharacterLevelAnnotations

data class CharacterLevelAnnotations(val annotations: List<CharacterLevelAnnotation>, val apiVersion: String) : Parcelable

Character level annotations, contains information about each character in the document.

DocumentQuality

enum DocumentQuality : Enum<DocumentQuality>

Deprecated, please use DocumentQualityAssessment instead. Result of document quality analysis.

DocumentQualityAnalyzer

interface DocumentQualityAnalyzer

Interface for DocumentQualityAnalyzer API. See class documentation for more details.

DocumentQualityAnalyzerCompatibilityMode

enum DocumentQualityAnalyzerCompatibilityMode : Enum<DocumentQualityAnalyzerCompatibilityMode>

Compatibility mode for the Document Quality Analyzer. In this mode, the analyzer will return results that are identical to older versions of the SDK.

DocumentQualityAnalyzerCompatibilityModeConfiguration

data class DocumentQualityAnalyzerCompatibilityModeConfiguration(val mode: DocumentQualityAnalyzerCompatibilityMode = DocumentQualityAnalyzerCompatibilityMode.V8, var minimumAcceptableQuality: DocumentQuality = DocumentQuality.REASONABLE, var minimumUncertainQuality: DocumentQuality = DocumentQuality.POOR, var inspectSmallText: Boolean = false) : Parcelable

Configuration for the compatibility mode of the Document Quality Analyzer. In this mode, the analyzer will return results that are identical to older versions of the SDK.

DocumentQualityAnalyzerConfiguration

data class DocumentQualityAnalyzerConfiguration(var qualityAnalysisModel: String = "", var qualityAcceptableUncertainThreshold: Double = 0.5, var qualityUnacceptableUncertainThreshold: Double = 0.5, var qualityLevelThresholds: 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 qualityLevelIndices: List<DocumentQuality> = listOf( DocumentQuality.VERY_POOR, DocumentQuality.POOR, DocumentQuality.REASONABLE, DocumentQuality.GOOD, DocumentQuality.EXCELLENT ), var inputScales: List<Double> = listOf( 1.0 ), var inputScaleThresholdToProcessEntireImage: Double = 0.25, var maxImageSize: Int = 2000, var minEstimatedNumberOfSymbolsForDocument: Int = 20, var processByTileConfiguration: ProcessByTileConfiguration = ProcessByTileConfiguration( ), var minRequiredOrientationConfidence: Double = 0.9, var returnQualityHeatmap: Boolean = false, var compatibilityMode: DocumentQualityAnalyzerCompatibilityModeConfiguration? = null) : Parcelable

Document Quality Analyzer configuration

DocumentQualityAnalyzerFactory

class DocumentQualityAnalyzerFactory : IDocumentQualityAnalyzerFactory

DocumentQualityAnalyzerResult

data class DocumentQualityAnalyzerResult(val quality: DocumentQualityAssessment, val documentFound: Boolean, val qualityLevel: DocumentQuality?, val orientation: Double, val orientationConfidence: Double, val cumulativeQualityHistogram: List<Int>, val qualityHeatmap: ImageRef? = null, val bestInputScale: Double) : 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.

DocumentQualityAssessment

enum DocumentQualityAssessment : Enum<DocumentQualityAssessment>

Result of document quality analysis.

DocumentQualityThreshold

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

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

IDocumentQualityAnalyzerFactory

interface IDocumentQualityAnalyzerFactory

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) : Parcelable

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.

ScanbotSdkDocumentQualityAnalyzer

class ScanbotSdkDocumentQualityAnalyzer : SelfDisposable, DocumentQualityAnalyzer

API for analyzing document quality.