Click or drag to resize

AutoInvertTextCommand Class

Automatically inverts regions of text that are inverted (white on black) on a bi-tonal image.

Inheritance Hierarchy
System.Object
  Atalasoft.Imaging.ImageProcessing.ImageCommand
    Atalasoft.Imaging.ImageProcessing.ImageRegionCommand
      Atalasoft.Imaging.ImageProcessing.Document.AutoInvertTextCommand

Namespace:  Atalasoft.Imaging.ImageProcessing.Document
Assembly:  Atalasoft.dotImage.AdvancedDocClean (in Atalasoft.dotImage.AdvancedDocClean.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax
Copy
[SerializableAttribute]
public class AutoInvertTextCommand : ImageRegionCommand, 
	IPropertiesAutoConfigurable, ISerializable

The AutoInvertTextCommand type exposes the following members.

Constructors
  NameDescription
Public methodAutoInvertTextCommand()
Creates an instance of AutoInverseTextCorrectionCommand.
Protected methodAutoInvertTextCommand(SerializationInfo, StreamingContext)
Initializes a new instance of the AutoInvertTextCommand class
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyAutoPropertyConfigurationEnabled
Gets or sets a value indicating if properties in the PropertiesToAutoConfigure property will be automatically determined by the command when processed.
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
Public propertyInPlaceProcessing
Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
(Inherited from ImageCommand.)
Public propertyInvertedRegionSizeMaximum Obsolete.
Maximum size in pixels of the inverted text region.
Public propertyInvertedRegionSizeMinimum Obsolete.
Minimum size limit of of inverted text region in pixels.
Public propertyMaxInvertedRegionSize
Public propertyMinInvertedRegionSize
Public propertyProgress
Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process.
(Inherited from ImageCommand.)
Public propertyPropertiesToAutoConfigure
Gets a collection of property names that will be auto configured when AutoPropertyConfigurationEnabled is true.
Public propertyRegionOfInterest

Gets or sets a RegionOfInterest which will only process the indicated region of the image.

(Inherited from ImageRegionCommand.)
Public propertySpeedFactor
Public propertySupportedPixelFormats
Gets a list of PixelFormats that this command will support without throwing an exception. This command supports Pixel1bppIndexed only.
(Overrides ImageCommand.SupportedPixelFormats.)
Top
Methods
  NameDescription
Public methodApply
Apply the command to the given image.
(Inherited from ImageCommand.)
Public methodApplyToImage Obsolete.
Applies the command to the source AtalaImage.
(Inherited from ImageCommand.)
Protected methodConstructChangedSourceImage
The method is called by the default implementation of Apply. It determines if it is necessary to create a copy of the source image in a different pixel format and if so, determines the best new pixel format and allocates that image.
(Inherited from ImageCommand.)
Protected methodConstructFinalImage
Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command.
(Inherited from ImageCommand.)
Protected methodConstructImageResults
Constructs the results object for this command.
(Inherited from ImageCommand.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetChangedPixelFormat
This method is called to change the pixel format of the source image.
(Inherited from ImageCommand.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData (Overrides ImageRegionCommand.GetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodImageCommandGetObjectData
Aggregates ImageCommand data into the supplied SerializationInfo object.
(Inherited from ImageCommand.)
Public methodIsPixelFormatSupported
Returns a value indicating if the specified pixel format is supported.
(Inherited from ImageCommand.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPerformActualCommand (Overrides ImageCommand.PerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
Protected methodSelectBestAlternatePixelFormat
Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable.
(Inherited from ImageCommand.)
Protected methodSelectPreferredPixelFormat
Chooses a pixel format that is preferred for this command.
(Inherited from ImageCommand.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodVerifyImage
Verify the integrity of an AtalaImage.
(Inherited from ImageCommand.)
Protected methodVerifyProperties (Overrides ImageCommand.VerifyProperties(AtalaImage).)
Top
Remarks
This command is useful when pre-processing documents prior to OCR, as many OCR engines do not recognize inverted text areas.
Examples
[New Example] (C#)
Copy
AutoInvertTextCommand cmd = new AutoInvertTextCommand();
ImageResults results = cmd.Apply(sourceImage);
AtalaImage newImage = results.Image;
if (!results.IsImageSourceImage)
  sourceImage.Dispose(); //free memory
[New Example] (Visual Basic)
Copy
Dim cmd As AutoInvertTextCommand = New AutoInvertTextCommand()
Dim results As ImageResults = cmd.Apply(sourceImage) 
Dim newImage As AtalaImage = results.Image
If Not results.IsImageSourceImage Then 
  sourceImage.Dispose() 'free memory
End If
See Also