io.scanbot.sdk.ocr.process

Class OcrResultBlock

io.scanbot.sdk.ocr.process.OcrResultBlock

public class OcrResultBlock

Part of the optical character recognitions result. Each block represents a text paragraph, a text line or a word and contains information about it, like the found text, the bounding box, where in the image the paragraph/line/word can be found, the confidence value and the type.

Field Detail

text

@JvmField
 @NotNull
public java.lang.String text

The recognized text within the receivers bounding box.

boundingBox

@JvmField
 @NotNull
public android.graphics.RectF boundingBox

The bounding box of the receiver in normalized unit coordinate space Left,

Top:(0.0, 0.0) - Right, Bottom(1.0, 1.0).Use the boundingBoxWithImageSize method to get the bounding box in absolute image coordinates.

boundingBoxWithImageSize

@JvmField
 @NotNull
public android.graphics.Rect boundingBoxWithImageSize

The bounding box of the receiver in absolute image coordinate system.

confidenceValue

@JvmField
public float confidenceValue

The confidence value describes how confident the OCR engine was when detecting the letters and words.

Ranges from 0.0 (not confident) to 100.0 (very confident).

blockType

@JvmField
 @NotNull
public io.scanbot.sdk.ocr.process.OcrResultBlock.OcrResultBlockType blockType

The type of the block.

enum OcrResultBlock.OcrResultBlockType.

See Also:

enum OcrResultBlock.OcrResultBlockType

Constructor Detail

OcrResultBlock

public OcrResultBlock(@NotNull
                      java.lang.String text,
                      @NotNull
                      android.graphics.RectF boundingBox,
                      @NotNull
                      android.graphics.Rect boundingBoxWithImageSize,
                      float confidenceValue,
                      @NotNull
                      io.scanbot.sdk.ocr.process.OcrResultBlock.OcrResultBlockType blockType)

Part of the optical character recognitions result. Each block represents a text paragraph, a text line or a word and contains information about it, like the found text, the bounding box, where in the image the paragraph/line/word can be found, the confidence value and the type.

Parameters:

text - The recognized text within the receivers bounding box.

boundingBox - The bounding box of the receiver in normalized unit coordinate space Left, Top:(0.0, 0.0) - Right, Bottom(1.0, 1.0).Use the boundingBoxWithImageSize method to get the bounding box in absolute image coordinates.

boundingBoxWithImageSize - The bounding box of the receiver in absolute image coordinate system.

confidenceValue - The confidence value describes how confident the OCR engine was when detecting the letters and words. Ranges from 0.0 (not confident) to 100.0 (very confident).

blockType - The type of the block. enum OcrResultBlock.OcrResultBlockType.

Method Detail

component1

@NotNull
public java.lang.String component1()

The recognized text within the receivers bounding box.

component2

@NotNull
public android.graphics.RectF component2()

The bounding box of the receiver in normalized unit coordinate space Left,

Top:(0.0, 0.0) - Right, Bottom(1.0, 1.0).Use the boundingBoxWithImageSize method to get the bounding box in absolute image coordinates.

component3

@NotNull
public android.graphics.Rect component3()

The bounding box of the receiver in absolute image coordinate system.

component4

public float component4()

The confidence value describes how confident the OCR engine was when detecting the letters and words.

Ranges from 0.0 (not confident) to 100.0 (very confident).

component5

@NotNull
public io.scanbot.sdk.ocr.process.OcrResultBlock.OcrResultBlockType component5()

The type of the block.

enum OcrResultBlock.OcrResultBlockType.

See Also:

enum OcrResultBlock.OcrResultBlockType

copy

@NotNull
public OcrResultBlock copy(@NotNull
                                    java.lang.String text,
                                    @NotNull
                                    android.graphics.RectF boundingBox,
                                    @NotNull
                                    android.graphics.Rect boundingBoxWithImageSize,
                                    float confidenceValue,
                                    @NotNull
                                    io.scanbot.sdk.ocr.process.OcrResultBlock.OcrResultBlockType blockType)

Part of the optical character recognitions result. Each block represents a text paragraph, a text line or a word and contains information about it, like the found text, the bounding box, where in the image the paragraph/line/word can be found, the confidence value and the type.

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)