HistogramStretchCommand Class

Performs a histogram stretch on an image.

Inheritance Hierarchy

System.Object
  Atalasoft.Imaging.ImageProcessing.ImageCommand
    Atalasoft.Imaging.ImageProcessing.ImageRegionCommand
      Atalasoft.Imaging.ImageProcessing.Effects.HistogramStretchCommand

Namespace: Atalasoft.Imaging.ImageProcessing.Effects
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

[SerializableAttribute]
public class HistogramStretchCommand : ImageRegionCommand, 
	ISerializable

<SerializableAttribute>
Public Class HistogramStretchCommand
	Inherits ImageRegionCommand
	Implements ISerializable

The HistogramStretchCommand type exposes the following members.

Constructors

	Name	Description
	HistogramStretchCommand()	Creates a new instance of HistogramStretchCommand.
	HistogramStretchCommand(Double, Double)	Creates a new instance of HistogramStretchCommand specifying the low and high limits.
	HistogramStretchCommand(SerializationInfo, StreamingContext)	Creates a new instance of HistogramStretchCommand from serialization information.

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat. (Inherited from ImageCommand.)
	ChannelsToProcess	Gets or sets a bit flag indicating the channels to process.
	HighLimit	Gets or sets the percent of pixels to set to 255.
	InPlaceProcessing	Gets a value indicating if the source image data is processed in-place as opposed to returning a new image. (Overrides ImageCommand.InPlaceProcessing.)
	LowLimit	Gets or sets the percent of pixels to set to 0.
	MidPoint	Gets or sets the pixel value to set to middle intensity. This value must be from 1 to 254.
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process. (Inherited from ImageCommand.)
	RegionOfInterest	Gets or sets a RegionOfInterest which will only process the indicated region of the image. (Inherited from ImageRegionCommand.)
	SupportedPixelFormats	Returns an array of PixelFormats supported by this command. (Overrides ImageCommand.SupportedPixelFormats.)
	UseMidPoint	Gets or sets a value indicating whether the MidPoint property will be used to divide output range.

Top

Methods

	Name	Description
	Apply	Apply the command to the given image. (Inherited from ImageCommand.)
	ApplyToImage	Obsolete. Applies the command to the source AtalaImage. (Inherited from ImageCommand.)
	ConstructChangedSourceImage	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.)
	ConstructFinalImage	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.)
	ConstructImageResults	Constructs the results object for this command. (Inherited from ImageCommand.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetChangedPixelFormat	This method is called to change the pixel format of the source image. (Inherited from ImageCommand.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Fills the SerializationInfo object with information for this command. (Overrides ImageRegionCommand.GetObjectData(SerializationInfo, StreamingContext).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImageCommandGetObjectData	Aggregates ImageCommand data into the supplied SerializationInfo object. (Inherited from ImageCommand.)
	IsPixelFormatSupported	Returns a value indicating if the specified pixel format is supported. (Inherited from ImageCommand.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PerformActualCommand	PerformActualCommand does the actual work of the image processing command. (Overrides ImageCommand.PerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
	SelectBestAlternatePixelFormat	Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable. (Inherited from ImageCommand.)
	SelectPreferredPixelFormat	Chooses a pixel format that is preferred for this command. (Inherited from ImageCommand.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VerifyImage	Verify the integrity of an AtalaImage. (Inherited from ImageCommand.)
	VerifyProperties	Verify the integrity of properties in the command before processing an image. (Overrides ImageCommand.VerifyProperties(AtalaImage).)

Top

Remarks

Re-distribute the pixel values across the given range by first setting values above and below the thresholds to zero and 255 respectively and then scaling the remaining values to span the entire zero to 255 range.

This can be used to increase the contrast and extend the dynamic range of an image.

When applied to multi-channel (RGB, RGBA) images, each channel is modified independently of the others; because of this, colors may shift. See BrightnessHistogramStretchCommand for a similar command that doesn't cause this color shift.

Reference

Atalasoft.Imaging.ImageProcessing.Effects Namespace