OmniPageEngineBase Class |
Inheritance HierarchySystemObject
Atalasoft.OcrOcrEngine
Atalasoft.OcrOmniPageEngineBase
Atalasoft.Ocr.OmniPageOmniPageEngine
Atalasoft.OcrOcrEngine
Atalasoft.OcrOmniPageEngineBase
Atalasoft.Ocr.OmniPageOmniPageEngine
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 OmniPageEngineBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OmniPageEngineBase | Initializes a new instance of the OmniPageEngineBase class |
Properties| Name | Description | |
|---|---|---|
 | AvailablePreprocessingOptions | This property returns the available set of image preprocessing options for this OcrEngine. (Inherited from OcrEngine.) |
| CanRecognizeBarcodes | Returns true if this engine supports barcode recognition. (Inherited from OcrEngine.) |
| CanUseSymbolSet | Gets a value indicating whether engine can use symbol set or not. (Inherited from OcrEngine.) |
| DefaultPreprocessingOptions | Returns the default preprocessing options for this OcrEngine. (Inherited from OcrEngine.) |
| DefaultRecognitionCulture | Returns the default recognition language for this engine. (Inherited from OcrEngine.) |
| Factory | This property provides an object of type IOcrFactory for the construction of page and
document elements. (Inherited from OcrEngine.) |
| FontBuilder | This property provides a font builder that will be used for page construction. (Inherited from OcrEngine.) |
| FontMapper | This property provides a font mapper that will be used for page construction. (Inherited from OcrEngine.) |
| PreprocessingOptions | The property provides the preprocessing options to be used for this engine. (Inherited from OcrEngine.) |
| RecognitionCulture | Sets or gets the recognition language for this engine. (Inherited from OcrEngine.) |
| RecognitionCulturesList | Gets or sets the list of cultures to be used during recognition. (Inherited from OcrEngine.) |
| RecognizeBarcodes | When true, will recognize barcodes as well as text if the engine supports barcode recognition. (Inherited from OcrEngine.) |
| SupportedBarcodeSymbologies | Gets a list of barcode symbologies that are supported by this OcrDocument (if any). (Inherited from OcrEngine.) |
| SupportMultiCultureRecognition |
Gets the value indicating whether the OCR engine supports multiple recognition cultures.
(Inherited from OcrEngine.) |
| Translators | This property provides access to a TranslatorCollection object used by the engine to
translate images to documents. (Inherited from OcrEngine.) |
Methods| Name | Description | |
|---|---|---|
 | CanStream | Checks to see if this translator is capable of streaming. |
