io.scanbot.sdk.genericdocument

Interface GenericDocumentRecognizer

All Known Implementing Classes:

DefaultGenericDocumentRecognizer, StubGenericDocumentRecognizer

public GenericDocumentRecognizer

Component to scan image, detect different documents of known types, perform image optimization, cropping and (optionally) fields detection and fields' data recognition

Method Detail

getAcceptedSharpnessScore

float getAcceptedSharpnessScore()

Accepted minimal sharpness score. Images with a score less than that will be rejected with GenericDocumentRecognitionResult.RecognitionStatus.ErrorTooBlurry.

Default is 0

0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.

setAcceptedSharpnessScore

void setAcceptedSharpnessScore(float p)

Accepted minimal sharpness score. Images with a score less than that will be rejected with GenericDocumentRecognitionResult.RecognitionStatus.ErrorTooBlurry.

Default is 0

0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.

getAcceptedDocumentTypes

@NotNull
java.util.List<io.scanbot.genericdocument.entity.RootDocumentType> getAcceptedDocumentTypes()

Accepted document types. All other document types will be ignored.

By default - RootDocumentType.ALL_TYPES

setAcceptedDocumentTypes

void setAcceptedDocumentTypes(@NotNull
                              java.util.List<? extends io.scanbot.genericdocument.entity.RootDocumentType> p)

Accepted document types. All other document types will be ignored.

By default - RootDocumentType.ALL_TYPES

scanBitmap

@Nullable
GenericDocumentRecognitionResult scanBitmap(@NotNull
                                                      android.graphics.Bitmap bitmap,
                                                      boolean shouldRecognize,
                                                      int orientation)

Scan the image to detect document and recognize data on it

Parameters:

bitmap - image

shouldRecognize - whether to recognize field and their data. Otherwise the component will only detect document on the image. Defaults to true

orientation - image orientation. Default is 0

scanJpeg

@Nullable
GenericDocumentRecognitionResult scanJpeg(@NotNull
                                                    kotlin.Array[] jpeg,
                                                    boolean shouldRecognize,
                                                    int orientation)

Scan the image to detect document and recognize data on it

Parameters:

jpeg - image in form of jpeg-encoded byte array

shouldRecognize - whether to recognize field and their data. Otherwise the component will only detect document on the image. Defaults to true

orientation - image orientation. Default is 0

scanNv21

@Nullable
GenericDocumentRecognitionResult scanNv21(@NotNull
                                                    kotlin.Array[] nv21,
                                                    int width,
                                                    int height,
                                                    int orientation,
                                                    @Nullable
                                                    android.graphics.Rect finderRect,
                                                    boolean shouldRecognize)

Scan the image to detect document and recognize data on it

Parameters:

nv21 - image in form of nv21-encoded byte array

width - image width, pixels

height - image height, pixels

orientation - image orientation. Default is 0

finderRect - if non-null - perform scanning only in given area. Default is null

shouldRecognize - whether to recognize field and their data. Otherwise the component will only detect document on the image. Defaults to true

clear

void clear()

Clears the result accumulation cache (for live detection)