Tesseract
3.02
|
The following methods break TesseractRect into pieces, so you can get hold of the thresholded image, get the text in different formats, get bounding boxes, confidences etc.
bool tesseract::TessBaseAPI::AdaptToWordStr | ( | PageSegMode | mode, |
const char * | wordstr | ||
) |
Applies the given word to the adaptive classifier if possible. The word must be SPACE-DELIMITED UTF-8 - l i k e t h i s , so it can tell the boundaries of the graphemes. Assumes that SetImage/SetRectangle have been used to set the image to the given word. The mode arg should be PSM_SINGLE_WORD or PSM_CIRCLE_WORD, as that will be used to control layout analysis. The currently set PageSegMode is preserved. Returns false if adaption was not possible for some reason.
Definition at line 1396 of file baseapi.cpp.
int * tesseract::TessBaseAPI::AllWordConfidences | ( | ) |
Returns all word confidences (between 0 and 100) in an array, terminated by -1. The calling function must delete [] after use. The number of confidences should correspond to the number of space- delimited words in GetUTF8Text.
Returns an array of all word confidences, terminated by -1.
Definition at line 1362 of file baseapi.cpp.
PageIterator * tesseract::TessBaseAPI::AnalyseLayout | ( | ) |
Runs page layout analysis in the mode set by SetPageSegMode. May optionally be called prior to Recognize to get access to just the page layout results. Returns an iterator to the results. Returns NULL on error. The returned iterator must be deleted after use. 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.
Runs page layout analysis in the mode set by SetPageSegMode. May optionally be called prior to Recognize to get access to just the page layout results. Returns an iterator to the results. Returns NULL on error or an empty page. The returned iterator must be deleted after use. 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.
Definition at line 678 of file baseapi.cpp.
void tesseract::TessBaseAPI::Clear | ( | ) |
Free up recognition results and any stored image data, without actually freeing any recognition data that would be time-consuming to reload. Afterwards, you must call SetImage or TesseractRect before doing any Recognize or Get* operation.
Definition at line 1460 of file baseapi.cpp.
|
static |
Delete a block list. This is to keep BLOCK_LIST pointer opaque and let go of including the other headers.
Definition at line 1845 of file baseapi.cpp.
bool tesseract::TessBaseAPI::DetectOS | ( | OSResults * | osr | ) |
Estimates the Orientation And Script of the image.
Estimates the Orientation And Script of the image. Returns true if the image was processed successfully.
Definition at line 1756 of file baseapi.cpp.
void tesseract::TessBaseAPI::DumpPGM | ( | const char * | filename | ) |
Dump the internal binary image to a PGM file.
Dump the internal binary image to a PGM file.
Definition at line 604 of file baseapi.cpp.
void tesseract::TessBaseAPI::End | ( | ) |
Close down tesseract and free up all memory. End() is equivalent to destructing and reconstructing your TessBaseAPI. Once End() has been used, none of the other API functions may be used other than Init and anything declared above it in the class definition.
Definition at line 1472 of file baseapi.cpp.
BLOCK_LIST * tesseract::TessBaseAPI::FindLinesCreateBlockList | ( | ) |
Find lines from the image making the BLOCK_LIST.
Definition at line 1833 of file baseapi.cpp.
|
static |
This method returns the row to which a box of specified dimensions would belong. If no good match is found, it returns NULL.
Definition at line 2138 of file baseapi.cpp.
void tesseract::TessBaseAPI::GetBlockTextOrientations | ( | int ** | block_orientation, |
bool ** | vertical_writing | ||
) |
Return text orientation of each block as determined by an earlier run of layout analysis.
Return text orientation of each block as determined in an earlier page layout analysis operation. Orientation is returned as the number of ccw 90-degree rotations (in [0..3]) required to make the text in the block upright (readable). Note that this may not necessary be the block orientation preferred for recognition (such as the case of vertical CJK text).
Also returns whether the text in the block is believed to have vertical writing direction (when in an upright page orientation).
The returned array is of length equal to the number of text blocks, which may be less than the total number of blocks. The ordering is intended to be consistent with GetTextLines().
Definition at line 1785 of file baseapi.cpp.
char * tesseract::TessBaseAPI::GetBoxText | ( | int | page_number | ) |
The recognized text is returned as a char* which is coded in the same format as a box file used in training. Returned string must be freed with the delete [] operator. Constructs coordinates in the original image - not just the rectangle. page_number is a 0-based page index that will appear in the box file.
The recognized text is returned as a char* which is coded as a UTF8 box file and must be freed with the delete [] operator. page_number is a 0-base page index that will appear in the box file.
Definition at line 1193 of file baseapi.cpp.
Boxa * tesseract::TessBaseAPI::GetComponentImages | ( | PageIteratorLevel | level, |
bool | text_only, | ||
Pixa ** | pixa, | ||
int ** | blockids | ||
) |
Get the given level kind of components (block, textline, word etc.) as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize. If blockids is not NULL, the block-id of each component is also returned as an array of one element per component. delete [] after use. If text_only is true, then only text components are returned.
Definition at line 547 of file baseapi.cpp.
Boxa * tesseract::TessBaseAPI::GetConnectedComponents | ( | Pixa ** | pixa | ) |
Gets the individual connected (text) components (created after pages segmentation step, but before recognition) as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize. Note: the caller is responsible for calling boxaDestroy() on the returned Boxa array and pixaDestroy() on cc array.
Gets the individual connected (text) components (created after pages segmentation step, but before recognition) as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize.
Definition at line 535 of file baseapi.cpp.
CubeRecoContext * tesseract::TessBaseAPI::GetCubeRecoContext | ( | ) | const |
Return a pointer to underlying CubeRecoContext object if present.
Definition at line 2202 of file baseapi.cpp.
const Dawg * tesseract::TessBaseAPI::GetDawg | ( | int | i | ) | const |
Return the pointer to the i-th dawg loaded into tesseract_ object.
Definition at line 2191 of file baseapi.cpp.
void tesseract::TessBaseAPI::GetFeaturesForBlob | ( | TBLOB * | blob, |
const DENORM & | denorm, | ||
INT_FEATURE_ARRAY | int_features, | ||
int * | num_features, | ||
int * | FeatureOutlineIndex | ||
) |
This method returns the features associated with the input image.
This method returns the features associated with the input blob.
Definition at line 2119 of file baseapi.cpp.
char * tesseract::TessBaseAPI::GetHOCRText | ( | int | page_number | ) |
Make a HTML-formatted string with hOCR markup from the internal data structures. page_number is 0-based but will appear in the output as 1-based.
Make a HTML-formatted string with hOCR markup from the internal data structures. page_number is 0-based but will appear in the output as 1-based. Image name/input_file_ can be set by SetInputName before calling GetHOCRText STL removed from original patch submission and refactored by rays.
Definition at line 1055 of file baseapi.cpp.
ResultIterator * tesseract::TessBaseAPI::GetIterator | ( | ) |
Get a reading-order iterator to the results of LayoutAnalysis and/or Recognize. The returned iterator must be deleted after use. 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.
Definition at line 990 of file baseapi.cpp.
MutableIterator * tesseract::TessBaseAPI::GetMutableIterator | ( | ) |
Get a mutable iterator to the results of LayoutAnalysis and/or Recognize. The returned iterator must be deleted after use. 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.
Definition at line 1007 of file baseapi.cpp.
Boxa * tesseract::TessBaseAPI::GetRegions | ( | Pixa ** | pixa | ) |
Get the result of page layout analysis as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize.
Definition at line 494 of file baseapi.cpp.
Boxa * tesseract::TessBaseAPI::GetStrips | ( | Pixa ** | pixa, |
int ** | blockids | ||
) |
Get textlines and strips of image regions as a leptonica-style Boxa, Pixa pair, in reading order. Enables downstream handling of non-rectangular regions. Can be called before or after Recognize. If blockids is not NULL, the block-id of each line is also returned as an array of one element per line. delete [] after use.
Definition at line 516 of file baseapi.cpp.
bool tesseract::TessBaseAPI::GetTextDirection | ( | int * | out_offset, |
float * | out_slope | ||
) |
Definition at line 1531 of file baseapi.cpp.
Boxa * tesseract::TessBaseAPI::GetTextlines | ( | Pixa ** | pixa, |
int ** | blockids | ||
) |
Get the textlines as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize. If blockids is not NULL, the block-id of each line is also returned as an array of one element per line. delete [] after use.
Definition at line 504 of file baseapi.cpp.
Pix * tesseract::TessBaseAPI::GetThresholdedImage | ( | ) |
Get a copy of the internal thresholded image from Tesseract. Caller takes ownership of the Pix and must pixDestroy it. May be called any time after SetImage, or after TesseractRect.
ONLY available if you have Leptonica installed. Get a copy of the internal thresholded image from Tesseract.
Definition at line 481 of file baseapi.cpp.
int tesseract::TessBaseAPI::GetThresholdedImageScaleFactor | ( | ) | const |
Returns the scale factor of the thresholded image that would be returned by GetThresholdedImage() and the various GetX() methods that call GetComponentImages(). Returns 0 if no thresholder has been set.
Definition at line 596 of file baseapi.cpp.
const char * tesseract::TessBaseAPI::GetUnichar | ( | int | unichar_id | ) |
This method returns the string form of the specified unichar.
Definition at line 2186 of file baseapi.cpp.
char * tesseract::TessBaseAPI::GetUNLVText | ( | ) |
The recognized text is returned as a char* which is coded as UNLV format Latin-1 with specific reject and suspect codes and must be freed with the delete [] operator.
Definition at line 1248 of file baseapi.cpp.
char * tesseract::TessBaseAPI::GetUTF8Text | ( | ) |
The recognized text is returned as a char* which is coded as UTF8 and must be freed with the delete [] operator.
Make a text string from the internal data structures.
Definition at line 1017 of file baseapi.cpp.
Boxa * tesseract::TessBaseAPI::GetWords | ( | Pixa ** | pixa | ) |
Get the words as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize.
Definition at line 525 of file baseapi.cpp.
|
inline |
int tesseract::TessBaseAPI::IsValidWord | ( | const char * | word | ) |
Check whether a word is valid according to Tesseract's language model
Check whether a word is valid according to Tesseract's language model returns 0 if the word is invalid, non-zero if valid
Definition at line 1526 of file baseapi.cpp.
|
static |
Returns a TBLOB corresponding to the entire input image.
Creates a TBLOB* from the whole pix.
Definition at line 1867 of file baseapi.cpp.
|
static |
int tesseract::TessBaseAPI::MeanTextConf | ( | ) |
Returns the (average) confidence value between 0 and 100.
Returns the average word confidence for Tesseract page result.
Definition at line 1350 of file baseapi.cpp.
|
static |
This method baseline normalizes a TBLOB in-place. The input row is used for normalization. The denorm is an optional parameter in which the normalization-antidote is returned.
Definition at line 1897 of file baseapi.cpp.
int tesseract::TessBaseAPI::NumDawgs | ( | ) | const |
Return the number of dawgs loaded into tesseract_ object.
Definition at line 2197 of file baseapi.cpp.
|
inline |
bool tesseract::TessBaseAPI::ProcessPage | ( | Pix * | pix, |
int | page_index, | ||
const char * | filename, | ||
const char * | retry_config, | ||
int | timeout_millisec, | ||
STRING * | text_out | ||
) |
Recognizes a single page for ProcessPages, appending the text to text_out. The pix is the image processed - filename and page_index are metadata used by side-effect processes, such as reading a box file or formatting as hOCR. If non-zero timeout_millisec terminates processing after the timeout. If non-NULL and non-empty, and some page fails for some reason, the page is reprocessed with the retry_config config file. Useful for interactively debugging a bad page. The text is returned in text_out. Returns false on error.
Definition at line 905 of file baseapi.cpp.
bool tesseract::TessBaseAPI::ProcessPages | ( | const char * | filename, |
const char * | retry_config, | ||
int | timeout_millisec, | ||
STRING * | text_out | ||
) |
Recognizes all the pages in the named file, as a multi-page tiff or list of filenames, or single image, and gets the appropriate kind of text according to parameters: tessedit_create_boxfile, tessedit_make_boxes_from_boxes, tessedit_write_unlv, tessedit_create_hocr. Calls ProcessPage on each page in the input file, which may be a multi-page tiff, single-page other file format, or a plain text list of images to read. If tessedit_page_number is non-negative, processing begins at that page of a multi-page tiff file, or filelist. The text is returned in text_out. Returns false on error. If non-zero timeout_millisec terminates processing after the timeout on a single page. If non-NULL and non-empty, and some page fails for some reason, the page is reprocessed with the retry_config config file. Useful for interactively debugging a bad page.
Definition at line 803 of file baseapi.cpp.
int tesseract::TessBaseAPI::Recognize | ( | ETEXT_DESC * | monitor | ) |
Recognize the image from SetAndThresholdImage, generating Tesseract internal structures. Returns 0 on success. Optional. The Get*Text functions below will call Recognize if needed. After Recognize, the output is kept internally until the next SetImage.
Recognize the tesseract global image and return the result as Tesseract internal structures.
Definition at line 696 of file baseapi.cpp.
int tesseract::TessBaseAPI::RecognizeForChopTest | ( | ETEXT_DESC * | monitor | ) |
Methods to retrieve information after SetAndThresholdImage(), Recognize() or TesseractRect(). (Recognize is called implicitly if needed.) Variant on Recognize used for testing chopper.
Tests the chopper by exhaustively running chop_one_blob.
Definition at line 757 of file baseapi.cpp.
void tesseract::TessBaseAPI::RunAdaptiveClassifier | ( | TBLOB * | blob, |
const DENORM & | denorm, | ||
int | num_max_matches, | ||
int * | unichar_ids, | ||
float * | ratings, | ||
int * | num_matches_returned | ||
) |
Method to run adaptive classifier on a blob. It returns at max num_max_matches results.
Method to run adaptive classifier on a blob.
Definition at line 2163 of file baseapi.cpp.
void tesseract::TessBaseAPI::set_min_orientation_margin | ( | double | margin | ) |
Definition at line 1767 of file baseapi.cpp.
void tesseract::TessBaseAPI::SetDictFunc | ( | DictFunc | f | ) |
Sets Dict::letter_is_okay_ function to point to the given function.
Definition at line 1559 of file baseapi.cpp.
void tesseract::TessBaseAPI::SetFillLatticeFunc | ( | FillLatticeFunc | f | ) |
Sets Wordrec::fill_lattice_ function to point to the given function.
Definition at line 1581 of file baseapi.cpp.
void tesseract::TessBaseAPI::SetImage | ( | const unsigned char * | imagedata, |
int | width, | ||
int | height, | ||
int | bytes_per_pixel, | ||
int | bytes_per_line | ||
) |
Provide an image for Tesseract to recognize. Format is as TesseractRect above. Does not copy the image buffer, or take ownership. The source image may be destroyed after Recognize is called, either explicitly or implicitly via one of the Get*Text functions. SetImage clears all recognition results, and sets the rectangle to the full image, so it may be followed immediately by a GetUTF8Text, and it will automatically perform recognition.
Definition at line 435 of file baseapi.cpp.
void tesseract::TessBaseAPI::SetImage | ( | const Pix * | pix | ) |
Provide an image for Tesseract to recognize. As with SetImage above, Tesseract doesn't take a copy or ownership or pixDestroy the image, so it must persist until after Recognize. Pix vs raw, which to use? Use Pix where possible. A future version of Tesseract may choose to use Pix as its internal representation and discard IMAGE altogether. Because of that, an implementation that sources and targets Pix may end up with less copies than an implementation that does not.
Definition at line 460 of file baseapi.cpp.
void tesseract::TessBaseAPI::SetProbabilityInContextFunc | ( | ProbabilityInContextFunc | f | ) |
Sets Dict::probability_in_context_ function to point to the given function.
Definition at line 1569 of file baseapi.cpp.
void tesseract::TessBaseAPI::SetRectangle | ( | int | left, |
int | top, | ||
int | width, | ||
int | height | ||
) |
Restrict recognition to a sub-rectangle of the image. Call after SetImage. Each SetRectangle clears the recogntion results so multiple rectangles can be recognized with the same image.
Definition at line 470 of file baseapi.cpp.
void tesseract::TessBaseAPI::SetSourceResolution | ( | int | ppi | ) |
Set the resolution of the source image in pixels per inch so font size information can be calculated in results. Call this after SetImage().
Definition at line 443 of file baseapi.cpp.
|
inline |
In extreme cases only, usually with a subclass of Thresholder, it is possible to provide a different Thresholder. The Thresholder may be preloaded with an image, settings etc, or they may be set after. Note that Tesseract takes ownership of the Thresholder and will delete it when it it is replaced or the API is destructed.
|
inline |