Tesseract
Aggregate result renderer.
Ensures the renderer's EndDocument when disposed off.
Create a new aggregate result renderer with the specified child result renderers.
The child result renderers.
Create a new aggregate result renderer with the specified child result renderers.
The child result renderers.
Get's the current page number.
Get's the child result renderers.
Adds a page to each of the child result renderers.
Begins a new document with the specified title.
The title of the document.
Description of BitmapHelper.
Class to iterate over the classifier choices for a single symbol.
Moves to the next choice for the symbol and returns false if there are none left.
true|false
Returns the confidence of the current choice.
The number should be interpreted as a percent probability. (0.0f-100.0f)
float
Returns the text string for the current choice.
string
Represents properties that describe a text block's orientation.
Gets the for corresponding text block.
Gets the for corresponding text block.
Gets the for corresponding text block.
Gets the angle the page would need to be rotated to deskew the text block.
Only the legacy tesseract OCR engine is used.
Only the new LSTM-based OCR engine is used.
Both the legacy and new LSTM based OCR engine is used.
The default OCR engine is used (currently LSTM-ased OCR engine).
Ensures the given is true.
The is not true.
The name of the parameter, used when generating the exception.
The value of the parameter to check.
Ensures the given is true.
The is not true.
The name of the parameter, used when generating the exception.
The value of the parameter to check.
The error message.
Ensures the given is true.
The is not true.
The name of the parameter, used when generating the exception.
The value of the parameter to check.
The error message.
The message argument used to format .
Ensures the given is not null or empty.
The is null or empty.
The name of the parameter, used when generating the exception.
The value of the parameter to check.
Verifies the given is True; throwing an when the condition is not met.
The condition to be tested.
The error message to raise if is False.
Optional formatting arguments.
Utility helpers to handle converting variable values.
The exported tesseract api signatures.
Please note this is only public for technical reasons (you can't proxy a internal interface).
It should be considered an internal interface and is NOT part of the public api and may have
breaking changes between releases.
Creates a new BaseAPI instance
Deletes a base api instance.
Native API call to TessResultIteratorGetChoiceIterator
Native API call to TessChoiceIteratorDelete
Native API call to TessChoiceIteratorNext
Native API call to TessChoiceIteratorGetUTF8Text
Native API call to TessChoiceIteratorConfidence
Returns the null terminated UTF-8 encoded text string for the current choice
NOTE: Unlike LTRResultIterator::GetUTF8Text, the return points to an
internal structure and should NOT be delete[]ed to free after use.
string
Description of Constants.
Provides information about the hosting process.
The exported leptonica api signatures.
Please note this is only public for technical reasons (you can't proxy a internal interface).
It should be considered an internal interface and is NOT part of the public api and may have
breaking changes between releases.
Creates a new colormap with the specified .
The depth of the pix in bpp, can be 2, 4, or 8
The pointer to the color map, or null on error.
Creates a new colormap of the specified with random colors where the first color can optionally be set to black, and the last optionally set to white.
The depth of the pix in bpp, can be 2, 4, or 8
If set to 1 the first color will be black.
If set to 1 the last color will be white.
The pointer to the color map, or null on error.
Creates a new colormap of the specified with equally spaced gray color values.
The depth of the pix in bpp, can be 2, 4, or 8
The number of levels (must be between 2 and 2^
The pointer to the colormap, or null on error.
Performs a deep copy of the color map.
The pointer to the colormap instance.
The pointer to the colormap, or null on error.
Destorys and cleans up any memory used by the color map.
The pointer to the colormap instance, set to null on success.
Gets the number of color entries in the color map.
The pointer to the colormap instance.
Returns the number of color entries in the color map, or 0 on error.
Gets the number of free color entries in the color map.
The pointer to the colormap instance.
Returns the number of free color entries in the color map, or 0 on error.
Returns color maps depth, or 0 on error.
Gets the minimum pix depth required to support the color map.
The pointer to the colormap instance.
Returns the minimum depth to support the colormap
Returns 0 if OK, 1 on error.
Removes all colors from the color map by setting the count to zero.
The pointer to the colormap instance.
Returns 0 if OK, 1 on error.
Adds the color to the pix color map if their is room.
Returns 0 if OK, 1 on error.
Adds the specified color if it doesn't already exist, returning the colors index in the data array.
The pointer to the colormap instance.
The red value
The green value
The blue value
The index of the new color if it was added, or the existing color if it already existed.
Returns 0 for success, 1 for error, 2 for not enough space.
Adds the specified color if it doesn't already exist, returning the color's index in the data array.
If the color doesn't exist and there is not enough room to add a new color return the nearest color.
The pointer to the colormap instance.
The red value
The green value
The blue value
The index of the new color if it was added, or the existing color if it already existed.
Returns 0 for success, 1 for error, 2 for not enough space.
Checks if the color already exists or if their is enough room to add it.
The pointer to the colormap instance.
The red value
The green value
The blue value
Returns 1 if usable; 0 if not.
Returns 0 if OK, 1 on error.
Adds a color (black\white) if not already there returning it's index through .
The pointer to the colormap instance.
The color to add (0 for black; 1 for white)
The index of the color.
Returns 0 if OK; 1 on error.
Sets the darkest color in the colormap to black, if is 1.
Sets the lightest color in the colormap to white if is 1.
The pointer to the colormap instance.
0 for no operation; 1 to set darket color to black
0 for no operation; 1 to set lightest color to white
Returns 0 if OK; 1 on error.
Gets the color at the specified index.
The pointer to the colormap instance.
The index of the color entry.
The color entry's red value.
The color entry's blue value.
The color entry's green value.
Returns 0 if OK; 1 if not accessable (caller should check).
Gets the color at the specified index.
The alpha channel will always be zero as it is not used in Leptonica color maps.
The pointer to the colormap instance.
The index of the color entry.
The color entry as 32 bit value
Returns 0 if OK; 1 if not accessable (caller should check).
Sets a previously allocated color entry.
The pointer to the colormap instance.
The index of the colormap entry
Returns 0 if OK; 1 if not accessable (caller should check).
Gets the index of the color entry with the specified color, return 0 if found; 1 if not.
Returns 0 if the color exists in the color map; otherwise 1.
Returns 0 if OK; 1 on error.
Returns the number of unique grey colors including black and white.
Returns 0 if OK; 1 on error.
Finds the index of the color entry with the rank intensity.
Returns 0 if OK; 1 on error.
Finds the index of the color entry closest to the specified color.
Returns 0 if OK; 1 on error.
Finds the index of the color entry closest to the specified color.
Should only be used on gray colormaps.
Returns 0 if OK; 1 on error.
Gets the number of bytes in a null terminated byte array.
Begins a new document with the specified .
The title of the new document.
A handle that when disposed of ends the current document.
Add the page to the current document.
True if the page was successfully added to the result renderer; otherwise false.
Gets the current page number; returning -1 if no page has yet been added otherwise the number
of the last added page (starting from 0).
Convert a degrees to radians.
Convert a degrees to radians.
Calculates the smallest integer greater than the quotant of dividend and divisor.
Represents orientation that the page would need to be rotated so that .
Orientation is defined as to what side of the page would need to correspond to the 'up' direction such that the characters will
be read able. Another way of looking at this what direction you need to rotate you head so that "up" aligns with Orientation,
then the characters will appear "right side up" and readable.
In short:
- PageUp - Page is correctly alligned with up and no rotation is needed.
- PageRight - Page needs to be rotated so the right hand side is up, 90 degress counter clockwise, to be readable.
- PageDown - Page needs to be rotated so the bottom side is up, 180 degress counter clockwise, to be readable.
- PageLeft - Page needs to be rotated so the left hand side is up, 90 degress clockwise, to be readable.
Page is correctly alligned with up and no rotation is needed.
Page needs to be rotated so the right hand side is up, 90 degress counter clockwise, to be readable.
Page needs to be rotated so the bottom side is up, 180 degress counter clockwise, to be readable.
Page needs to be rotated so the left hand side is up, 90 degress clockwise, to be readable.
Gets the that is being ocr'd.
Gets the name of the image being ocr'd.
This is also used for some of the more advanced functionality such as identifying the associated UZN file if present.
Gets the page segmentation mode used to OCR the specified image.
The current region of interest being parsed.
Gets the thresholded image that was OCR'd.
Creates a object that is used to iterate over the page's layout as defined by the current .
Creates a object that is used to iterate over the page as defined by the current .
Gets the page's content as plain text.
Gets the page's content as an HOCR text.
The page number (zero based).
True to use XHTML Output, False to HTML Output
The OCR'd output as an HOCR text string.
Gets the page's content as an Alto text.
The page number (zero based).
The OCR'd output as an Alto text string.
Gets the page's content as a Tsv text.
The page number (zero based).
The OCR'd output as a Tsv text string.
Gets the page's content as a Box text.
The page number (zero based).
The OCR'd output as a Box text string.
Gets the page's content as a LSTMBox text.
The page number (zero based).
The OCR'd output as a LSTMBox text string.
Gets the page's content as a WordStrBox text.
The page number (zero based).
The OCR'd output as a WordStrBox text string.
Gets the page's content as an UNLV text.
The page number (zero based).
The OCR'd output as an UNLV text string.
Get's the mean confidence that as a percentage of the recognized text.
Get segmented regions at specified page iterator level.
PageIteratorLevel enum
Detects the page orientation, with corresponding confidence when using .
If using full page segmentation mode (i.e. AutoOsd) then consider using instead as this also provides a
deskew angle which isn't available when just performing orientation detection.
The page orientation.
The confidence level of the orientation (15 is reasonably confident).
Detects the page orientation, with corresponding confidence when using .
If using full page segmentation mode (i.e. AutoOsd) then consider using instead as this also provides a
deskew angle which isn't available when just performing orientation detection.
The detected clockwise page rotation in degrees (0, 90, 180, or 270).
The confidence level of the orientation (15 is reasonably confident).
Represents an object that can iterate over tesseract's page structure.
The iterator points to tesseract's internal page structure and is only valid while the Engine instance that created it exists
and has not been subjected to a call to Recognize since the iterator was created.
Moves the iterator to the start of the page.
Moves to the start of the next element at the given level.
Moves the iterator to the next iff the iterator is not currently pointing to the last in the specified (i.e. the last word in the paragraph).
The iterator level.
The page level.
True iff there is another to advance too and the current element is not the last element at the given level; otherwise returns False.
Returns True if the iterator is at the first element at the given level.
A possible use is to determin if a call to next(word) moved to the start of a new paragraph.
Returns True if the iterator is positioned at the last element at the given level.
Gets the bounding rectangle of the current element at the given level.
Gets the baseline of the current element 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.
Gets the element orientation information that the iterator currently points too.
Represents the possible page layou analysis modes.
Orientation and script detection (OSD) only.
Automatic page sementation with orientantion and script detection (OSD).
Automatic page segmentation, but no OSD, or OCR.
Fully automatic page segmentation, but no OSD.
Assume a single column of text of variable sizes.
Assume a single uniform block of vertically aligned text.
Assume a single uniform block of text.
Treat the image as a single text line.
Treat the image as a single word.
Treat the image as a single word in a circle.
Treat the image as a single character.
Sparse text with orientation and script detection.
Treat the image as a single text line, bypassing hacks that are
specific to Tesseract.
Number of enum entries.
A small angle, in radians, for threshold checking. Equal to about 0.06 degrees.
Used to lookup image formats by extension.
Creates a new pix instance using an existing handle to a pix structure.
Note that the resulting instance takes ownership of the data structure.
Saves the image to the specified file.
The path to the file.
The format to use when saving the image, if not specified the file extension is used to guess the format.
Increments this pix's reference count and returns a reference to the same pix data.
A "clone" is simply a reference to an existing pix. It is implemented this way because
image can be large and hence expensive to copy and extra handles need to be made with a simple
policy to avoid double frees and memory leaks.
The general usage protocol is:
- Whenever you want a new reference to an existing call .
-
Always call on all references. This decrements the reference count and
will destroy the pix when the reference count reaches zero.
The pix with it's reference count incremented.
Binarization of the input image based on the passed parameters and the Otsu method
sizeX Desired tile X dimension; actual size may vary.
sizeY Desired tile Y dimension; actual size may vary.
smoothX Half-width of convolution kernel applied to threshold array: use 0 for no smoothing.
smoothY Half-height of convolution kernel applied to threshold array: use 0 for no smoothing.
scoreFraction Fraction of the max Otsu score; typ. 0.1 (use 0.0 for standard Otsu).
The binarized image.
Binarization of the input image using the Sauvola local thresholding method.
Note: The source image must be 8 bpp grayscale; not colormapped.
Notes
- The window width and height are 2 * + 1. The minimum value for is 2; typically it is >= 7.
- The local statistics, measured over the window, are the average and standard deviation.
-
The measurements of the mean and standard deviation are performed inside a border of ( + 1) pixels.
If source pix does not have these added border pixels, use = True to add it here; otherwise use
= False.
-
The Sauvola threshold is determined from the formula: t = m * (1 - k * (1 - s / 128)) where t = local threshold, m = local mean,
k = , and s = local standard deviation which is maximised at 127.5 when half the samples are 0 and the other
half are 255.
-
The basic idea of Niblack and Sauvola binarization is that the local threshold should be less than the median value,
and the larger the variance, the closer to the median it should be chosen. Typical values for k are between 0.2 and 0.5.
the window half-width for measuring local statistics.
The factor for reducing threshold due to variances greater than or equal to zero (0). Typically around 0.35.
If True add a border of width ( + 1) on all sides.
The binarized image.
Binarization of the input image using the Sauvola local thresholding method on tiles
of the source image.
Note: The source image must be 8 bpp grayscale; not colormapped.
A tiled version of Sauvola can become neccisary for large source images (over 16M pixels) because:
* The mean value accumulator is a uint32, overflow can occur for an image with more than 16M pixels.
* The mean value accumulator array for 16M pixels is 64 MB. While the mean square accumulator array for 16M pixels is 128 MB.
Using tiles reduces the size of these arrays.
* Each tile can be processed independently, in parallel, on a multicore processor.
The window half-width for measuring local statistics
The factor for reducing threshold due to variances greater than or equal to zero (0). Typically around 0.35.
The number of tiles to subdivide the source image into on the x-axis.
The number of tiles to subdivide the source image into on the y-axis.
THe binarized image.
Conversion from RBG to 8bpp grayscale using the specified weights. Note red, green, blue weights should add up to 1.0.
Red weight
Green weight
Blue weight
The Grayscale pix.
Conversion from RBG to 8bpp grayscale.
The Grayscale pix.
Removes horizontal lines from a grayscale image.
The algorithm is based on Leptonica lineremoval.c
example.
See line-removal.
image with lines removed
HMT (with just misses) for speckle up to 2x2
"oooo"
"oC o"
"o o"
"oooo"
HMT (with just misses) for speckle up to 3x3
"oC o"
"o o"
"o o"
"ooooo"
Reduces speckle noise in image. The algorithm is based on Leptonica
speckle_reg.c
example demonstrating morphological method of
removing speckle.
hit-miss sels in 2D layout; SEL_STR2 and SEL_STR3 are predefined values
2 for 2x2, 3 for 3x3
Determines the scew angle and if confidence is high enough returns the descewed image as the result, otherwise returns clone of original image.
This binarizes if necessary and finds the skew angle. If the
angle is large enough and there is sufficient confidence,
it returns a deskewed image; otherwise, it returns a clone.
Returns deskewed image if confidence was high enough, otherwise returns clone of original pix.
Determines the scew angle and if confidence is high enough returns the descewed image as the result, otherwise returns clone of original image.
This binarizes if necessary and finds the skew angle. If the
angle is large enough and there is sufficient confidence,
it returns a deskewed image; otherwise, it returns a clone.
The scew angle and confidence
Returns deskewed image if confidence was high enough, otherwise returns clone of original pix.
Determines the scew angle and if confidence is high enough returns the descewed image as the result, otherwise returns clone of original image.
This binarizes if necessary and finds the skew angle. If the
angle is large enough and there is sufficient confidence,
it returns a deskewed image; otherwise, it returns a clone.
The reduction factor used by the binary search, can be 1, 2, or 4.
The scew angle and confidence
Returns deskewed image if confidence was high enough, otherwise returns clone of original pix.
Determines the scew angle and if confidence is high enough returns the descewed image as the result, otherwise returns clone of original image.
This binarizes if necessary and finds the skew angle. If the
angle is large enough and there is sufficient confidence,
it returns a deskewed image; otherwise, it returns a clone.
linear sweep parameters
The reduction factor used by the binary search, can be 1, 2, or 4.
The threshold value used for binarizing the image.
The scew angle and confidence
Returns deskewed image if confidence was high enough, otherwise returns clone of original pix.
Creates a new image by rotating this image about it's centre.
Please note the following:
-
Rotation will bring in either white or black pixels, as specified by from
the outside as required.
- Above 20 degrees, sampling rotation will be used if shear was requested.
- Colormaps are removed for rotation by area map and shear.
-
The resulting image can be expanded so that no image pixels are lost. To invoke expansion,
input the original width and height. For repeated rotation, use of the original width and heigh allows
expansion to stop at the maximum required size which is a square of side = sqrt(w*w + h*h).
Please note there is an implicit assumption about RGB component ordering.
The angle to rotate by, in radians; clockwise is positive.
The rotation method to use.
The fill color to use for pixels that are brought in from the outside.
The original width; use 0 to avoid embedding
The original height; use 0 to avoid embedding
The image rotated around it's centre.
90 degree rotation.
1 = clockwise, -1 = counter-clockwise
rotated image
Inverts pix.
Top-level conversion to 8 bpp.
Scales the current pix by the specified and factors returning a new of the same depth.
The scaled image.
This function scales 32 bpp RGB; 2, 4 or 8 bpp palette color;
2, 4, 8 or 16 bpp gray; and binary images.
When the input has palette color, the colormap is removed and
the result is either 8 bpp gray or 32 bpp RGB, depending on whether
the colormap has color entries. Images with 2, 4 or 16 bpp are
converted to 8 bpp.
Because Scale() is meant to be a very simple interface to a
number of scaling functions, including the use of unsharp masking,
the type of scaling and the sharpening parameters are chosen
by default. Grayscale and color images are scaled using one
of four methods, depending on the scale factors:
-
antialiased subsampling (lowpass filtering followed by
subsampling, implemented here by area mapping), for scale factors
less than 0.2
-
antialiased subsampling with sharpening, for scale factors
between 0.2 and 0.7.
-
linear interpolation with sharpening, for scale factors between
0.7 and 1.4.
-
linear interpolation without sharpening, for scale factors >= 1.4.
One could use subsampling for scale factors very close to 1.0,
because it preserves sharp edges. Linear interpolation blurs
edges because the dest pixels will typically straddle two src edge
pixels. Subsmpling removes entire columns and rows, so the edge is
not blurred. However, there are two reasons for not doing this.
First, it moves edges, so that a straight line at a large angle to
both horizontal and vertical will have noticable kinks where
horizontal and vertical rasters are removed. Second, although it
is very fast, you get good results on sharp edges by applying
a sharpening filter.
For images with sharp edges, sharpening substantially improves the
image quality for scale factors between about 0.2 and about 2.0.
pixScale() uses a small amount of sharpening by default because
it strengthens edge pixels that are weak due to anti-aliasing.
The default sharpening factors are:
-
-
for scaling factors >= 0.7: sharpfract = 0.4 sharpwidth = 2
The cases where the sharpening halfwidth is 1 or 2 have special
implementations and are about twice as fast as the general case.
However, sharpening is computationally expensive, and one needs
to consider the speed-quality tradeoff:
-
For upscaling of RGB images, linear interpolation plus default
sharpening is about 5 times slower than upscaling alone.
-
For downscaling, area mapping plus default sharpening is
about 10 times slower than downscaling alone.
When the scale factor is larger than 1.4, the cost of sharpening,
which is proportional to image area, is very large compared to the
incremental quality improvement, so we cut off the default use of
sharpening at 1.4. Thus, for scale factors greater than 1.4,
pixScale() only does linear interpolation.
In many situations you will get a satisfactory result by scaling
without sharpening: call pixScaleGeneral() with @sharpfract = 0.0.
Alternatively, if you wish to sharpen but not use the default
value, first call pixScaleGeneral() with @sharpfract = 0.0, and
then sharpen explicitly using pixUnsharpMasking().
Binary images are scaled to binary by sampling the closest pixel,
without any low-pass filtering (averaging of neighboring pixels).
This will introduce aliasing for reductions. Aliasing can be
prevented by using pixScaleToGray() instead.
Warning: implicit assumption about RGB component order for LI color scaling
Represents an array of .
Loads the multi-page tiff located at .
Handles enumerating through the in the PixArray.
Gets the handle to the underlying PixA structure.
Gets the number of contained in the array.
Add the specified pix to the end of the pix array.
PixArrayAccessType.Insert is not supported as the managed Pix object will attempt to release the pix when
it goes out of scope creating an access exception.
The pix to add.
Determines if a clone or copy of the pix is inserted into the array.
Removes the pix located at index.
Notes:
* This shifts pixa[i] --> pixa[i - 1] for all i > index.
* Do not use on large arrays as the functionality is O(n).
* The corresponding box is removed as well, if it exists.
The index of the pix to remove.
Destroys ever pix in the array.
Gets the located at using the specified .
The index of the pix (zero based).
The used to retrieve the , only Clone or Copy are allowed.
The retrieved .
Returns a that iterates the the array of .
When done with the enumerator you must call to release any unmanaged resources.
However if your using the enumerator in a foreach loop, this is done for you automatically by .Net. This also means
that any returned from the enumerator cannot safely be used outside a foreach loop (or after Dispose has been
called on the enumerator). If you do indeed need the pix after the enumerator has been disposed of you must clone it using
.
A that iterates the the array of .
Determines how of a structure are accessed.
Stuff it in; no copy, clone or copy-clone.
Make/use a copy of the object.
Make/use clone (ref count) of the object
Make a new object and fill with with clones of each object in the array(s)
Represents a colormap.
Once the colormap is assigned to a pix it is owned by that pix and will be disposed off automatically
when the pix is disposed off.
Pointer to the data.
Number of 32-bit words per line.
Swaps the bytes on little-endian platforms within a word; bytes 0 and 3 swapped, and bytes `1 and 2 are swapped.
This is required for little-endians in situations where we convert from a serialized byte order that is in raster order,
as one typically has in file formats, to one with MSB-to-the-left in each 32-bit word, or v.v. See
Gets the pixel value for a 1bpp image.
Sets the pixel value for a 1bpp image.
Gets the pixel value for a 2bpp image.
Sets the pixel value for a 2bpp image.
Gets the pixel value for a 4bpp image.
Sets the pixel value for a 4bpp image.
Gets the pixel value for a 8bpp image.
Sets the pixel value for a 8bpp image.
Gets the pixel value for a 16bpp image.
Sets the pixel value for a 16bpp image.
Gets the pixel value for a 32bpp image.
Sets the pixel value for a 32bpp image.
The type is not known yet, keep as first element.
The text is inside a column.
The text spans more than one column.
The text is in a cross-column pull-out region.
The partion belongs to an equation region..
The partion has an inline equation.
The partion belongs to a Table region.
Text line runs vertically.
Text that belongs to an image.
Image that lives inside a column.
Image that spans more than one column.
Image that is in a cross-column pull-out region.
Lies outside any column.
Gets an instance of a choice iterator using the current symbol of interest. The ChoiceIterator allows a one-shot iteration over the
choices for this symbol and after that is is useless.
an instance of a Choice Iterator
Rendered formats supported by Tesseract.
Represents a native result renderer (e.g. text, pdf, etc).
Note that the ResultRenderer is explictly responsible for managing the
renderer hierarchy. This gets around a number of difficult issues such
as keeping track of what the next renderer is and how to manage the memory.
Creates renderers for specified output formats.
The directory containing the pdf font data, normally same as your tessdata directory.
Creates a result renderer that render that generates a searchable
pdf file from tesseract's output.
The filename of the pdf file to be generated without the file extension.
The directory containing the pdf font data, normally same as your tessdata directory.
skip images if set
Creates a result renderer that render that generates UTF-8 encoded text
file from tesseract's output.
The path to the text file to be generated without the file extension.
Creates a result renderer that render that generates a HOCR
file from tesseract's output.
The path to the hocr file to be generated without the file extension.
Determines if the generated HOCR file includes font information or not.
Creates a result renderer that render that generates a unlv
file from tesseract's output.
The path to the unlv file to be created without the file extension.
Creates a result renderer that render that generates an Alto
file from tesseract's output.
The path to the Alto file to be created without the file extension.
Creates a result renderer that render that generates a Tsv
file from tesseract's output.
The path to the Tsv file to be created without the file extension.
Creates a result renderer that render that generates a unlv
file from tesseract's output.
The path to the unlv file to be created without the file extension.
Creates a result renderer that render that generates a unlv
file from tesseract's output.
The path to the unlv file to be created without the file extension.
Creates a result renderer that render that generates a box text file from tesseract's output.
The path to the box file to be created without the file extension.
Ensures the renderer's EndDocument when disposed off.
Initialise the render to use the specified native result renderer.
Add the page to the current document.
True if the page was successfully added to the result renderer; otherwise false.
Begins a new document with the specified .
The (ANSI) title of the new document.
A handle that when disposed of ends the current document.
What colour pixels should be used for the outside?
Bring in white pixels from the outside.
Bring in black pixels from the outside.
Represents the method used to rotate an image.
Use area map rotation, if possible.
Use shear rotation.
Use sampling.
Represents the parameters for a sweep search used by scew algorithms.
The tesseract OCR engine.
Creates a new instance of using the mode.
The parameter should point to the directory that contains the 'tessdata' folder
for example if your tesseract language data is installed in C:\Tesseract\tessdata the value of datapath should
be C:\Tesseract. Note that tesseract will use the value of the TESSDATA_PREFIX environment variable if defined,
effectively ignoring the value of parameter.
The path to the parent directory that contains the 'tessdata' directory, ignored if the TESSDATA_PREFIX environment variable is defined.
The language to load, for example 'eng' for English.
Creates a new instance of with the specified
using the Default Engine Mode.
The parameter should point to the directory that contains the 'tessdata' folder
for example if your tesseract language data is installed in C:\Tesseract\tessdata the value of datapath should
be C:\Tesseract. Note that tesseract will use the value of the TESSDATA_PREFIX environment variable if defined,
effectively ignoring the value of parameter.
Note: That the config files MUST be encoded without the BOM using unix end of line characters.
The path to the parent directory that contains the 'tessdata' directory, ignored if the TESSDATA_PREFIX environment variable is defined.
The language to load, for example 'eng' for English.
An optional tesseract configuration file that is encoded using UTF8 without BOM
with Unix end of line characters you can use an advanced text editor such as Notepad++ to accomplish this.
Creates a new instance of with the specified
using the Default Engine Mode.
The parameter should point to the directory that contains the 'tessdata' folder
for example if your tesseract language data is installed in C:\Tesseract\tessdata the value of datapath should
be C:\Tesseract. Note that tesseract will use the value of the TESSDATA_PREFIX environment variable if defined,
effectively ignoring the value of parameter.
The path to the parent directory that contains the 'tessdata' directory, ignored if the TESSDATA_PREFIX environment variable is defined.
The language to load, for example 'eng' for English.
An optional sequence of tesseract configuration files to load, encoded using UTF8 without BOM
with Unix end of line characters you can use an advanced text editor such as Notepad++ to accomplish this.
Creates a new instance of with the specified .
The parameter should point to the directory that contains the 'tessdata' folder
for example if your tesseract language data is installed in C:\Tesseract\tessdata the value of datapath should
be C:\Tesseract. Note that tesseract will use the value of the TESSDATA_PREFIX environment variable if defined,
effectively ignoring the value of parameter.
The path to the parent directory that contains the 'tessdata' directory, ignored if the TESSDATA_PREFIX environment variable is defined.
The language to load, for example 'eng' for English.
The value to use when initialising the tesseract engine.
Creates a new instance of with the specified and .
The parameter should point to the directory that contains the 'tessdata' folder
for example if your tesseract language data is installed in C:\Tesseract\tessdata the value of datapath should
be C:\Tesseract. Note that tesseract will use the value of the TESSDATA_PREFIX environment variable if defined,
effectively ignoring the value of parameter.
Note: That the config files MUST be encoded without the BOM using unix end of line characters.
The path to the parent directory that contains the 'tessdata' directory, ignored if the TESSDATA_PREFIX environment variable is defined.
The language to load, for example 'eng' for English.
The value to use when initialising the tesseract engine.
An optional tesseract configuration file that is encoded using UTF8 without BOM
with Unix end of line characters you can use an advanced text editor such as Notepad++ to accomplish this.
Creates a new instance of with the specified and .
The parameter should point to the directory that contains the 'tessdata' folder
for example if your tesseract language data is installed in C:\Tesseract\tessdata the value of datapath should
be C:\Tesseract. Note that tesseract will use the value of the TESSDATA_PREFIX environment variable if defined,
effectively ignoring the value of parameter.
The path to the parent directory that contains the 'tessdata' directory, ignored if the TESSDATA_PREFIX environment variable is defined.
The language to load, for example 'eng' for English.
The value to use when initialising the tesseract engine.
An optional sequence of tesseract configuration files to load, encoded using UTF8 without BOM
with Unix end of line characters you can use an advanced text editor such as Notepad++ to accomplish this.
Creates a new instance of with the specified and .
The parameter should point to the directory that contains the 'tessdata' folder
for example if your tesseract language data is installed in C:\Tesseract\tessdata the value of datapath should
be C:\Tesseract. Note that tesseract will use the value of the TESSDATA_PREFIX environment variable if defined,
effectively ignoring the value of parameter.
The path to the parent directory that contains the 'tessdata' directory, ignored if the TESSDATA_PREFIX environment variable is defined.
The language to load, for example 'eng' for English.
The value to use when initialising the tesseract engine.
An optional sequence of tesseract configuration files to load, encoded using UTF8 without BOM
with Unix end of line characters you can use an advanced text editor such as Notepad++ to accomplish this.
Processes the specific image.
You can only have one result iterator open at any one time.
The image to process.
The page layout analyasis method to use.
Processes a specified region in the image using the specified page layout analysis mode.
You can only have one result iterator open at any one time.
The image to process.
The image region to process.
The page layout analyasis method to use.
A result iterator
Processes the specific image.
You can only have one result iterator open at any one time.
The image to process.
Sets the input file's name, only needed for training or loading a uzn file.
The page layout analyasis method to use.
Processes a specified region in the image using the specified page layout analysis mode.
You can only have one result iterator open at any one time.
The image to process.
Sets the input file's name, only needed for training or loading a uzn file.
The image region to process.
The page layout analyasis method to use.
A result iterator
Ties the specified pix to the lifecycle of a page.
Gets or sets default mode used by .
Sets the value of a string variable.
The name of the variable.
The new value of the variable.
Returns True if successful; otherwise False.
Sets the value of a boolean variable.
The name of the variable.
The new value of the variable.
Returns True if successful; otherwise False.
Sets the value of a integer variable.
The name of the variable.
The new value of the variable.
Returns True if successful; otherwise False.
Sets the value of a double variable.
The name of the variable.
The new value of the variable.
Returns True if successful; otherwise False.
Attempts to retrieve the value for a boolean variable.
The name of the variable.
The current value of the variable.
Returns True if successful; otherwise False.
Attempts to retrieve the value for a double variable.
The name of the variable.
The current value of the variable.
Returns True if successful; otherwise False.
Attempts to retrieve the value for an integer variable.
The name of the variable.
The current value of the variable.
Returns True if successful; otherwise False.
Attempts to retrieve the value for a string variable.
The name of the variable.
The current value of the variable.
Returns True if successful; otherwise False.
Attempts to print the variables to the file.
Gets or sets a search path that will be checked first when attempting to load the Tesseract and Leptonica dlls.
This search path should not include the platform component as this will automatically be appended to the string based on the detected platform.
Desctiption of TesseractException.
The text lines are read in the given sequence.
For example in English the order is top-to-bottom. Chinese vertical text lines
are read right-to-left. While Mongolian is written in vertical columns
like Chinese but read left-to-right.
Note that only some combinations makes sense for example implies
.
The text lines form vertical columns ordered left to right.
The text lines form vertical columns ordered right to left.
The text lines form horizontal columns ordered top to bottom.
The grapheme cluster within a line of text are laid out logically in this direction,
judged when looking at the text line rotated so that Orientation is "page up".
The text line from the left hand side to the right hand side when the page is rotated so it's orientation is .
The text line from the right hand side to the left hand side when the page is rotated so it's orientation is .
The text line from the top to the bottom of the page when the page is rotated so it's orientation is .
Special test for web applications.
Note that this makes a couple of assumptions these being:
- That the current application domain's location for web applications corresponds to the web applications root directory.
- That the tesseract\leptonica dlls reside in the corresponding x86 or x64 directories in the bin directory under the apps root directory.