com.microblink.blinkinput.entities.ocrengine

Class AbstractOCREngineOptions

java.lang.Object

com.microblink.blinkinput.entities.ocrengine.AbstractOCREngineOptions

All Implemented Interfaces:

android.os.Parcelable

Direct Known Subclasses:

BlinkOCREngineOptions, DeepOCREngineOptions

public abstract class AbstractOCREngineOptions
extends java.lang.Object
implements android.os.Parcelable

Options used in OCR. Shared between BlinkOCREngineOptions and DeepOCREngineOptions

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
protected long	mNativeContext

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOCREngineOptions(long nativeContext, java.lang.Object keep)
protected	AbstractOCREngineOptions(long nativeContext, android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
protected abstract void	deserializeNative(byte[] bytes)
protected void	finalize()
int	getMaximumAllowedCharRecognitionVariants() Returns the maximum allowed number of char recognition variants OCR engine will produce for each OcrChar.
int	getMaximumCharsExpected() Returns the maximum number of chars expected in the image.
long	getNativeContext()
boolean	isColorDropoutEnabled() Returns true if the additional image processing which drops background colors will be performed.
protected abstract byte[]	serializeNative()
AbstractOCREngineOptions	setColorDropoutEnabled(boolean colorDropoutEnabled) Specifies if the additional image processing which drops the background colors should be performed.
AbstractOCREngineOptions	setMaximumAllowedCharRecognitionVariants(int maximumAllowedCharRecognitionVariants) Sets the maximum allowed number of char recognition variants OCR engine will produce for each OcrChar.
AbstractOCREngineOptions	setMaximumCharsExpected(int maximumCharsExpected) Sets the maximum number of chars expected in the image.
protected abstract void	terminateNative(long nativeContext)
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

mNativeContext

protected long mNativeContext

Constructor Detail

AbstractOCREngineOptions

protected AbstractOCREngineOptions(long nativeContext,
                                   @Nullable
                                   java.lang.Object keep)

AbstractOCREngineOptions

protected AbstractOCREngineOptions(long nativeContext,
                                   @NonNull
                                   android.os.Parcel in)

Method Detail

getNativeContext

public final long getNativeContext()

getMaximumAllowedCharRecognitionVariants

public final int getMaximumAllowedCharRecognitionVariants()

Returns the maximum allowed number of char recognition variants OCR engine will produce for each OcrChar.

Returns:

the maximum allowed number of char recognition variants OCR engine will produce for each OcrChar.

setMaximumAllowedCharRecognitionVariants

@NonNull
public final AbstractOCREngineOptions setMaximumAllowedCharRecognitionVariants(int maximumAllowedCharRecognitionVariants)

Sets the maximum allowed number of char recognition variants OCR engine will produce for each OcrChar. By default, OCR engine will not produce char recognition variants (i.e. maximum allowed char recognition variants is 0). By setting this number to higher values, you can create more flexible OCR postprocessing algorithm because more char recognition variants will be available to you. However, setting it too high can lead to significant performance problems.

Parameters:

maximumAllowedCharRecognitionVariants - maximum allowed number of char recognition variants OCR engine will produce for each OcrChar

Returns:

this object, to support chaining of operations.

See Also:

OcrChar

getMaximumCharsExpected

public final int getMaximumCharsExpected()

Returns the maximum number of chars expected in the image.

Returns:

the maximum number of chars expected in the image.

setMaximumCharsExpected

@NonNull
public final AbstractOCREngineOptions setMaximumCharsExpected(int maximumCharsExpected)

Sets the maximum number of chars expected in the image. Setting this value can speed up the OCR processing because all images with more chars than specified will be ignored (becuase in most cases they are noise). Please note that noise characters are also counted. This means that if you expect 17 characters and usually get 25 characters (8 of which are noise), setting this to 17 will cause to return empty OCR result (because 25 characters is more than expected 17, even though 8 characters are noise). Use this option solely to increase OCR speed. This option will not increase OCR accuracy.

Parameters:

maximumCharsExpected - the maximum number of chars expected in the image.

Returns:

this object, to support chaining of operations.

isColorDropoutEnabled

public final boolean isColorDropoutEnabled()

Returns true if the additional image processing which drops background colors will be performed.

Returns:

true if the additional image processing which drops background colors will be performed.

setColorDropoutEnabled

@NonNull
public final AbstractOCREngineOptions setColorDropoutEnabled(boolean colorDropoutEnabled)

Specifies if the additional image processing which drops the background colors should be performed.

Use this if you have black text on color backgrounds. If you have black text on white background, using this is not needed as it slows down processing. If you have color text, don't use it at all because color dropout will remove the text.

Parameters:

colorDropoutEnabled - whether dropping of colors from image should be performed

Returns:

this object, to support chaining of operations.

finalize

protected final void finalize()
                       throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

terminateNative

protected abstract void terminateNative(long nativeContext)

serializeNative

@NonNull
protected abstract byte[] serializeNative()

deserializeNative

protected abstract void deserializeNative(@NonNull
                                          byte[] bytes)

describeContents

public final int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public final void writeToParcel(@NonNull
                                android.os.Parcel dest,
                                int flags)

Specified by:

writeToParcel in interface android.os.Parcelable