tesseract  4.00.00dev
publictypes.h File Reference

Go to the source code of this file.

Namespaces

 tesseract
 

Enumerations

enum  PolyBlockType {
  PT_UNKNOWN, PT_FLOWING_TEXT, PT_HEADING_TEXT, PT_PULLOUT_TEXT,
  PT_EQUATION, PT_INLINE_EQUATION, PT_TABLE, PT_VERTICAL_TEXT,
  PT_CAPTION_TEXT, PT_FLOWING_IMAGE, PT_HEADING_IMAGE, PT_PULLOUT_IMAGE,
  PT_HORZ_LINE, PT_VERT_LINE, PT_NOISE, PT_COUNT
}
 
enum  tesseract::Orientation { tesseract::ORIENTATION_PAGE_UP = 0, tesseract::ORIENTATION_PAGE_RIGHT = 1, tesseract::ORIENTATION_PAGE_DOWN = 2, tesseract::ORIENTATION_PAGE_LEFT = 3 }
 
enum  tesseract::WritingDirection { tesseract::WRITING_DIRECTION_LEFT_TO_RIGHT = 0, tesseract::WRITING_DIRECTION_RIGHT_TO_LEFT = 1, tesseract::WRITING_DIRECTION_TOP_TO_BOTTOM = 2 }
 
enum  tesseract::TextlineOrder { tesseract::TEXTLINE_ORDER_LEFT_TO_RIGHT = 0, tesseract::TEXTLINE_ORDER_RIGHT_TO_LEFT = 1, tesseract::TEXTLINE_ORDER_TOP_TO_BOTTOM = 2 }
 
enum  tesseract::PageSegMode {
  tesseract::PSM_OSD_ONLY, tesseract::PSM_AUTO_OSD, tesseract::PSM_AUTO_ONLY, tesseract::PSM_AUTO,
  tesseract::PSM_SINGLE_COLUMN, tesseract::PSM_SINGLE_BLOCK_VERT_TEXT, tesseract::PSM_SINGLE_BLOCK, tesseract::PSM_SINGLE_LINE,
  tesseract::PSM_SINGLE_WORD, tesseract::PSM_CIRCLE_WORD, tesseract::PSM_SINGLE_CHAR, tesseract::PSM_SPARSE_TEXT,
  tesseract::PSM_SPARSE_TEXT_OSD, tesseract::PSM_RAW_LINE, tesseract::PSM_COUNT
}
 
enum  tesseract::PageIteratorLevel {
  tesseract::RIL_BLOCK, tesseract::RIL_PARA, tesseract::RIL_TEXTLINE, tesseract::RIL_WORD,
  tesseract::RIL_SYMBOL
}
 
enum  tesseract::ParagraphJustification { tesseract::JUSTIFICATION_UNKNOWN, tesseract::JUSTIFICATION_LEFT, tesseract::JUSTIFICATION_CENTER, tesseract::JUSTIFICATION_RIGHT }
 
enum  tesseract::OcrEngineMode {
  tesseract::OEM_TESSERACT_ONLY, tesseract::OEM_LSTM_ONLY, tesseract::OEM_TESSERACT_LSTM_COMBINED, tesseract::OEM_DEFAULT,
  tesseract::OEM_CUBE_ONLY, tesseract::OEM_TESSERACT_CUBE_COMBINED
}
 

Functions

bool PTIsLineType (PolyBlockType type)
 
bool PTIsImageType (PolyBlockType type)
 
bool PTIsTextType (PolyBlockType type)
 
bool PTIsPulloutType (PolyBlockType type)
 
bool tesseract::PSM_OSD_ENABLED (int pageseg_mode)
 
bool tesseract::PSM_ORIENTATION_ENABLED (int pageseg_mode)
 
bool tesseract::PSM_COL_FIND_ENABLED (int pageseg_mode)
 
bool tesseract::PSM_SPARSE (int pageseg_mode)
 
bool tesseract::PSM_BLOCK_FIND_ENABLED (int pageseg_mode)
 
