Index

D

Type	Description
`download_pdf_font`	Download the PDF font file needed to create PDF images.
`download_languages`	Download the language data files needed to OCR an image.

G

Type	Description
`GitHubProject`	Describes a GitHub repository to download data files from.

I

Type	Description
`IFF`	Image enumeration to identify image types.

L

Type	Description
`lept_version`	Retrieve the version of the Leptonica library.

P

Type	Description
`Pix`	Picture object to perform OCR on.
`PixBox`	Picture box to reference an area inside a `Pix` object.
`pix_delete!`	Manually free a image.
`pix_get_depth`	Retrieve the color bit depth of the image in BPP.
`pix_get_dimensions`	Retrieve the image width, height, and color bit depth.
`pix_read`	Read an image from disk, memory, or a stream.
`pix_read_bmp`	Read a BMP image from disk, memory, or a stream.
`pix_read_gif`	Read a GIF image from disk, memory, or a stream.
`pix_read_jp2k`	Read a JP2K image from disk, memory, or a stream.
`pix_read_jpeg`	Read a JPEG image from disk, memory, or a stream.
`pix_read_png`	Read a PNG image from disk, memory, or a stream.
`pix_read_pnm`	Read a PNM image from disk, memory, or a stream.
`pix_read_spix`	Read a SPIX image from disk, memory, or a stream.
`pix_read_tiff`	Read a TIFF image from disk, memory, or a stream.
`pix_read_webp`	Read a WEBP image from disk, memory, or a stream.
`pix_write`	Write an image to disk, memory or a stream.
`pix_write_implied_format`	Write an image to disk.
`pix_write_bmp`	Write image to disk, memory or a stream as a BMP file.
`pix_write_gif`	Write image to disk, memory or a stream as a GIF file.
`pix_write_jp2k`	Write image to disk, memory or a stream as a JP2K file.
`pix_write_jpeg`	Write image to disk, memory or a stream as a JPEG file.
`pix_write_pam`	Write image to disk, memory or a stream as a PAM file.
`pix_write_pdf`	Write image to disk, memory or a stream as a PDF file.
`pix_write_png`	Write image to disk, memory or a stream as a PNG file.
`pix_write_pnm`	Write image to disk, memory or a stream as a PNM file.
`pix_write_ps`	Write image to disk, memory or a stream as a PostScript file.
`pix_write_spix`	Write image to disk, memory or a stream as a SPIX file.
`pix_write_tiff`	Write image to disk, memory or a stream as a TIFF file.
`pix_write_webp`	Write image to disk, memory or a stream as a WEBP file.

S

Type	Description
`sample_pix`	Create a sample image with text for testing.
`sample_tiff`	Create a sample TIFF file with text for testing.

T

Type	Description
`TessInst`	Tesseract object to perform OCR functions.
`TessOutput`	Holds the result of an operation that will be returned later.
`TessParam`	Object that describes a parameter than can be set in TessInst.
`TessPipeline`	Object used to process a sequence of pages.
`tess_alto`	Extract the text on the image as an ALTO xml format.
`tess_confidences`	Retrieve the condidences of the OCR results.
`tess_delete!`	Manually free a `TessInst` or `TessPipeline` object.
`tess_available_languages`	Retrieve the list of languages that can be loaded.
`tess_get_param`	Retrieve the value of a parameter from the Tesseract engine.
`tess_hocr`	Extract the text on the image as a HOCR xml format.
`tess_image`	Set the image to OCR.
`tess_init`	Change the languages to OCR.
`tess_initialized_languages`	Retrieve the list of languages loaded by `tess_init`.
`tess_loaded_languages`	Retrieve the list of languages actually loaded.
`tess_lstm_box`	Extract the text on the image as a LSTM box text format.
`tess_params`	Retrieve the list of parameters as a string.
`tess_params_parsed`	Retrieve the list of parameters as an array of `TessParam` objects.
`tess_parsed_tsv`	Extract the text on the image as a parsed TSV format.
`tess_pipeline_alto`	Add an ALTO XML output renderer to a Pipeline.
`tess_pipeline_hocr`	Add a HOCR XML output renderer to a Pipeline.
`tess_pipeline_lstm_box`	Add a LSTM BOX output renderer to a Pipeline.
`tess_pipeline_pdf`	Add a PDF output renderer to a Pipeline.
`tess_pipeline_text`	Add a text output renderer to a Pipeline.
`tess_pipeline_tsv`	Add a Tabbed Separated Value output renderer to a Pipeline.
`tess_pipeline_unlv`	Add a UNLV/UTF-8 renderer to a Pipeline.
`tess_pipeline_unlv_latin1`	Add a UNLV/Latin1 renderer to a Pipeline.
`tess_pipeline_word_box`	Add a Word BOX output renderer to a Pipeline.
`tess_read_config`	Read and set variables from the specified configuration file.
`tess_read_debug_config`	Read and set the debug variables from the specified configuration file.
`tess_recognize`	Perform the OCR extraction on the image.
`tess_resolution`	Set the resolution of the image to OCR.
`tess_run_pipeline`	Execute the pipeline, processing multiple pictures.
`tess_set_param`	Set the value of a parameter from the Tesseract engine.
`tess_text`	Extract the text on the image as text.
`tess_text_box`	Extract the text on the image in text box format.
`tess_tsv`	Extract the text on the image in the TSV text format.
`Tsv`	Object containing the details of a Tabbed Separated Value (TSV) line.
`tess_unlv`	Extract the text on the image in the UNLV UTF-8 text format.
`tess_unlv_latin1`	Extract the text on the image in the UNLV Latin1 format.
`tess_word_box`	Extract the text on the image in word box text format.

U

Type	Description
`update_pdf_font`	Update the PDF font file needed to create PDF images.
`update_languages`	Update the language data files needed to OCR an image.