OcrEngine Class |
OcrEngine represents the functionality of an OCR engine. It is an abstract class and
cannot be constructed directly, but it provides much of the functionality needed in subclasses.
Inheritance HierarchySystemObject
Atalasoft.OcrOcrEngine
Atalasoft.Ocr.GlyphReaderGlyphReaderEngine
Atalasoft.OcrOmniPageEngineBase
Atalasoft.Ocr.TesseractTesseract3Engine
Atalasoft.Ocr.TesseractTesseract5Engine
Atalasoft.Ocr.VotingVotingEngine
Atalasoft.OcrOcrEngine
Atalasoft.Ocr.GlyphReaderGlyphReaderEngine
Atalasoft.OcrOmniPageEngineBase
Atalasoft.Ocr.TesseractTesseract3Engine
Atalasoft.Ocr.TesseractTesseract5Engine
Atalasoft.Ocr.VotingVotingEngine
Namespace: Atalasoft.Ocr
Assembly: Atalasoft.dotImage.Ocr (in Atalasoft.dotImage.Ocr.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe OcrEngine type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OcrEngine | Initializes a new instance of the OcrEngine class. |
| OcrEngine(IOcrFactory) | Initializes a new instance of the OcrEngine class using provided IOcrFactory. |
Properties| Name | Description | |
|---|---|---|
 | AvailablePreprocessingOptions | This property returns the available set of image preprocessing options for this OcrEngine. |
| CanRecognizeBarcodes | Returns true if this engine supports barcode recognition. |
| CanUseSymbolSet | Gets a value indicating whether engine can use symbol set or not. |
| DefaultPreprocessingOptions | Returns the default preprocessing options for this OcrEngine. |
| DefaultRecognitionCulture | Returns the default recognition language for this engine. |
| Factory | This property provides an object of type IOcrFactory for the construction of page and
document elements. |
| FontBuilder | This property provides a font builder that will be used for page construction. |
| FontMapper | This property provides a font mapper that will be used for page construction. |
| PreprocessingOptions | The property provides the preprocessing options to be used for this engine. |
| RecognitionCulture | Sets or gets the recognition language for this engine. |
| RecognitionCulturesList | Gets or sets the list of cultures to be used during recognition. |
| RecognizeBarcodes | When true, will recognize barcodes as well as text if the engine supports barcode recognition. |
| SupportedBarcodeSymbologies | Gets a list of barcode symbologies that are supported by this OcrDocument (if any). |
| SupportMultiCultureRecognition |
Gets the value indicating whether the OCR engine supports multiple recognition cultures.
|
| Translators | This property provides access to a TranslatorCollection object used by the engine to
translate images to documents. |
Methods| Name | Description | |
|---|---|---|
 | CanStream | Determines if it is possible to write a particular output format to a Stream. |
| CanTranslate | Determines if it is possible to translate a document to a particular output format. |
| CulturesMatch |
Detects whether specified cultures match.
|
| Dispose | Dispose memory used by the OcrEngine. |
| Dispose(Boolean) | Releases the unmanaged resources used by the OcrEngine and optionally releases the managed resources |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | OcrEngine finalizer.
(Overrides ObjectFinalize.) |
| GetAvailablePreprocessingOptions |
Gets available preprocessing options for this OcrEngine |
| GetCanRecognizeBarcodes |
Gets the value indicating whether the engine can recognize barcodes or not.
|
| GetDefaultPreprocessingOptions |
Gets default preprocessing options for this OcrEngine |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLicenseFlag |
Retrieves value of the flag with specified name.
|
| GetSupportedBarcodeSymbologies | Returns the barcode symbologies supported by this engine. |
| GetSupportedRecognitionCultures | Returns an array of supported recognition languages for this engine |
| GetSymbolSet | Returns an engine-specific symbol set matching string from a standard symbol set. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HandleDeskew | Handles the process of deskewing an image. |
| HasPageLocationHandler | Determines whether or not events have been installed for page location. |
| Initialize | Initialize the engine. |
| IsMultiCultureRecognitionSupported |
Tells whether the OCR engine supports multiple recognition cultures.
|
| MakeBinarizeCommand | Returns a new ImageCommand that will binarize an image in the HandleDeskew method |
| MakeDeskewCommand | Returns a new ImageCommand that will deskew an image. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OcrBarcodeSymbologyIsSupported | Returns true if a given barcode symbology is supported. |
| OnDocumentProgress | Fire the DocumentProgress event. |
| OnImageIntroduction |
Raises the ImageIntroduction event.
|
| OnImageSendOff |
Raises the ImageSendOff event.
|
| OnImageTransformation |
Raises the ImageTransformation event.
|
| OnPageConstructed | Fire the PageConstructed event. |
| OnPageConstructing | Fire the PageConstructing event. |
| OnPageLocation | Fire the PageLocation event. |
| OnPageProgress | Fire the page progress event. |
| RecognitionCultureChanged |
Occurs when a recognition culture list changes.
|
| RecognitionCultureSupported | Indicates whether or not this engine will support a given recognition culture |
| Recognize(AtalaImage) | Recognize text in an AtalaImage, transforming it into an OcrPage object. |
| Recognize(ImageSource) | Recognize a set of AtalaImage objects as an entire document. |
| Recognize(AtalaImage, Rectangle) | Recognize only within a specific rectangle in an AtalaImage. |
| Recognize(AtalaImage, Int32) |
Recognize text in an AtalaImage
|
| Recognize(ImageSource, OcrDocument, IForeignTranslator, Object) |
Recognize a set of AtalaImage objects as an entire document.
|
| ShutDown | Terminates the engine. |
| Supported | Obsolete.
Provides a list of all mime types supported by Translators in this engine.
|
| SupportedMimeTypes | Provides a list of all mime types supported by Translators in this engine. |
| SupportingTranslator |
Finds a translator that supports translation to the requested output type.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToSymbolSet | Converts a set of unique characters to a engine-specific symbol matching set. |
| Translate(ImageSource, String, Stream) | Translates a collection of images to the specified mime type, writing the output to the given stream.
This method attempts to select the best translator for the job. |
| Translate(ImageSource, String, String) | Translates a collection of images to the specified mime type, writing the output to the given path. This
method attempts to select the best translator for the job. |
| Translate(ImageSource, String, Stream, ITranslator) | Translates a collection of images to the specified mime type, writing the output to the given stream using
the supplied translator. |
| Translate(ImageSource, String, String, ITranslator) | Translates a collection of images to the specified mime type, writing the output to the given path using
the supplied translator. |
Events| Name | Description | |
|---|---|---|
 | DocumentProgress | This event is used to publish progress made in recognition of a set of images. |
| ImageIntroduction | This event is raised before ImageTransformation in order to allow the document to
be pre-processed prior to deskew. |
| ImageSendOff | This event is raised before the OCR process starts, and after ImageTransformation for OCR
pre-processing. |
| ImageTransformation | This event is raised just after the image is deskewed and before ImageSendOff is
raised. |
| PageConstructed | This event is used to publish the page that has just been constructed. |
| PageConstructing | This event is used to publish the page that is in the process of being populated. |
| PageLocation | This event is used to publish OcrRegions that have been identified within an image. |
| PageProgress | This event is used to publish progress made in the recognition of a page. |
See Also