bool tesseract::PSM_LINE_FIND_ENABLED (int pageseg_mode)
 
bool tesseract::PSM_WORD_FIND_ENABLED (int pageseg_mode)
 

Variables

const int kPointsPerInch = 72
 
const char * kPolyBlockNames []
 

Enumeration Type Documentation

◆ PolyBlockType

Possible types for a POLY_BLOCK or ColPartition. Must be kept in sync with kPBColors in polyblk.cpp and PTIs*Type functions below, as well as kPolyBlockNames in publictypes.cpp. Used extensively by ColPartition, and POLY_BLOCK.

Enumerator
PT_UNKNOWN 
PT_FLOWING_TEXT 
PT_HEADING_TEXT 
PT_PULLOUT_TEXT 
PT_EQUATION 
PT_INLINE_EQUATION 
PT_TABLE 
PT_VERTICAL_TEXT 
PT_CAPTION_TEXT 
PT_FLOWING_IMAGE 
PT_HEADING_IMAGE 
PT_PULLOUT_IMAGE 
PT_HORZ_LINE 
PT_VERT_LINE 
PT_NOISE 
PT_COUNT 

Definition at line 41 of file publictypes.h.

41  {
42  PT_UNKNOWN, // Type is not yet known. Keep as the first element.
43  PT_FLOWING_TEXT, // Text that lives inside a column.
44  PT_HEADING_TEXT, // Text that spans more than one column.
45  PT_PULLOUT_TEXT, // Text that is in a cross-column pull-out region.
46  PT_EQUATION, // Partition belonging to an equation region.
47  PT_INLINE_EQUATION, // Partition has inline equation.
48  PT_TABLE, // Partition belonging to a table region.
49  PT_VERTICAL_TEXT, // Text-line runs vertically.
50  PT_CAPTION_TEXT, // Text that belongs to an image.
51  PT_FLOWING_IMAGE, // Image that lives inside a column.
52  PT_HEADING_IMAGE, // Image that spans more than one column.
53  PT_PULLOUT_IMAGE, // Image that is in a cross-column pull-out region.
54  PT_HORZ_LINE, // Horizontal Line.
55  PT_VERT_LINE, // Vertical Line.
56  PT_NOISE, // Lies outside of any column.
57  PT_COUNT
58 };

Function Documentation

◆ PTIsImageType()

bool PTIsImageType ( PolyBlockType  type)
inline

Returns true if PolyBlockType is of image type

Definition at line 65 of file publictypes.h.

65  {
66  return type == PT_FLOWING_IMAGE || type == PT_HEADING_IMAGE ||
67  type == PT_PULLOUT_IMAGE;
68 }

◆ PTIsLineType()

bool PTIsLineType ( PolyBlockType  type)
inline

Returns true if PolyBlockType is of horizontal line type

Definition at line 61 of file publictypes.h.

61  {
62  return type == PT_HORZ_LINE || type == PT_VERT_LINE;
63 }

◆ PTIsPulloutType()

bool PTIsPulloutType ( PolyBlockType  type)
inline

Definition at line 77 of file publictypes.h.

77  {
78  return type == PT_PULLOUT_IMAGE || type == PT_PULLOUT_TEXT;
79 }

◆ PTIsTextType()

bool PTIsTextType ( PolyBlockType  type)
inline

Returns true if PolyBlockType is of text type

Definition at line 70 of file publictypes.h.

70  {
71  return type == PT_FLOWING_TEXT || type == PT_HEADING_TEXT ||
72  type == PT_PULLOUT_TEXT || type == PT_TABLE ||
73  type == PT_VERTICAL_TEXT || type == PT_CAPTION_TEXT ||
74  type == PT_INLINE_EQUATION;
75 }

Variable Documentation

◆ kPointsPerInch

const int kPointsPerInch = 72

Number of printers' points in an inch. The unit of the pointsize return.

Definition at line 33 of file publictypes.h.

◆ kPolyBlockNames

const char* kPolyBlockNames[]

String name for each block type. Keep in sync with PolyBlockType.

Definition at line 23 of file publictypes.cpp.