com.microblink.blinkinput.entities.ocrengine.deep

Class DeepOCREngineOptions

java.lang.Object

com.microblink.blinkinput.entities.ocrengine.AbstractOCREngineOptions

com.microblink.blinkinput.entities.ocrengine.deep.DeepOCREngineOptions

All Implemented Interfaces:

android.os.Parcelable

public final class DeepOCREngineOptions
extends AbstractOCREngineOptions

Options used in Deep OCR.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator, android.os.Parcelable.Creator

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator	CREATOR Parcelable creator.

Fields inherited from class com.microblink.blinkinput.entities.ocrengine.AbstractOCREngineOptions

mNativeContext

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
DeepOCREngineOptions() Default constructor.
DeepOCREngineOptions(long nativeContext, java.lang.Object keep) Constructor from native object.

Method Summary

Modifier and Type	Method and Description
DeepOCREngineOptions	clone() Returns a copy of DeepOCREngineOptions object.
protected void	deserializeNative(byte[] bytes)
float	getMaximumLineHeight() Returns the maximum height of the line of text given in float from range <0, 1>, which represents height percentage of the input image that is being processed.
float	getMinimumCharHeight() Returns the minimum height of char that can be classified given in float from range <0, 1>, which represents height percentage of the input image that is being processed.
float	getMinimumLineHeight() Returns the minimum height of the line of text given in float from range <0, 1>, which represents height percentage of the input image that is being processed.
DeepOCRModel	getOCRModel() Returns the current Deep OCR model.
protected byte[]	serializeNative()
DeepOCREngineOptions	setMaximumLineHeight(float maximumLineHeight) Sets the maximum height of the line of text given in float from range <0, 1>, which represents height percentage of the input image that is being processed.
DeepOCREngineOptions	setMinimumCharHeight(float minimumCharHeight) Sets the minimum height of the char that can be classified given in float from range <0, 1>, which represents height percentage of the input image that is being processed.
DeepOCREngineOptions	setMinimumLineHeight(float minimumLineHeight) Sets the minimum height of the line of text given in float from range <0, 1>, which represents height percentage of the input image that is being processed.
DeepOCREngineOptions	setOCRModel(DeepOCRModel model) Specifies the Deep OCR model that will be used.
protected void	terminateNative(long nativeContext)

Methods inherited from class com.microblink.blinkinput.entities.ocrengine.AbstractOCREngineOptions

describeContents, finalize, getMaximumAllowedCharRecognitionVariants, getMaximumCharsExpected, getNativeContext, isColorDropoutEnabled, setColorDropoutEnabled, setMaximumAllowedCharRecognitionVariants, setMaximumCharsExpected, writeToParcel

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

@NonNull
public static android.os.Parcelable.Creator CREATOR

Parcelable creator.

Constructor Detail

DeepOCREngineOptions

public DeepOCREngineOptions()

Default constructor.

DeepOCREngineOptions

public DeepOCREngineOptions(long nativeContext,
                            @Nullable
                            java.lang.Object keep)

Constructor from native object.

Parameters:

nativeContext - Native engine options object.

keep - Owner of the native engine options object.

Method Detail

clone

@NonNull
public DeepOCREngineOptions clone()

Returns a copy of DeepOCREngineOptions object.

Overrides:

clone in class java.lang.Object

Returns:

a copy

terminateNative

protected void terminateNative(long nativeContext)

Specified by:

terminateNative in class AbstractOCREngineOptions

serializeNative

@NonNull
protected byte[] serializeNative()

Specified by:

serializeNative in class AbstractOCREngineOptions

deserializeNative

protected void deserializeNative(@NonNull
                                 byte[] bytes)

Specified by:

deserializeNative in class AbstractOCREngineOptions

getMinimumLineHeight

public final float getMinimumLineHeight()

Returns the minimum height of the line of text given in float from range <0, 1>, which represents height percentage of the input image that is being processed. All lines smaller than this value are ignored. Line height is defined as height of largest character in line.

Returns:

minimum height of the line

setMinimumLineHeight

@NonNull
public final DeepOCREngineOptions setMinimumLineHeight(float minimumLineHeight)

Sets the minimum height of the line of text given in float from range <0, 1>, which represents height percentage of the input image that is being processed. All chars smaller than this value will be ignored.

Parameters:

minimumLineHeight - minimum height of the line from range <0, 1>

Returns:

this object, to support chaining of operations.

getMaximumLineHeight

public final float getMaximumLineHeight()

Returns the maximum height of the line of text given in float from range <0, 1>, which represents height percentage of the input image that is being processed. All chars larger than this value are ignored.

Returns:

maximum height of the line

setMaximumLineHeight

@NonNull
public final DeepOCREngineOptions setMaximumLineHeight(float maximumLineHeight)

Sets the maximum height of the line of text given in float from range <0, 1>, which represents height percentage of the input image that is being processed. All chars larger than this value will be ignored.

Parameters:

maximumLineHeight - maximum height of the line

Returns:

this object, to support chaining of operations.

getMinimumCharHeight

public final float getMinimumCharHeight()

Returns the minimum height of char that can be classified given in float from range <0, 1>, which represents height percentage of the input image that is being processed. All chars smaller than this value are ignored.

Returns:

minimum height of the char

setMinimumCharHeight

@NonNull
public final DeepOCREngineOptions setMinimumCharHeight(float minimumCharHeight)

Sets the minimum height of the char that can be classified given in float from range <0, 1>, which represents height percentage of the input image that is being processed. All chars smaller than this value are ignored. Unlike DeepOCREngineOptions.setMinimumLineHeight(float), this value refers to individual chars, while DeepOCREngineOptions.setMinimumLineHeight(float) refers to line height, which equals to height of largest char in line.

Parameters:

minimumCharHeight - minimum height of the char

Returns:

this object, to support chaining of operations

setOCRModel

@NonNull
public DeepOCREngineOptions setOCRModel(@NonNull
                                                 DeepOCRModel model)

Specifies the Deep OCR model that will be used. Deep OCR model defines how OCR is performed, which characted can be recognized and which types of images are supported.

By default, it is set to DeepOCRModel.BlinkInput

Parameters:

model - Desired Deep OCR model that will be used.

Returns:

this object, to support chaining of operations

getOCRModel

@NonNull
public DeepOCRModel getOCRModel()

Returns the current Deep OCR model. See DeepOCREngineOptions.setOCRModel(DeepOCRModel).

Returns:

current Deep OCR model.