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

Package-level declarations

Types

DefaultDocumentQualityAnalyzer

class DefaultDocumentQualityAnalyzer : DocumentQualityAnalyzer

Default implementation for DocumentQualityAnalyzer

DocumentQuality

enum DocumentQuality : Enum<DocumentQuality>

Result of document quality analysis.

DocumentQualityAnalyzer

interface DocumentQualityAnalyzer

Analyzes text legibility on the images.

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.

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.

DocumentQualityThreshold

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

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

ImageFilterType

enum ~~ImageFilterType~~ : Enum<ImageFilterType>

Image filter types.

ImageProcessor

class ImageProcessor : Disposable

Class for applying chains of image processing operations.

PdfGenerator

interface PdfGenerator

Provides methods for PDF generation.

ScanbotPdfGenerator

class ScanbotPdfGenerator(context: Context, fileIOProcessor: FileIOProcessor, ocrGenerator: OcrPdfGenerator, documentStoreStrategy: DocumentStoreStrategy, blobManager: BlobManager, simpleComposer: SimpleComposer, ocrSettings: OcrSettings, sapManager: SapManager) : PdfGenerator

Provides methods for PDF generation