PDFlib Text Extraction Toolkit (TET) Manual

Table 10.5 Page options for TET_open_page( ) and TET_process_page( )
option
docstyle
excludebox
granularity
includebox
fontsizerange
ignoreinvisibletext
imageanalysis
layoutanalysis
layouteffort
skipengines
structureanalysis
description
(Keyword) A hint which will be used by the layout detection engine to select various parameters. These
parameters will optimize layout detection for situations where the input document belongs to one of
the following classes:
book Typical book
business Business documents
fancy Fancy pages with complex layout
forms Structured forms
generic The most general document class without any further qualification.
magazines Magazine articles
papers Newspaper
science Scientific article
searchengine
The application is a search engine or similar, and mainly interested in retrieving the word list
for the page as fast as possible. Table and page structure recognition will be disabled.
(List of rectangles) Exclude the combined area of the specified rectangles from text extraction. Default:
empty
(List of two floats) Two numbers specifying the minimum and maximum font size of text. Text with a
size outside of this interval will be ignored. The maximum can be specified with the keyword unlimited,
which means that no upper limit will be active. Default: { 0 unlimited }
(Keyword) The granularity of the text fragments returned by TET_get_text( ); all modes except glyph will
enable the Wordfinder. See »Text granularity«, page 71, for more details (default: word).
glyph
word
line
page
A fragment contains the result of mapping one glyph, but may contain more than one
character (e.g. for ligatures).
A fragment contains a word as determined by the wordfinder.
A fragment contains a line of text, or the closest approximation thereof. Word separators will
be inserted between two consecutive words.
A fragment contains the contents of a single page. Word, line, and zone separators will be
inserted as appropriate.
(Boolean) If true, text with rendering mode 3 (invisible) will be ignored. Default: false (since invisible
text is mainly used for image+text PDFs containing scanned pages and the corresponding OCR text)
(Option list) List of suboptions according to Table 10.8 for controlling high-level image processing.
(List of rectangles) Restrict text extraction to the combined area of the specified rectangles. Default: the
complete clipping area
(Option list; not for granularity=glyph) List of suboptions according to Table 10.7 for controlling layout
detection features.
(Keyword) Controls the quality/performance trade-off of layout recognition. Layout recognition can be
improved by spending more effort, but this may slow down operation. The layout recognition effort can
be controlled with the keywords none, low, medium, high, and extra. Default: low
(List of keywords) Skip some of the availablabe parsers for the page contents. A skipped engine never returns
any data for this page. Skipping an engine which is not required will improve performance for applications
which don’t need the data delivered by this engine (default: all engines are active):
text (Keyword) Skip the text extraction engine.
image (Keyword) Skip the image extraction engine.
(Option list; not for granularity=glyph) List of suboptions according to Table 10.9 for controlling page
structure analysis.
10.5 Page Functions 135