Click or drag to resize

BinarizeCommand Class

Converts a grayscale or color image to black and white using one of the available Binarize methods.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessingImageRegionCommand
      Atalasoft.Imaging.ImageProcessing.DocumentBinarizeCommand

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

The BinarizeCommand type exposes the following members.

Constructors
  NameDescription
Public methodBinarizeCommand
Creates a new instance of BinarizeCommand.
Public methodBinarizeCommand(BinarizeMethod)
Creates a new instance of BinarizeCommand specifying the binarization method.
Protected methodBinarizeCommand(SerializationInfo, StreamingContext)
Initializes a new instance of the BinarizeCommand class
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyBinarizationMethod
Gets or sets a value indicating the type of binarization to use.
Public propertyBlackGrouping
A percentile indication of how tightly grouped black pixels need to be.
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
Public propertyInitialThreshold
Gets or sets the seed threshold value to use for GlobalThreshold and the actual threshold value to use for SimpleThreshold methods.
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 propertyMaskWindowSize
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 propertySupportedPixelFormats
Gets a list of PixelFormats that this command will support without throwing an exception. This command supports all continuous tone pixel formats.
(Overrides ImageCommandSupportedPixelFormats.)
Public propertyThresholdDifferencing
Gets or sets the thresholding differencing used for the AdaptiveThreshold method.
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 (Overrides ImageCommandConstructChangedSourceImage(AtalaImage).)
Protected methodConstructFinalImage (Overrides ImageCommandConstructFinalImage(AtalaImage).)
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
Examples
C#
Copy
BinarizeCommand cmd = new BinarizeCommand(BinarizeMethod.AdaptiveThreshold); 
ImageResults results = cmd.Apply(sourceImage); 
AtalaImage newImage = results.Image; 
if (!results.IsImageSourceImage) 
  sourceImage.Dispose(); //free memory
[New Example] (Visual Basic)
Copy
Dim cmd As BinarizeCommand = New BinarizeCommand(BinarizeMethod.AdaptiveThreshold)
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