tesseract 4.1.1
Loading...
Searching...
No Matches
publictypes.h
Go to the documentation of this file.
1
2// File: publictypes.h
3// Description: Types used in both the API and internally
4// Author: Ray Smith
5// Created: Wed Mar 03 09:22:53 PST 2010
6//
7// (C) Copyright 2010, Google Inc.
8// Licensed under the Apache License, Version 2.0 (the "License");
9// you may not use this file except in compliance with the License.
10// You may obtain a copy of the License at
11// http://www.apache.org/licenses/LICENSE-2.0
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17//
19
20#ifndef TESSERACT_CCSTRUCT_PUBLICTYPES_H_
21#define TESSERACT_CCSTRUCT_PUBLICTYPES_H_
22
23// This file contains types that are used both by the API and internally
24// to Tesseract. In order to decouple the API from Tesseract and prevent cyclic
25// dependencies, THIS FILE SHOULD NOT DEPEND ON ANY OTHER PART OF TESSERACT.
26// Restated: It is OK for low-level Tesseract files to include publictypes.h,
27// but not for the low-level tesseract code to include top-level API code.
28// This file should not use other Tesseract types, as that would drag
29// their includes into the API-level.
30// API-level code should include apitypes.h in preference to this file.
31
33constexpr int kPointsPerInch = 72;
38constexpr int kMinCredibleResolution = 70;
40constexpr int kMaxCredibleResolution = 2400;
45constexpr int kResolutionEstimationFactor = 10;
46
54 PT_UNKNOWN, // Type is not yet known. Keep as the first element.
55 PT_FLOWING_TEXT, // Text that lives inside a column.
56 PT_HEADING_TEXT, // Text that spans more than one column.
57 PT_PULLOUT_TEXT, // Text that is in a cross-column pull-out region.
58 PT_EQUATION, // Partition belonging to an equation region.
59 PT_INLINE_EQUATION, // Partition has inline equation.
60 PT_TABLE, // Partition belonging to a table region.
61 PT_VERTICAL_TEXT, // Text-line runs vertically.
62 PT_CAPTION_TEXT, // Text that belongs to an image.
63 PT_FLOWING_IMAGE, // Image that lives inside a column.
64 PT_HEADING_IMAGE, // Image that spans more than one column.
65 PT_PULLOUT_IMAGE, // Image that is in a cross-column pull-out region.
66 PT_HORZ_LINE, // Horizontal Line.
67 PT_VERT_LINE, // Vertical Line.
68 PT_NOISE, // Lies outside of any column.
70};
71
73inline bool PTIsLineType(PolyBlockType type) {
74 return type == PT_HORZ_LINE || type == PT_VERT_LINE;
75}
77inline bool PTIsImageType(PolyBlockType type) {
78 return type == PT_FLOWING_IMAGE || type == PT_HEADING_IMAGE ||
79 type == PT_PULLOUT_IMAGE;
80}
82inline bool PTIsTextType(PolyBlockType type) {
83 return type == PT_FLOWING_TEXT || type == PT_HEADING_TEXT ||
84 type == PT_PULLOUT_TEXT || type == PT_TABLE ||
85 type == PT_VERTICAL_TEXT || type == PT_CAPTION_TEXT ||
86 type == PT_INLINE_EQUATION;
87}
88// Returns true if PolyBlockType is of pullout(inter-column) type
89inline bool PTIsPulloutType(PolyBlockType type) {
90 return type == PT_PULLOUT_IMAGE || type == PT_PULLOUT_TEXT;
91}
92
94extern const char* kPolyBlockNames[];
95
96namespace tesseract {
125};
126
139};
140
156};
157
165 PSM_AUTO_OSD = 1,
179 PSM_RAW_LINE = 13,
181
182 PSM_COUNT
184
191inline bool PSM_OSD_ENABLED(int pageseg_mode) {
192 return pageseg_mode <= PSM_AUTO_OSD || pageseg_mode == PSM_SPARSE_TEXT_OSD;
193}
194inline bool PSM_ORIENTATION_ENABLED(int pageseg_mode) {
195 return pageseg_mode <= PSM_AUTO || pageseg_mode == PSM_SPARSE_TEXT_OSD;
196}
197inline bool PSM_COL_FIND_ENABLED(int pageseg_mode) {
198 return pageseg_mode >= PSM_AUTO_OSD && pageseg_mode <= PSM_AUTO;
199}
200inline bool PSM_SPARSE(int pageseg_mode) {
201 return pageseg_mode == PSM_SPARSE_TEXT || pageseg_mode == PSM_SPARSE_TEXT_OSD;
202}
203inline bool PSM_BLOCK_FIND_ENABLED(int pageseg_mode) {
204 return pageseg_mode >= PSM_AUTO_OSD && pageseg_mode <= PSM_SINGLE_COLUMN;
205}
206inline bool PSM_LINE_FIND_ENABLED(int pageseg_mode) {
207 return pageseg_mode >= PSM_AUTO_OSD && pageseg_mode <= PSM_SINGLE_BLOCK;
208}
209inline bool PSM_WORD_FIND_ENABLED(int pageseg_mode) {
210 return (pageseg_mode >= PSM_AUTO_OSD && pageseg_mode <= PSM_SINGLE_LINE) ||
211 pageseg_mode == PSM_SPARSE_TEXT || pageseg_mode == PSM_SPARSE_TEXT_OSD;
212}
213
220 RIL_BLOCK, // Block of text/image/separator line.
221 RIL_PARA, // Paragraph within a block.
222 RIL_TEXTLINE, // Line within a paragraph.
223 RIL_WORD, // Word within a textline.
224 RIL_SYMBOL // Symbol/character within a word.
226
256};
257
269 OEM_TESSERACT_ONLY, // Run Tesseract only - fastest; deprecated
270 OEM_LSTM_ONLY, // Run just the LSTM line recognizer.
271 OEM_TESSERACT_LSTM_COMBINED, // Run the LSTM recognizer, but allow fallback
272 // to Tesseract when things get difficult.
273 // deprecated
274 OEM_DEFAULT, // Specify this mode when calling init_*(),
275 // to indicate that any of the above modes
276 // should be automatically inferred from the
277 // variables in the language-specific config,
278 // command-line configs, or if not specified
279 // in any of the above should be set to the
280 // default OEM_TESSERACT_ONLY.
281 OEM_COUNT // Number of OEMs
283
284} // namespace tesseract.
285
286#endif // TESSERACT_CCSTRUCT_PUBLICTYPES_H_
PolyBlockType
Definition: publictypes.h:53
@ PT_VERT_LINE
Definition: publictypes.h:67
@ PT_PULLOUT_TEXT
Definition: publictypes.h:57
@ PT_COUNT
Definition: publictypes.h:69
@ PT_HEADING_TEXT
Definition: publictypes.h:56
@ PT_TABLE
Definition: publictypes.h:60
@ PT_NOISE
Definition: publictypes.h:68
@ PT_PULLOUT_IMAGE
Definition: publictypes.h:65
@ PT_HEADING_IMAGE
Definition: publictypes.h:64
@ PT_INLINE_EQUATION
Definition: publictypes.h:59
@ PT_FLOWING_TEXT
Definition: publictypes.h:55
@ PT_UNKNOWN
Definition: publictypes.h:54
@ PT_HORZ_LINE
Definition: publictypes.h:66
@ PT_VERTICAL_TEXT
Definition: publictypes.h:61
@ PT_EQUATION
Definition: publictypes.h:58
@ PT_FLOWING_IMAGE
Definition: publictypes.h:63
@ PT_CAPTION_TEXT
Definition: publictypes.h:62
bool PTIsPulloutType(PolyBlockType type)
Definition: publictypes.h:89
constexpr int kResolutionEstimationFactor
Definition: publictypes.h:45
bool PTIsTextType(PolyBlockType type)
Definition: publictypes.h:82
const char * kPolyBlockNames[]
Definition: publictypes.cpp:23
constexpr int kMinCredibleResolution
Definition: publictypes.h:38
bool PTIsImageType(PolyBlockType type)
Definition: publictypes.h:77
constexpr int kPointsPerInch
Definition: publictypes.h:33
constexpr int kMaxCredibleResolution
Definition: publictypes.h:40
bool PTIsLineType(PolyBlockType type)
Definition: publictypes.h:73
@ OEM_TESSERACT_LSTM_COMBINED
Definition: publictypes.h:271
@ OEM_TESSERACT_ONLY
Definition: publictypes.h:269
@ TEXTLINE_ORDER_LEFT_TO_RIGHT
Definition: publictypes.h:153
@ TEXTLINE_ORDER_RIGHT_TO_LEFT
Definition: publictypes.h:154
@ TEXTLINE_ORDER_TOP_TO_BOTTOM
Definition: publictypes.h:155
bool PSM_OSD_ENABLED(int pageseg_mode)
Definition: publictypes.h:191
@ PSM_AUTO_OSD
script detection. (OSD)
Definition: publictypes.h:165
@ PSM_CIRCLE_WORD
Treat the image as a single word in a circle.
Definition: publictypes.h:175
@ PSM_OSD_ONLY
Orientation and script detection only.
Definition: publictypes.h:164
@ PSM_COUNT
Number of enum entries.
Definition: publictypes.h:182
@ PSM_SPARSE_TEXT
Find as much text as possible in no particular order.
Definition: publictypes.h:177
@ PSM_AUTO_ONLY
Automatic page segmentation, but no OSD, or OCR.
Definition: publictypes.h:167
@ PSM_SINGLE_BLOCK_VERT_TEXT
aligned text.
Definition: publictypes.h:170
@ PSM_SINGLE_CHAR
Treat the image as a single character.
Definition: publictypes.h:176
@ PSM_SINGLE_COLUMN
Assume a single column of text of variable sizes.
Definition: publictypes.h:169
@ PSM_AUTO
Fully automatic page segmentation, but no OSD.
Definition: publictypes.h:168
@ PSM_SINGLE_WORD
Treat the image as a single word.
Definition: publictypes.h:174
@ PSM_SINGLE_BLOCK
Assume a single uniform block of text. (Default.)
Definition: publictypes.h:172
@ PSM_RAW_LINE
hacks that are Tesseract-specific.
Definition: publictypes.h:179
@ PSM_SINGLE_LINE
Treat the image as a single text line.
Definition: publictypes.h:173
@ PSM_SPARSE_TEXT_OSD
Sparse text with orientation and script det.
Definition: publictypes.h:178
bool PSM_ORIENTATION_ENABLED(int pageseg_mode)
Definition: publictypes.h:194
bool PSM_LINE_FIND_ENABLED(int pageseg_mode)
Definition: publictypes.h:206
ParagraphJustification
Definition: publictypes.h:251
@ JUSTIFICATION_LEFT
Definition: publictypes.h:253
@ JUSTIFICATION_UNKNOWN
Definition: publictypes.h:252
@ JUSTIFICATION_RIGHT
Definition: publictypes.h:255
@ JUSTIFICATION_CENTER
Definition: publictypes.h:254
bool PSM_COL_FIND_ENABLED(int pageseg_mode)
Definition: publictypes.h:197
@ ORIENTATION_PAGE_LEFT
Definition: publictypes.h:124
@ ORIENTATION_PAGE_DOWN
Definition: publictypes.h:123
@ ORIENTATION_PAGE_UP
Definition: publictypes.h:121
@ ORIENTATION_PAGE_RIGHT
Definition: publictypes.h:122
bool PSM_SPARSE(int pageseg_mode)
Definition: publictypes.h:200
@ WRITING_DIRECTION_TOP_TO_BOTTOM
Definition: publictypes.h:138
@ WRITING_DIRECTION_LEFT_TO_RIGHT
Definition: publictypes.h:136
@ WRITING_DIRECTION_RIGHT_TO_LEFT
Definition: publictypes.h:137
bool PSM_WORD_FIND_ENABLED(int pageseg_mode)
Definition: publictypes.h:209
bool PSM_BLOCK_FIND_ENABLED(int pageseg_mode)
Definition: publictypes.h:203