Namespace IronOcr

Classes

ExtensionAdvancedScanException

Installation

A static class providing everything needed to configure the installation and licensing of IronOCR

Installation.LoggingModes

Logging modes. You may use any combination of these flags to enable logging.

IronTesseract

IronTesseract is a comprehensive managed class for performing Tesseract OCR in .Net applications.

IronTesseract natively supports Tesseract 3, 4 and 5 engines, and will automatically install all required binaries and language packs (tessdata) files.

License

Allows IronOCR license keys to be applied globally across an application.

OcrDocAdvancedResult

Result from ReadDocumentAdvanced(OcrInputBase)

Give an access to: Text, Confidence, Tables, and NoOutlineRegions

OcrFilters

A collection of OCR Image filter for processing Images.

OcrImageInput

OCR input based on image data

OcrInput

Stores OCR input data and allows OCR of PDF documents or any image format.

Also provides various image filter methods which can improve OCR accuracy.

OcrInput.Page

Represents a page within an OcrInput object. This can relate to one of many images appended, pages of a PDF or TIFF, or frames of a GIF.

OcrInputBase

Base class for OCR input variants

OcrInputFilterWizard

OcrInputFilterWizard provides a brute-force filter assessment tool to try filter combinations within IronOCR to get the highest IronTesseract confidence.

Simply call the Run(String, out String, out Double, IronTesseract) method with a image filepath, and optionally a Tesseract.

Out variables include the result of the best combination's read, and the best confidence.

Example use: var results = OcrInputFilterWizard.Run("img.png", out string text, out double confidence);

OcrInputPage

A full page (one image) within an OcrInput object.

OcrLanguage

The natural language in which OCR documents will be read.

Any number of languages may be used simultaneously using the IronTessseract.AddSecondaryLanguage() Method.

To use a custom Tesseract language file (.traineddata) please see the IronTessseract.UseCustomLanguageFile() Method

OcrLicensePlateResult

Result from ReadLicensePlate(OcrInputBase)

Give an access to: Text, Confidence, and Licenseplate.

OcrPageOrientationResult

Represents the result of page orientation detection.

OcrPassportResult

Result from ReadPassport(OcrInputBase)

Give an access to: Text, Confidence, and PassportInfo.

OcrPdfInput

OCR input based on PDF data

OcrPhotoResult

Result from ReadPhoto(OcrInputBase) or ReadScreenShot(OcrInputBase)

Give an access to: Text, Confidence, and TextRegions.

OcrPhotoResult.TextRegion

Text region struct

OcrReadTask

Represents an asynchronous OCR (Optical Character Recognition) read task.

OcrResult

A full document object model (DOM) for results when IronTesseract reads an image or OcrInput.

Gives access to Text, Pages, Words, Paragraphs, Lines, Words, Characters, Images, Barcodes, Coordinates, Font information in granular detail.

OcrResult.Barcode

Represents a barcode discovered during OCR. See ReadBarCodes which must be set true to use this feature.

OcrResult.BarcodeEncoding

Barcode Encoding Types.

OcrResult.Block

Represents a block of text containing zero or more paragraphs.

OcrResult.Character

Represents a single character (char) of text.

OcrResult.Choice

OcrResult.Line

A line of text within an Paragraph

OcrResult.OcrFont

Detailed font information returned when using Tesseract OEM engine modes.

OcrResult.OcrResultElement

Lowest level of abstract OcrResult DOM element. All result objects extend from this including OcrResult.Barcode, OcrResult.Character, OcrResult.Word, OcrResult.Line, OcrResult.Paragraph ...

OcrResult.OcrResultTextElement

An abstract class representing discovered OCR DOM text elements such as OcrResult.Character, OcrResult.Word, OcrResult.Line, OcrResult.Paragraph ...

OcrResult.Page

Represents a single page within an OcrResult object.

OcrResult.Paragraph

Represents a paragraph of text with an OcrResult object.

OcrResult.Table

Represents a Visual Table with Borders discovered during OCR.
To enable table reading, set IronTesseract's Configuration.ReadDataTables to true.

 var Ocr = new IronTesseract();
 Ocr.Configuration.ReadDataTables = true;

Interfaces

IOcrPageObjectModel

Object model for a PDF page