Click or drag to resize

RecoStarEngine Class

Note: This API is now obsolete.

The RecoStar OCR engine object is used for recognizing either machine printed or hand printed text within a scanned image.
Inheritance Hierarchy
SystemObject
  Atalasoft.OcrOcrEngine
    Atalasoft.Ocr.RecoStarRecoStarEngine

Namespace:  Atalasoft.Ocr.RecoStar
Assembly:  Atalasoft.dotImage.Ocr.RecoStar (in Atalasoft.dotImage.Ocr.RecoStar.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[ObsoleteAttribute("RecoStarEngine class is deprecated and will be removed in future versions. Please use AbbyyEngine, GlyphReaderEngine, or Tesseract3Engine instead.", 
	false)]
public class RecoStarEngine : OcrEngine

The RecoStarEngine type exposes the following members.

Constructors
  NameDescription
Public methodRecoStarEngine(RecoStarLoader)
Constructs a new RecoStarEngine object using the RecoStarLoader object provided.
Public methodRecoStarEngine(RecoStarLoader, IOcrFactory)
Constructs a new RecoStarEngine object using the RecoStarLoader object and IOcrFactory object provided.
Public methodRecoStarEngine(RecoStarLoader, IOcrFactory, Stream)
Constructs a new RecoStarEngine object using the RecoStarLoader object, IOcrFactory object, and RecoStar license stream provided.
Top
Properties
  NameDescription
Public propertyAvailablePreprocessingOptions
This property returns the available set of image preprocessing options for this OcrEngine.
(Inherited from OcrEngine.)
Public propertyAvailableRecognitionModes
Returns a value indicating if the RecoStar engine will recognize machine or hand printed text.
Public propertyCanRecognizeBarcodes
Returns true if this engine supports barcode recognition.
(Inherited from OcrEngine.)
Public propertyCode exampleCanUseSymbolSet
Indicates that the engine supports symbol sets on OcrTextRegions
(Overrides OcrEngineCanUseSymbolSet.)
Public propertyDefaultPreprocessingOptions
Returns the default preprocessing options for this engine.
(Inherited from OcrEngine.)
Public propertyDefaultRecognitionCulture
Returns the default CultureInfo used for recognition for the RecoStar engine.
(Overrides OcrEngineDefaultRecognitionCulture.)
Public propertyFactory
This property provides an object of type IOcrFactory for the construction of page and document elements.
(Inherited from OcrEngine.)
Public propertyFontBuilder
This property provides a font builder that will be used for page construction.
(Inherited from OcrEngine.)
Public propertyFontMapper
This property provides a font mapper that will be used for page construction.
(Inherited from OcrEngine.)
Protected propertyFormOperatorName
Protected propertyImageProcessingOperatorName
Public propertyPageTimeout
Public propertyPreprocessingOptions
The property provides or sets the preprocessing options to be used for this OcrEngine.
(Inherited from OcrEngine.)
Public propertyRecognitionCulture
Sets or gets the recognition language for this engine.
(Inherited from OcrEngine.)
Public propertyRecognitionMode
Gets or sets the recogntion mode for the engine.
Public propertyRecognizeBarcodes
When true, will recognize barcodes as well as text if the engine supports barcode recognition.
(Inherited from OcrEngine.)
Public propertySupportedBarcodeSymbologies
Gets a list of barcode symbologies that are supported by this OcrDocument (if any).
(Inherited from OcrEngine.)
Public propertyTranslators
This property provides access to a TranslatorCollection object used by the engine to translate images to documents.
(Inherited from OcrEngine.)
Top
Methods
  NameDescription
Public methodCanStream
Determines if it is possible to write a particular output format to a Stream.
(Inherited from OcrEngine.)
Public methodCanTranslate
Determines if it is possible to translate a document to a particular output format.
(Inherited from OcrEngine.)
Protected methodCreateForm
Protected methodCulturesMatch
Detects whether specified cultures match.
(Inherited from OcrEngine.)
Public methodDispose
Dispose memory used by the OcrEngine.
(Inherited from OcrEngine.)
Protected methodDispose(Boolean) (Inherited from OcrEngine.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
OcrEngine finalizer.
(Inherited from OcrEngine.)
Protected methodGetAvailablePreprocessingOptions (Overrides OcrEngineGetAvailablePreprocessingOptions.)
Protected methodGetCanRecognizeBarcodes
Gets the value indicating wheather the engine can recognize barcodes or not.
(Inherited from OcrEngine.)
Protected methodGetDefaultPreprocessingOptions (Overrides OcrEngineGetDefaultPreprocessingOptions.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetLicenseFlag
Retrieves value of the flag with specified name.
(Inherited from OcrEngine.)
Protected methodGetPageToZoneUnitScale
Protected methodGetSupportedBarcodeSymbologies
Returns the barcode symbologies supported by this engine.
(Inherited from OcrEngine.)
Public methodGetSupportedRecognitionCultures
Returns an array of CultureInfo objects that represent the languages/cultures that are available to the RecoStarEngine.
(Overrides OcrEngineGetSupportedRecognitionCultures.)
Public methodGetSymbolSet
Returns a RecoStar specific symbol set matching string from a standard symbol set.
(Overrides OcrEngineGetSymbolSet(OcrSymbolSet).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodGetZoneUnitToPageScale
Protected methodHandleDeskew
Handles the process of deskewing an image.
(Inherited from OcrEngine.)
Public methodHasPageLocationHandler
Determines whether or not events have been installed for page location.
(Inherited from OcrEngine.)
Public methodCode exampleInitialize
Prepares the engine for recognition.
(Overrides OcrEngineInitialize.)
Protected methodMakeBinarizeCommand
Returns a new ImageCommand that will binarize an image in the HandleDeskew method
(Inherited from OcrEngine.)
Protected methodMakeDeskewCommand
Returns a new ImageCommand that will deskew an image.
(Inherited from OcrEngine.)
Protected methodMakeProject
Protected methodMakeXmlConfig
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOcrBarcodeSymbologyIsSupported
Returns true if a given barcode symbology is supported.
(Inherited from OcrEngine.)
Protected methodOnDocumentProgress
Fire the DocumentProgress event.
(Inherited from OcrEngine.)
Protected methodOnImageIntroduction
Raises the [E:ImageIntroduction] event.
(Inherited from OcrEngine.)
Protected methodOnImageSendOff
Raises the [E:ImageSendOff] event.
(Inherited from OcrEngine.)
Protected methodOnImageTransformation
Raises the [E:ImageTransformation] event.
(Inherited from OcrEngine.)
Protected methodOnPageConstructed
Fire the PageConstructed event.
(Inherited from OcrEngine.)
Protected methodOnPageConstructing
Fire the PageConstructing event.
(Inherited from OcrEngine.)
Protected methodOnPageLocation
Fire the PageLocation event.
(Inherited from OcrEngine.)
Protected methodOnPageProgress
Fire the page progress event.
(Inherited from OcrEngine.)
Protected methodProjectFormOperator
Protected methodRecognitionCultureChanged (Overrides OcrEngineRecognitionCultureChanged.)
Public methodRecognitionCultureSupported
Indicates whether or not this engine will support a given recognition culture
(Inherited from OcrEngine.)
Public methodRecognize(AtalaImage)
Recognizes the text in an image, returning an OcrPage object with the contents.
(Overrides OcrEngineRecognize(AtalaImage).)
Public methodRecognize(ImageSource)
Recognize a set of AtalaImage objects as an entire document.
(Inherited from OcrEngine.)
Public methodRecognize(AtalaImage, Rectangle)

Recognize only within a specific rectangle in an AtalaImage.

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