Click or drag to resize

ThresholdCommand Class

Set pixel components above a high threshold value to 255 and below a low threshold value to 0.
Inheritance Hierarchy

Namespace:  Atalasoft.Imaging.ImageProcessing.Filters
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class ThresholdCommand : ImageRegionCommand, 
	ISerializable, IThreadableCommand, ICloneable

The ThresholdCommand type exposes the following members.

Constructors
  NameDescription
Public methodThresholdCommand
Creates a new instance of ThresholdCommand.
Public methodThresholdCommand(Int32, Int32)
Creates a new instance of ThresholdCommand specifying minValue, and maxValue.
Protected methodThresholdCommand(SerializationInfo, StreamingContext)
Creates a new instance of ThresholdCommand from serialization information.
Public methodThresholdCommand(Int32, Int32, ChannelFlags)
Creates a new instance of ThresholdCommand specifying minValue, maxValue and channelsToProcess.
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyAutoThread
If set to true the IThreadableCommand will automatically parallelize image processing.
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
Public propertyChannelsToProcess
Gets or sets the ChannelFlags specifying which channels to process.
Public propertyInPlaceProcessing
Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
(Overrides ImageCommandInPlaceProcessing.)
Public propertyMaxValue
Gets or sets a value indicating that pixels above this value are set to 255.
Public propertyMinValue
Gets or sets a value indicating that pixels below this value are set to 0.
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
Returns an array of PixelFormats supported by this command.
(Overrides ImageCommandSupportedPixelFormats.)
Top
Methods
  NameDescription
Public methodAdjustBands
Sets the image area which will be processed and also defines the bands or chunks of the image of which each will be sent to a separate thread.
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.)
Public methodClone
Returns a copy of this command.
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
Fills a SerializationInfo object with information about this command.
(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
PerformActualCommand does the actual work of the image processing command.
(Overrides ImageCommandPerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
Public methodPerformSectionCommand
Performs the command on a specified section of the image.
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
Verify the integrity of properties in the command before processing an image.
(Overrides ImageCommandVerifyProperties(AtalaImage).)
Top
Remarks

This method requires a continuous tone image. If the source image is not continuous, it will throw the ArgumentException

This is not the same as the thresholding commands in the Document namespace. See GlobalThresholdCommand and AdaptiveThresholdCommand for binarizing color or grayscale images into binary images.

See Also