Click or drag to resize

AutoNegateCommand Class

Inspects an bi-tonal image to determine if the image is negated. Will automatically invert the image if InvertWhenWhiteOnBlack.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessingImageRegionCommand
      Atalasoft.Imaging.ImageProcessing.DocumentAutoNegateCommand

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 AutoNegateCommand : ImageRegionCommand, 
	IProcessSpeedConfig, ISerializable

The AutoNegateCommand type exposes the following members.

Constructors
  NameDescription
Public methodAutoNegateCommand
Creates a new instance of AutoNegateCommand.
Public methodAutoNegateCommand(Boolean)
Initializes a new instance of AutoNegateCommand specifying if the command should invert the image, or just report results.
Protected methodAutoNegateCommand(SerializationInfo, StreamingContext)
Initializes a new instance of the AutoNegateCommand class
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
Public propertyInPlaceProcessing
Returns true because this command will process the image in-place and not allocate a new block of memory.
(Overrides ImageCommandInPlaceProcessing.)
Public propertyInvertWhenWhiteOnBlack
When true will automatically invert the image when the resulting IsInverted property is true.
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 propertyRegionOfInterest

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

(Inherited from ImageRegionCommand.)
Public propertySpeedFactor
Determines the sample size of the image to process, affecting quality and speed.
Public propertySupportedPixelFormats
Gets a list of PixelFormats that this command will support without throwing an exception. This command supports Pixel1bppIndexed only.
(Overrides ImageCommandSupportedPixelFormats.)
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 ImageRegionCommandGetObjectData(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 ImageCommandPerformActualCommand(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 ImageCommandVerifyProperties(AtalaImage).)
Top
Remarks

When applying this command, the resulting ImageResults is an instance of AutoNegateResults containing a boolean IsInverted property.

When RegionOfInterest is specified, it is used for detection purpose only. Invert image process is applying on whole image if necessary.

Examples
[New Example] (C#)
Copy
AutoNegateCommand cmd = new AutoNegateCommand(); 
AutoNegateResults results = (AutoNegateResults)cmd.Apply(sourceImage); 
AtalaImage newImage = results.Image; //the negated image
bool inverted = results.IsInverted;
[New Example] (Visual Basic)
Copy
Dim cmd As AutoNegateCommand New AutoNegateCommand() 
Dim results As AutoNegateResults = CType(cmd.Apply(sourceImage), TypeOf(AutoNegateResults))
Dim newImage As AtalaImage = results.Image 'the negated image
Dim inverted As Boolean = results.IsInverted
See Also