| CanStream(String) | Determines if it is possible to write a particular output format to a Stream. (Inherited from OcrEngine.) |
| CanTranslate | Determines if it is possible to translate a document to a particular output format. (Inherited from OcrEngine.) |
| CulturesMatch |
Detects whether specified cultures match.
(Inherited from OcrEngine.) |
| Dispose | Dispose memory used by the OcrEngine. (Inherited from OcrEngine.) |
| Dispose(Boolean) | (Inherited from OcrEngine.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | OcrEngine finalizer.
(Inherited from OcrEngine.) |
| GetAvailablePreprocessingOptions |
Gets available preprocessing options for this OcrEngine (Inherited from OcrEngine.) |
| GetCanRecognizeBarcodes |
Gets the value indicating whether the engine can recognize barcodes or not.
(Inherited from OcrEngine.) |
| GetDefaultPreprocessingOptions |
Gets default preprocessing options for this OcrEngine (Inherited from OcrEngine.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLicenseFlag |
Retrieves value of the flag with specified name.
(Inherited from OcrEngine.) |
| GetSupportedBarcodeSymbologies | Returns the barcode symbologies supported by this engine. (Inherited from OcrEngine.) |
| GetSupportedRecognitionCultures | Returns an array of supported recognition languages for this engine (Inherited from OcrEngine.) |
| GetSymbolSet | Returns an engine-specific symbol set matching string from a standard symbol set. (Inherited from OcrEngine.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HandleDeskew | Handles the process of deskewing an image. (Inherited from OcrEngine.) |
| HasPageLocationHandler | Determines whether or not events have been installed for page location. (Inherited from OcrEngine.) |
| INativeTranslator_Translate(ImageSource, String, Stream) | |
| INativeTranslator_Translate(ImageSource, String, String) | |
| Initialize | Initialize the engine. (Inherited from OcrEngine.) |
| IsMultiCultureRecognitionSupported |
Tells whether the OCR engine supports multiple recognition cultures.
(Inherited from OcrEngine.) |
| MakeBinarizeCommand | Returns a new ImageCommand that will binarize an image in the HandleDeskew method (Inherited from OcrEngine.) |
| MakeDeskewCommand | Returns a new ImageCommand that will deskew an image. (Inherited from OcrEngine.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OcrBarcodeSymbologyIsSupported | Returns true if a given barcode symbology is supported. (Inherited from OcrEngine.) |
| OnDocumentProgress | Fire the DocumentProgress event. (Inherited from OcrEngine.) |
| OnImageIntroduction |
Raises the ImageIntroduction event.
(Inherited from OcrEngine.) |
| OnImageSendOff |
Raises the ImageSendOff event.
(Inherited from OcrEngine.) |
| OnImageTransformation |
Raises the ImageTransformation event.
(Inherited from OcrEngine.) |
| OnPageConstructed | Fire the PageConstructed event. (Inherited from OcrEngine.) |
| OnPageConstructing | Fire the PageConstructing event. (Inherited from OcrEngine.) |
| OnPageLocation | Fire the PageLocation event. (Inherited from OcrEngine.) |
| OnPageProgress | Fire the page progress event. (Inherited from OcrEngine.) |
| RecognitionCultureChanged |
Occurs when a recognition culture list changes.
(Inherited from OcrEngine.) |
| RecognitionCultureSupported | Indicates whether or not this engine will support a given recognition culture (Inherited from OcrEngine.) |
| Recognize(AtalaImage) | Recognize text in an AtalaImage, transforming it into an OcrPage object. (Inherited from OcrEngine.) |
| Recognize(ImageSource) | Recognize a set of AtalaImage objects as an entire document. (Inherited from OcrEngine.) |
| Recognize(AtalaImage, Rectangle) | Recognize only within a specific rectangle in an AtalaImage. |
| Recognize(AtalaImage, Int32) |
Recognize text in an AtalaImage
(Inherited from OcrEngine.) |
| Recognize(ImageSource, OcrDocument, IForeignTranslator, Object) |
Recognize a set of AtalaImage objects as an entire document.
(Inherited from OcrEngine.) |
| ShutDown | Terminates the engine. (Inherited from OcrEngine.) |
| Supported | Get an array of mime types supported by this translator. |
| SupportedMimeTypes | Provides a list of all mime types supported by Translators in this engine. (Inherited from OcrEngine.) |
| SupportingTranslator |
Finds a translator that supports translation to the requested output type.
(Inherited from OcrEngine.) |
| Supports | Checks to see if a specific mime type is supported by this translator. |
| 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. (Inherited from OcrEngine.) |
| 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. (Inherited from OcrEngine.) |
| 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. (Inherited from OcrEngine.) |
| 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. (Inherited from OcrEngine.) |
| 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. (Inherited from OcrEngine.) |
Events| Name | Description | |
|---|---|---|
 | DocumentProgress | This event is used to publish progress made in recognition of a set of images. (Inherited from OcrEngine.) |
| ImageIntroduction | This event is raised before ImageTransformation in order to allow the document to
be pre-processed prior to deskew. (Inherited from OcrEngine.) |
| ImageSendOff | This event is raised before the OCR process starts, and after ImageTransformation for OCR
pre-processing. (Inherited from OcrEngine.) |
| ImageTransformation | This event is raised just after the image is deskewed and before ImageSendOff is
raised. (Inherited from OcrEngine.) |
| PageConstructed | This event is used to publish the page that has just been constructed. (Inherited from OcrEngine.) |
| PageConstructing | This event is used to publish the page that is in the process of being populated. (Inherited from OcrEngine.) |
| PageLocation | This event is used to publish OcrRegions that have been identified within an image. (Inherited from OcrEngine.) |
| PageProgress | This event is used to publish progress made in the recognition of a page. (Inherited from OcrEngine.) |
See Also