org.bytedeco.tesseract

Class PageIterator

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tesseract.PageIterator

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

LTRResultIterator

@Namespace(value="tesseract")
 @NoOffset
 @Properties(inherit=tesseract.class)
public class PageIterator
extends Pointer

Class to iterate over tesseract page structure, providing access to all levels of the page hierarchy, without including any tesseract headers or having to handle any tesseract structures. WARNING! This class points to data held within the TessBaseAPI class, and therefore can only be used while the TessBaseAPI class still exists and has not been subjected to a call of Init, SetImage, Recognize, Clear, End DetectOS, or anything else that changes the internal PAGE_RES. See tesseract/publictypes.h for the definition of PageIteratorLevel. See also ResultIterator, derived from PageIterator, which adds in the ability to access OCR output with text-specific methods.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
PageIterator(PAGE_RES page_res, Tesseract tesseract, int scale, int scaled_yres, int rect_left, int rect_top, int rect_width, int rect_height) page_res and tesseract come directly from the BaseAPI.
PageIterator(PageIterator src) Page/ResultIterators may be copied! This makes it possible to iterate over all the objects at a lower level, while maintaining an iterator to objects at a higher level.
PageIterator(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	Baseline(int level, int[] x1, int[] y1, int[] x2, int[] y2)
boolean	Baseline(int level, IntBuffer x1, IntBuffer y1, IntBuffer x2, IntBuffer y2)
boolean	Baseline(int level, IntPointer x1, IntPointer y1, IntPointer x2, IntPointer y2) Returns the baseline of the current object at the given level.
void	Begin() Moves the iterator to point to the start of the page to begin an iteration.
org.bytedeco.leptonica.PTA	BlockPolygon() Returns the polygon outline of the current block.
int	BlockType() Returns the type of the current block.
boolean	BoundingBox(int level, int[] left, int[] top, int[] right, int[] bottom)
boolean	BoundingBox(int level, IntBuffer left, IntBuffer top, IntBuffer right, IntBuffer bottom)
boolean	BoundingBox(int level, int padding, int[] left, int[] top, int[] right, int[] bottom)
boolean	BoundingBox(int level, int padding, IntBuffer left, IntBuffer top, IntBuffer right, IntBuffer bottom)
boolean	BoundingBox(int level, int padding, IntPointer left, IntPointer top, IntPointer right, IntPointer bottom)
boolean	BoundingBox(int level, IntPointer left, IntPointer top, IntPointer right, IntPointer bottom) Returns the bounding rectangle of the current object at the given level.
boolean	BoundingBoxInternal(int level, int[] left, int[] top, int[] right, int[] bottom)
boolean	BoundingBoxInternal(int level, IntBuffer left, IntBuffer top, IntBuffer right, IntBuffer bottom)
boolean	BoundingBoxInternal(int level, IntPointer left, IntPointer top, IntPointer right, IntPointer bottom) Returns the bounding rectangle of the object in a coordinate system of the working image rectangle having its origin at (rect_left_, rect_top_) with respect to the original image and is scaled by a factor scale_.
int	Cmp(PageIterator other) Returns whether this iterator is positioned before other: -1 equal to other: 0 after other: 1
boolean	Empty(int level) Returns whether there is no object of a given level.
org.bytedeco.leptonica.PIX	GetBinaryImage(int level) Returns a binary image of the current object at the given level.
org.bytedeco.leptonica.PIX	GetImage(int level, int padding, org.bytedeco.leptonica.PIX original_img, int[] left, int[] top)
org.bytedeco.leptonica.PIX	GetImage(int level, int padding, org.bytedeco.leptonica.PIX original_img, IntBuffer left, IntBuffer top)
org.bytedeco.leptonica.PIX	GetImage(int level, int padding, org.bytedeco.leptonica.PIX original_img, IntPointer left, IntPointer top) Returns an image of the current object at the given level in greyscale if available in the input.
boolean	IsAtBeginningOf(int level) Returns true if the iterator is at the start of an object at the given level.
boolean	IsAtFinalElement(int level, int element) Returns whether the iterator is positioned at the last element in a given level.
boolean	IsWithinFirstTextlineOfParagraph() Return whether this iterator points anywhere in the first textline of a paragraph.
boolean	Next(int level) Moves to the start of the next object at the given level in the page hierarchy, and returns false if the end of the page was reached.
void	Orientation(int[] orientation, int[] writing_direction, int[] textline_order, float[] deskew_angle)
void	Orientation(IntBuffer orientation, IntBuffer writing_direction, IntBuffer textline_order, FloatBuffer deskew_angle)
void	Orientation(IntPointer orientation, IntPointer writing_direction, IntPointer textline_order, FloatPointer deskew_angle) Returns orientation for the block the iterator points to.
void	ParagraphInfo(int[] justification, boolean[] is_list_item, boolean[] is_crown, int[] first_line_indent)
void	ParagraphInfo(int[] justification, BoolPointer is_list_item, BoolPointer is_crown, int[] first_line_indent)
void	ParagraphInfo(IntBuffer justification, boolean[] is_list_item, boolean[] is_crown, IntBuffer first_line_indent)
void	ParagraphInfo(IntBuffer justification, BoolPointer is_list_item, BoolPointer is_crown, IntBuffer first_line_indent)
void	ParagraphInfo(IntPointer justification, boolean[] is_list_item, boolean[] is_crown, IntPointer first_line_indent)
void	ParagraphInfo(IntPointer justification, BoolPointer is_list_item, BoolPointer is_crown, IntPointer first_line_indent) Returns information about the current paragraph, if available.
boolean	PositionedAtSameWord(PAGE_RES_IT other) Are we positioned at the same location as other?
PageIterator	put(PageIterator src)
void	RestartParagraph() Moves the iterator to the beginning of the paragraph.
void	RestartRow() Moves the iterator to the beginning of the text line.
void	RowAttributes(float[] row_height, float[] descenders, float[] ascenders)
void	RowAttributes(FloatBuffer row_height, FloatBuffer descenders, FloatBuffer ascenders)
void	RowAttributes(FloatPointer row_height, FloatPointer descenders, FloatPointer ascenders)
void	SetBoundingBoxComponents(boolean include_upper_dots, boolean include_lower_dots) Controls what to include in a bounding box.
boolean	SetWordBlamerBundle(BlamerBundle blamer_bundle)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageIterator

public PageIterator(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

PageIterator

public PageIterator(PAGE_RES page_res,
                    Tesseract tesseract,
                    int scale,
                    int scaled_yres,
                    int rect_left,
                    int rect_top,
                    int rect_width,
                    int rect_height)

page_res and tesseract come directly from the BaseAPI. The rectangle parameters are copied indirectly from the Thresholder, via the BaseAPI. They represent the coordinates of some rectangle in an original image (in top-left-origin coordinates) and therefore the top-left needs to be added to any output boxes in order to specify coordinates in the original image. See TessBaseAPI::SetRectangle. The scale and scaled_yres are in case the Thresholder scaled the image rectangle prior to thresholding. Any coordinates in tesseract's image must be divided by scale before adding (rect_left, rect_top). The scaled_yres indicates the effective resolution of the binary image that tesseract has been given by the Thresholder. After the constructor, Begin has already been called.

PageIterator

public PageIterator(@Const @ByRef
                    PageIterator src)

Page/ResultIterators may be copied! This makes it possible to iterate over all the objects at a lower level, while maintaining an iterator to objects at a higher level. These constructors DO NOT CALL Begin, so iterations will continue from the location of src.

Method Detail

put

@Const
 @ByRef
 @Name(value="operator =")
public PageIterator put(@Const @ByRef
                                                                     PageIterator src)

PositionedAtSameWord

@Cast(value="bool")
public boolean PositionedAtSameWord(@Const
                                                         PAGE_RES_IT other)

Are we positioned at the same location as other?

Begin

public void Begin()

Moves the iterator to point to the start of the page to begin an iteration.

RestartParagraph

public void RestartParagraph()

Moves the iterator to the beginning of the paragraph. This class implements this functionality by moving it to the zero indexed blob of the first (leftmost) word on the first row of the paragraph.

IsWithinFirstTextlineOfParagraph

@Cast(value="bool")
public boolean IsWithinFirstTextlineOfParagraph()

Return whether this iterator points anywhere in the first textline of a paragraph.

RestartRow

public void RestartRow()

Moves the iterator to the beginning of the text line. This class implements this functionality by moving it to the zero indexed blob of the first (leftmost) word of the row.

Next

@Cast(value="bool")
public boolean Next(@Cast(value="tesseract::PageIteratorLevel")
                                         int level)

Moves to the start of the next object at the given level in the page hierarchy, and returns false if the end of the page was reached. NOTE that RIL_SYMBOL will skip non-text blocks, but all other PageIteratorLevel level values will visit each non-text block once. Think of non text blocks as containing a single para, with a single line, with a single imaginary word. Calls to Next with different levels may be freely intermixed. This function iterates words in right-to-left scripts correctly, if the appropriate language has been loaded into Tesseract.

IsAtBeginningOf

@Cast(value="bool")
public boolean IsAtBeginningOf(@Cast(value="tesseract::PageIteratorLevel")
                                                    int level)

Returns true if the iterator is at the start of an object at the given level. For instance, suppose an iterator it is pointed to the first symbol of the first word of the third line of the second paragraph of the first block in a page, then: it.IsAtBeginningOf(RIL_BLOCK) = false it.IsAtBeginningOf(RIL_PARA) = false it.IsAtBeginningOf(RIL_TEXTLINE) = true it.IsAtBeginningOf(RIL_WORD) = true it.IsAtBeginningOf(RIL_SYMBOL) = true

IsAtFinalElement

@Cast(value="bool")
public boolean IsAtFinalElement(@Cast(value="tesseract::PageIteratorLevel")
                                                     int level,
                                                     @Cast(value="tesseract::PageIteratorLevel")
                                                     int element)

Returns whether the iterator is positioned at the last element in a given level. (e.g. the last word in a line, the last line in a block) Here's some two-paragraph example text. It starts off innocuously enough but quickly turns bizarre. The author inserts a cornucopia of words to guard against confused references. Now take an iterator it pointed to the start of "bizarre." it.IsAtFinalElement(RIL_PARA, RIL_SYMBOL) = false it.IsAtFinalElement(RIL_PARA, RIL_WORD) = true it.IsAtFinalElement(RIL_BLOCK, RIL_WORD) = false

Cmp

public int Cmp(@Const @ByRef
               PageIterator other)

Returns whether this iterator is positioned before other: -1 equal to other: 0 after other: 1

SetBoundingBoxComponents

public void SetBoundingBoxComponents(@Cast(value="bool")
                                     boolean include_upper_dots,
                                     @Cast(value="bool")
                                     boolean include_lower_dots)

Controls what to include in a bounding box. Bounding boxes of all levels between RIL_WORD and RIL_BLOCK can include or exclude potential diacritics. Between layout analysis and recognition, it isn't known where all diacritics belong, so this control is used to include or exclude some diacritics that are above or below the main body of the word. In most cases where the placement is obvious, and after recognition, it doesn't make as much difference, as the diacritics will already be included in the word.

BoundingBox

@Cast(value="bool")
public boolean BoundingBox(@Cast(value="tesseract::PageIteratorLevel")
                                                int level,
                                                IntPointer left,
                                                IntPointer top,
                                                IntPointer right,
                                                IntPointer bottom)

Returns the bounding rectangle of the current object at the given level. See comment on coordinate system above. Returns false if there is no such object at the current position. The returned bounding box is guaranteed to match the size and position of the image returned by GetBinaryImage, but may clip foreground pixels from a grey image. The padding argument to GetImage can be used to expand the image to include more foreground pixels. See GetImage below.

BoundingBox

@Cast(value="bool")
public boolean BoundingBox(@Cast(value="tesseract::PageIteratorLevel")
                                                int level,
                                                IntBuffer left,
                                                IntBuffer top,
                                                IntBuffer right,
                                                IntBuffer bottom)

BoundingBox

@Cast(value="bool")
public boolean BoundingBox(@Cast(value="tesseract::PageIteratorLevel")
                                                int level,
                                                int[] left,
                                                int[] top,
                                                int[] right,
                                                int[] bottom)

BoundingBox

@Cast(value="bool")
public boolean BoundingBox(@Cast(value="tesseract::PageIteratorLevel")
                                                int level,
                                                int padding,
                                                IntPointer left,
                                                IntPointer top,
                                                IntPointer right,
                                                IntPointer bottom)

BoundingBox

@Cast(value="bool")
public boolean BoundingBox(@Cast(value="tesseract::PageIteratorLevel")
                                                int level,
                                                int padding,
                                                IntBuffer left,
                                                IntBuffer top,
                                                IntBuffer right,
                                                IntBuffer bottom)

BoundingBox

@Cast(value="bool")
public boolean BoundingBox(@Cast(value="tesseract::PageIteratorLevel")
                                                int level,
                                                int padding,
                                                int[] left,
                                                int[] top,
                                                int[] right,
                                                int[] bottom)

BoundingBoxInternal

@Cast(value="bool")
public boolean BoundingBoxInternal(@Cast(value="tesseract::PageIteratorLevel")
                                                        int level,
                                                        IntPointer left,
                                                        IntPointer top,
                                                        IntPointer right,
                                                        IntPointer bottom)

Returns the bounding rectangle of the object in a coordinate system of the working image rectangle having its origin at (rect_left_, rect_top_) with respect to the original image and is scaled by a factor scale_.

BoundingBoxInternal

@Cast(value="bool")
public boolean BoundingBoxInternal(@Cast(value="tesseract::PageIteratorLevel")
                                                        int level,
                                                        IntBuffer left,
                                                        IntBuffer top,
                                                        IntBuffer right,
                                                        IntBuffer bottom)

BoundingBoxInternal

@Cast(value="bool")
public boolean BoundingBoxInternal(@Cast(value="tesseract::PageIteratorLevel")
                                                        int level,
                                                        int[] left,
                                                        int[] top,
                                                        int[] right,
                                                        int[] bottom)

Empty

@Cast(value="bool")
public boolean Empty(@Cast(value="tesseract::PageIteratorLevel")
                                          int level)

Returns whether there is no object of a given level.

BlockType

@Cast(value="tesseract::PolyBlockType")
public int BlockType()

Returns the type of the current block. See tesseract/publictypes.h for PolyBlockType.

BlockPolygon

public org.bytedeco.leptonica.PTA BlockPolygon()

Returns the polygon outline of the current block. The returned Pta must be ptaDestroy-ed after use. Note that the returned Pta lists the vertices of the polygon, and the last edge is the line segment between the last point and the first point. nullptr will be returned if the iterator is at the end of the document or layout analysis was not used.

GetBinaryImage

public org.bytedeco.leptonica.PIX GetBinaryImage(@Cast(value="tesseract::PageIteratorLevel")
                                                 int level)

Returns a binary image of the current object at the given level. The position and size match the return from BoundingBoxInternal, and so this could be upscaled with respect to the original input image. Use pixDestroy to delete the image after use.

GetImage

public org.bytedeco.leptonica.PIX GetImage(@Cast(value="tesseract::PageIteratorLevel")
                                           int level,
                                           int padding,
                                           org.bytedeco.leptonica.PIX original_img,
                                           IntPointer left,
                                           IntPointer top)

Returns an image of the current object at the given level in greyscale if available in the input. To guarantee a binary image use BinaryImage. NOTE that in order to give the best possible image, the bounds are expanded slightly over the binary connected component, by the supplied padding, so the top-left position of the returned image is returned in (left,top). These will most likely not match the coordinates returned by BoundingBox. If you do not supply an original image, you will get a binary one. Use pixDestroy to delete the image after use.

GetImage

public org.bytedeco.leptonica.PIX GetImage(@Cast(value="tesseract::PageIteratorLevel")
                                           int level,
                                           int padding,
                                           org.bytedeco.leptonica.PIX original_img,
                                           IntBuffer left,
                                           IntBuffer top)

GetImage

public org.bytedeco.leptonica.PIX GetImage(@Cast(value="tesseract::PageIteratorLevel")
                                           int level,
                                           int padding,
                                           org.bytedeco.leptonica.PIX original_img,
                                           int[] left,
                                           int[] top)

Baseline

@Cast(value="bool")
public boolean Baseline(@Cast(value="tesseract::PageIteratorLevel")
                                             int level,
                                             IntPointer x1,
                                             IntPointer y1,
                                             IntPointer x2,
                                             IntPointer y2)

Returns the baseline of the current object at the given level. The baseline is the line that passes through (x1, y1) and (x2, y2). WARNING: with vertical text, baselines may be vertical! Returns false if there is no baseline at the current position.

Baseline

@Cast(value="bool")
public boolean Baseline(@Cast(value="tesseract::PageIteratorLevel")
                                             int level,
                                             IntBuffer x1,
                                             IntBuffer y1,
                                             IntBuffer x2,
                                             IntBuffer y2)

Baseline

@Cast(value="bool")
public boolean Baseline(@Cast(value="tesseract::PageIteratorLevel")
                                             int level,
                                             int[] x1,
                                             int[] y1,
                                             int[] x2,
                                             int[] y2)

RowAttributes

public void RowAttributes(FloatPointer row_height,
                          FloatPointer descenders,
                          FloatPointer ascenders)

RowAttributes

public void RowAttributes(FloatBuffer row_height,
                          FloatBuffer descenders,
                          FloatBuffer ascenders)

RowAttributes

public void RowAttributes(float[] row_height,
                          float[] descenders,
                          float[] ascenders)

Orientation

public void Orientation(@Cast(value="tesseract::Orientation*")
                        IntPointer orientation,
                        @Cast(value="tesseract::WritingDirection*")
                        IntPointer writing_direction,
                        @Cast(value="tesseract::TextlineOrder*")
                        IntPointer textline_order,
                        FloatPointer deskew_angle)

Returns orientation for the block the iterator points to. orientation, writing_direction, textline_order: see publictypes.h deskew_angle: after rotating the block so the text orientation is upright, how many radians does one have to rotate the block anti-clockwise for it to be level? -Pi/4 <= deskew_angle <= Pi/4

Orientation

public void Orientation(@Cast(value="tesseract::Orientation*")
                        IntBuffer orientation,
                        @Cast(value="tesseract::WritingDirection*")
                        IntBuffer writing_direction,
                        @Cast(value="tesseract::TextlineOrder*")
                        IntBuffer textline_order,
                        FloatBuffer deskew_angle)

Orientation

public void Orientation(@Cast(value="tesseract::Orientation*")
                        int[] orientation,
                        @Cast(value="tesseract::WritingDirection*")
                        int[] writing_direction,
                        @Cast(value="tesseract::TextlineOrder*")
                        int[] textline_order,
                        float[] deskew_angle)

ParagraphInfo

public void ParagraphInfo(@Cast(value="tesseract::ParagraphJustification*")
                          IntPointer justification,
                          @Cast(value="bool*")
                          BoolPointer is_list_item,
                          @Cast(value="bool*")
                          BoolPointer is_crown,
                          IntPointer first_line_indent)

Returns information about the current paragraph, if available. justification - LEFT if ragged right, or fully justified and script is left-to-right. RIGHT if ragged left, or fully justified and script is right-to-left. unknown if it looks like source code or we have very few lines. is_list_item - true if we believe this is a member of an ordered or unordered list. is_crown - true if the first line of the paragraph is aligned with the other lines of the paragraph even though subsequent paragraphs have first line indents. This typically indicates that this is the continuation of a previous paragraph or that it is the very first paragraph in the chapter. first_line_indent - For LEFT aligned paragraphs, the first text line of paragraphs of this kind are indented this many pixels from the left edge of the rest of the paragraph. for RIGHT aligned paragraphs, the first text line of paragraphs of this kind are indented this many pixels from the right edge of the rest of the paragraph. NOTE 1: This value may be negative. NOTE 2: if *is_crown == true, the first line of this paragraph is actually flush, and first_line_indent is set to the "common" first_line_indent for subsequent paragraphs in this block of text.

ParagraphInfo

public void ParagraphInfo(@Cast(value="tesseract::ParagraphJustification*")
                          IntBuffer justification,
                          @Cast(value="bool*")
                          boolean[] is_list_item,
                          @Cast(value="bool*")
                          boolean[] is_crown,
                          IntBuffer first_line_indent)

ParagraphInfo

public void ParagraphInfo(@Cast(value="tesseract::ParagraphJustification*")
                          int[] justification,
                          @Cast(value="bool*")
                          BoolPointer is_list_item,
                          @Cast(value="bool*")
                          BoolPointer is_crown,
                          int[] first_line_indent)

ParagraphInfo

public void ParagraphInfo(@Cast(value="tesseract::ParagraphJustification*")
                          IntPointer justification,
                          @Cast(value="bool*")
                          boolean[] is_list_item,
                          @Cast(value="bool*")
                          boolean[] is_crown,
                          IntPointer first_line_indent)

ParagraphInfo

public void ParagraphInfo(@Cast(value="tesseract::ParagraphJustification*")
                          IntBuffer justification,
                          @Cast(value="bool*")
                          BoolPointer is_list_item,
                          @Cast(value="bool*")
                          BoolPointer is_crown,
                          IntBuffer first_line_indent)

ParagraphInfo

public void ParagraphInfo(@Cast(value="tesseract::ParagraphJustification*")
                          int[] justification,
                          @Cast(value="bool*")
                          boolean[] is_list_item,
                          @Cast(value="bool*")
                          boolean[] is_crown,
                          int[] first_line_indent)

SetWordBlamerBundle

@Cast(value="bool")
public boolean SetWordBlamerBundle(BlamerBundle blamer_bundle)