io.scanbot.sdk.hicscanner

Interface HealthInsuranceCardScanner

All Known Implementing Classes:

DefaultHealthInsuranceCardScanner, StubHealthInsuranceCardScanner

public HealthInsuranceCardScanner

Recognizer for German-issued European health insurance cards (EHIC), a.k.a. elektronische Gesundheitskarten (eGK). The recognizer performs validation on the result that is specific to German cards and returns a failure result if any of the fields that can be validated fail validation. NOTE: In order to operate, this class requires tesseract languages and trained data to be present in the application bundle.

Method Detail

reinitWithValidationType

@Deprecated
void reinitWithValidationType(@NotNull
                                          io.scanbot.hicscanner.HealthInsuranceCardValidationType validationType)

Deprecated.

Init HealthInsuranceCardScanner with another validation type, by default validation type set up into HealthInsuranceCardValidationType.ValidationAutoSupported

Parameters:

validationType - HealthInsuranceCardValidationType type of validation for HIC cards

setValidationType

void setValidationType(@NotNull
                       io.scanbot.hicscanner.HealthInsuranceCardValidationType validationType)

Set new validation type in HealthInsuranceCardScanner, by default validation type set up into HealthInsuranceCardValidationType.ValidationAutoSupported

Parameters:

validationType - HealthInsuranceCardValidationType type of validation for HIC cards

recognize

@Nullable
io.scanbot.hicscanner.model.HealthInsuranceCardRecognitionResult recognize(@NotNull
                                                                                     kotlin.Array[] image,
                                                                                     int width,
                                                                                     int height,
                                                                                     int orientation)

Extract data from EHIC in an N21 format image given as an byte array.

Parameters:

image - An N21 format image containing an EHIC on a clean background.

width - Image width.

height - Image height.

orientation - Image orientation in degrees.

Returns:

Recognizer result. Null if recognition failed or validation is unsuccessful.

recognizeWithFinderOverlay

@Nullable
io.scanbot.hicscanner.model.HealthInsuranceCardRecognitionResult recognizeWithFinderOverlay(@NotNull
                                                                                                      kotlin.Array[] image,
                                                                                                      int width,
                                                                                                      int height,
                                                                                                      int orientation,
                                                                                                      @NotNull
                                                                                                      android.graphics.Rect finderRect)

Extract data from EHIC in an N21 format image given as an byte array in specified finder overlay rect

Parameters:

image - An N21 format image containing an EHIC on a clean background.

width - Image width.

height - Image height.

orientation - Image orientation in degrees.

finderRect - Image scanning area.

Returns:

recognized data

recognizeJPEG

@Nullable
io.scanbot.hicscanner.model.HealthInsuranceCardRecognitionResult recognizeJPEG(@NotNull
                                                                                         kotlin.Array[] image,
                                                                                         int width,
                                                                                         int height,
                                                                                         int orientation)

Extract data from EHIC in an JPEG image given as an byte array.

Parameters:

image - An JPEG format image containing an EHIC on a clean background.

width - Image width.

height - Image height.

orientation - Image orientation in degrees.

Returns:

Recognizer result. Null if recognition failed or validation is unsuccessful.

recognizeBitmap

@Nullable
io.scanbot.hicscanner.model.HealthInsuranceCardRecognitionResult recognizeBitmap(@NotNull
                                                                                           android.graphics.Bitmap image,
                                                                                           int orientation)

Extract data from EHIC in an image given as Bitmap.

Parameters:

image - Bitmap containing an EHIC on a clean background.

orientation - Image orientation in degrees.

Returns:

Recognizer result. Null if recognition failed or validation is unsuccessful.

detectAndRecognize

@Nullable
io.scanbot.hicscanner.model.HealthInsuranceCardRecognitionResult detectAndRecognize(@NotNull
                                                                                              kotlin.Array[] image,
                                                                                              int width,
                                                                                              int height,
                                                                                              int orientation)

Detect and extract data from EHIC in an N21 format image given as an byte array.

Parameters:

image - An N21 format image containing an EHIC on a clean background.

width - Image width.

height - Image height.

orientation - Image orientation in degrees.

Returns:

Recognizer result. Null if recognition failed or validation is unsuccessful.

detectAndRecognizeWithFinderOverlay

@Nullable
io.scanbot.hicscanner.model.HealthInsuranceCardRecognitionResult detectAndRecognizeWithFinderOverlay(@NotNull
                                                                                                               kotlin.Array[] image,
                                                                                                               int width,
                                                                                                               int height,
                                                                                                               int orientation,
                                                                                                               @NotNull
                                                                                                               android.graphics.Rect finderRect)

Detect and extract data from EHIC in an N21 format image given as an byte array in specified finder overlay rect

Parameters:

image - An N21 format image containing an EHIC on a clean background.

width - Image width.

height - Image height.

orientation - Image orientation in degrees.

finderRect - Image scanning area.

Returns:

recognized data

detectAndRecognizeJPEG

@Nullable
io.scanbot.hicscanner.model.HealthInsuranceCardRecognitionResult detectAndRecognizeJPEG(@NotNull
                                                                                                  kotlin.Array[] image,
                                                                                                  int width,
                                                                                                  int height,
                                                                                                  int orientation)

Detect and extract data from EHIC in an JPEG image given as an byte array.

Parameters:

image - An JPEG format image containing an EHIC on a clean background.

width - Image width.

height - Image height.

orientation - Image orientation in degrees.

Returns:

Recognizer result. Null if recognition failed or validation is unsuccessful.

detectAndRecognizeBitmap

@Nullable
io.scanbot.hicscanner.model.HealthInsuranceCardRecognitionResult detectAndRecognizeBitmap(@NotNull
                                                                                                    android.graphics.Bitmap image,
                                                                                                    int orientation)

Detect and extract data from EHIC in an image given as Bitmap.

Parameters:

image - Bitmap containing an EHIC on a clean background.

orientation - Image orientation in degrees.

Returns:

Recognizer result. Null if recognition failed or validation is unsuccessful.