Click or drag to resize

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 Hierarchy
SystemObject
  Atalasoft.OcrOcrEngine
    More...

Namespace:  Atalasoft.Ocr
Assembly:  Atalasoft.dotImage.Ocr (in Atalasoft.dotImage.Ocr.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public abstract class OcrEngine : IDisposable

The OcrEngine type exposes the following members.

Constructors
  NameDescription
Protected methodOcrEngine
Initializes a new instance of the OcrEngine class.
Protected methodOcrEngine(IOcrFactory)
Initializes a new instance of the OcrEngine class using provided IOcrFactory.
Top
Properties
  NameDescription
Public propertyAvailablePreprocessingOptions
This property returns the available set of image preprocessing options for this OcrEngine.
Public propertyCanRecognizeBarcodes
Returns true if this engine supports barcode recognition.
Public propertyCanUseSymbolSet
Gets a value indicating wheather engine can use symbol set or not.
Public propertyDefaultPreprocessingOptions
Returns the default preprocessing options for this engine.
Public propertyDefaultRecognitionCulture
Returns the default recognition language for this engine.
Public propertyFactory
This property provides an object of type IOcrFactory for the construction of page and document elements.
Public propertyFontBuilder
This property provides a font builder that will be used for page construction.
Public propertyFontMapper
This property provides a font mapper that will be used for page construction.
Public propertyPreprocessingOptions
The property provides or sets the preprocessing options to be used for this OcrEngine.
Public propertyRecognitionCulture
Sets or gets the recognition language for this engine.
Public propertyRecognizeBarcodes
When true, will recognize barcodes as well as text if the engine supports barcode recognition.
Public propertySupportedBarcodeSymbologies
Gets a list of barcode symbologies that are supported by this OcrDocument (if any).
Public propertyTranslators
This property provides access to a TranslatorCollection object used by the engine to translate images to documents.
Top
Methods
  NameDescription
Public methodCanStream
Determines if it is possible to write a particular output format to a Stream.
Public methodCanTranslate
Determines if it is possible to translate a document to a particular output format.
Protected methodCulturesMatch
Detects whether specified cultures match.
Public methodDispose
Dispose memory used by the OcrEngine.
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the OcrEngine and optionally releases the managed resources
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
OcrEngine finalizer.
(Overrides ObjectFinalize.)
Protected methodGetAvailablePreprocessingOptions
Gets available preprocessing options for this OcrEngine
Protected methodGetCanRecognizeBarcodes
Gets the value indicating wheather the engine can recognize barcodes or not.
Protected methodGetDefaultPreprocessingOptions
Gets default preprocessing options for this OcrEngine
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetLicenseFlag
Retrieves value of the flag with specified name.
Protected methodGetSupportedBarcodeSymbologies
Returns the barcode symbologies supported by this engine.
Public methodGetSupportedRecognitionCultures
Returns an array of supported recognition languages for this engine
Public methodGetSymbolSet
Returns a engine-specific symbol set matching string from a standard symbol set.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleDeskew
Handles the process of deskewing an image.
Public methodHasPageLocationHandler
Determines whether or not events have been installed for page location.
Public methodInitialize
Initialize the engine.
Protected methodMakeBinarizeCommand
Returns a new ImageCommand that will binarize an image in the HandleDeskew method
Protected methodMakeDeskewCommand
Returns a new ImageCommand that will deskew an image.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOcrBarcodeSymbologyIsSupported
Returns true if a given barcode symbology is supported.
Protected methodOnDocumentProgress
Fire the DocumentProgress event.
Protected methodOnImageIntroduction
Raises the [E:ImageIntroduction] event.
Protected methodOnImageSendOff
Raises the [E:ImageSendOff] event.
Protected methodOnImageTransformation
Raises the [E:ImageTransformation] event.
Protected methodOnPageConstructed
Fire the PageConstructed event.
Protected methodOnPageConstructing
Fire the PageConstructing event.
Protected methodOnPageLocation
Fire the PageLocation event.
Protected methodOnPageProgress
Fire the page progress event.
Protected methodRecognitionCultureChanged
Public methodRecognitionCultureSupported
Indicates whether or not this engine will support a given recognition culture
Public methodRecognize(AtalaImage)
Public methodRecognize(ImageSource)
Recognize a set of AtalaImage objects as an entire document.
Public methodRecognize(AtalaImage, Rectangle)

Recognize only within a specific rectangle in an AtalaImage.

Protected methodRecognize(ImageSource, OcrDocument, IForeignTranslator, Object)
Public methodShutDown
Terminates the engine.
Public methodSupported Obsolete.
Provides a list of all mime types supported by Translators in this engine.
Public methodSupportedMimeTypes
Provides a list of all mime types supported by Translators in this engine.
Protected methodSupportingTranslator
Finds a translator that supports translation to the requested output type.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToSymbolSet
Converts a set of unique characters to a engine-specific symbol matching set.
Public methodTranslate(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.
Public methodTranslate(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.
Public methodTranslate(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.
Public methodTranslate(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.
Top
Events
  NameDescription
Public eventDocumentProgress
This event is used to publish progress made in recognition of a set of images.
Public eventImageIntroduction
This event is raised before ImageTransformation in order to allow the document to be pre-processed prior to deskew.
Public eventImageSendOff
This event is raised before the OCR process starts, and after ImageSendOff for OCR pre-processing.
Public eventImageTransformation
This event is raised just after the image is deskewed and before ImageSendOff is raised.
Public eventPageConstructed
This event is used to publish the page that has just been constructed.
Public eventPageConstructing
This event is used to publish the page that is in the process of being populated..
Public eventPageLocation
This event is used to publish OcrRegions that have been identified within an image.
Public eventPageProgress
This event is used to publish progress made in the recognition of a page.
Top
See Also
Inheritance Hierarchy