ShiftChannelsCommand Class

This command will shift individual image channels.

Inheritance Hierarchy

SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessingImageRegionCommand
      Atalasoft.Imaging.ImageProcessing.ChannelsShiftChannelsCommand

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

Syntax

Copy

[SerializableAttribute]
public class ShiftChannelsCommand : ImageRegionCommand, 
	ISerializable

<SerializableAttribute>
Public Class ShiftChannelsCommand
	Inherits ImageRegionCommand
	Implements ISerializable

The ShiftChannelsCommand type exposes the following members.

Constructors

	Name	Description
	ShiftChannelsCommand	Creates a new instance of ShiftChannelsCommand.
	ShiftChannelsCommand(SerializationInfo, StreamingContext)	Creates a new instance of ShiftChannelsCommand from serialization information.
	ShiftChannelsCommand(Int32, Int32, ChannelFlags)	Creates a new instance of ShiftChannelsCommand specifying offsetX, offsetY and channelsToProcess.
	ShiftChannelsCommand(Int32, Int32, ChannelFlags, Int32)	Creates a new instance of ShiftChannelsCommand specifying offsetX, offsetY, channelsToProcess and backgroundValue.

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	BackgroundValue	Gets or set a channel value to use for uncovered channel areas of the image.
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat. (Inherited from ImageCommand.)
	ChannelsToProcess	Gets or sets the ChannelFlags specifying which channels to process.
	InPlaceProcessing	Gets a value indicating if the source image data is processed in-place as opposed to returning a new image. (Inherited from ImageCommand.)
	OffsetX	Gets or sets the number of pixels to horizontally offset the channels.
	OffsetY	Gets or sets the number of pixels to vertically offset the channels.
	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 ImageCommandSupportedPixelFormats.)

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. (Overrides ImageCommandConstructFinalImage(AtalaImage).)
	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 a SerializationInfo object with information about this command. (Overrides ImageRegionCommandGetObjectData(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 ImageCommandPerformActualCommand(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. (Overrides ImageCommandSelectPreferredPixelFormat(AtalaImage, PixelFormat, PixelFormat).)
	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 ImageCommandVerifyProperties(AtalaImage).)

Top

Remarks

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

This command requires an image with at least 2 channels. If the image does not contain at least 2 channels, the PixelFormat will be changed to a compatible format.

Reference

Atalasoft.Imaging.ImageProcessing.Channels Namespace