Click or drag to resize

ImageCommand Class

Represents the base class for all image processing routines that modify image data.
Represents the base class for all image processing routines that modify image data.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    More...

Namespace:  Atalasoft.Imaging.ImageProcessing
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public abstract class ImageCommand

The ImageCommand type exposes the following members.

Constructors
  NameDescription
Public methodImageCommand
Initializes a new instance of the ImageCommand class.
Protected methodImageCommand(SerializationInfo, StreamingContext)
Initializes a new instance of the ImageCommand class.
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
Public propertyStatic memberGlobalAutoThread
Determines if all ImageCommands that support multithreaded processing will be multithreaded.
Public propertyInPlaceProcessing
Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
Public propertyProgress
Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process.
Public propertySupportedPixelFormats
Gets an array of supported pixel formats.
Top
Methods
  NameDescription
Protected methodStatic memberAllocatePixelFormatArray
Allocate an array of PixelFormat enums.
Public methodApply
Apply the command to the given image.
Public methodApplyToImage Obsolete.
Applies the command to the source AtalaImage.
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.
Protected methodConstructFinalImage
Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command.
Protected methodConstructImageResults
Constructs the results object for this command.
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.
Protected methodStatic memberGetContinuousFormatImage
A utility method for determining the best matching continuous tone pixel format and converting the given image to that format.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodImageCommandGetObjectData
Aggregates ImageCommand data into the supplied SerializationInfo object.
Public methodIsPixelFormatSupported
Returns a value indicating if the specified pixel format is supported.
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.
Protected methodStatic memberProxyConstructChangedSourceImage
Calls the ConstructChangedSourceImage method on the supplied ImageCommand.
Protected methodStatic memberProxyConstructFinalImage
Protected methodStatic memberProxyConstructImageResults
Protected methodStatic memberProxyGetChangedPixelFormat
Protected methodStatic memberProxySelectBestAlternatePixelFormat
Protected methodStatic memberProxySelectPreferredPixelFormat
Protected methodStatic memberProxyVerifyProperties
Protected methodSelectBestAlternatePixelFormat
Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable.
Protected methodSelectPreferredPixelFormat
Chooses a pixel format that is preferred for this command.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodVerifyImage
Verify the integrity of an AtalaImage.
Protected methodVerifyProperties
Verify the integrity of properties in the command before processing an image.
Top
Remarks

An ImageCommand can be used to apply any type of effect onto an existing image. The Apply method can be used to process the command. Classes that inherit ImageCommand can be used in the ApplyCommand method in the Workspace.

See Extending ImageCommands for more information on creating custom commands.

Remarks

An ImageCommand can be used to apply any type of effect onto an existing image. The Apply method can be used to process the command. Classes that inherit ImageCommand can be used in the ApplyCommand(ImageCommand) method in the Workspace.

See Also

Reference

Extending ImageCommands
Extending ImageCommands
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessingApplyPaletteCommand
    Atalasoft.Imaging.ImageProcessingAutoCropCommand
    Atalasoft.Imaging.ImageProcessingChangePixelFormatCommand
    Atalasoft.Imaging.ImageProcessing.ChannelsFlattenAlphaCommand
    Atalasoft.Imaging.ImageProcessing.ChannelsReplaceChannelCommand
    Atalasoft.Imaging.ImageProcessing.ChannelsSetAlphaColorCommand
    Atalasoft.Imaging.ImageProcessing.ChannelsSetAlphaFromMaskCommand
    Atalasoft.Imaging.ImageProcessing.ChannelsSetAlphaValueCommand
    Atalasoft.Imaging.ImageProcessingCropCommand
    Atalasoft.Imaging.ImageProcessing.DocumentAutoBorderCropCommand
    Atalasoft.Imaging.ImageProcessing.DocumentAutoDeskewCommand
    Atalasoft.Imaging.ImageProcessing.DocumentBorderRemovalCommand
    Atalasoft.Imaging.ImageProcessing.DocumentDitherCommand
    Atalasoft.Imaging.ImageProcessing.DocumentMarginCropCommand
    Atalasoft.Imaging.ImageProcessing.DocumentOverlayMaskedDocumentCommand
    Atalasoft.Imaging.ImageProcessing.DocumentResampleDocumentCommand
    Atalasoft.Imaging.ImageProcessing.EffectsBevelEdgeCommand
    Atalasoft.Imaging.ImageProcessing.EffectsDropShadowCommand
    Atalasoft.Imaging.ImageProcessing.EffectsNDGradFilterCommand
    Atalasoft.Imaging.ImageProcessing.EffectsPhotoColorCorrectCommandBase
    Atalasoft.Imaging.ImageProcessing.EffectsPhotoColorMagicCommand
    Atalasoft.Imaging.ImageProcessing.EffectsPhotoColorMultiplyCommand
    Atalasoft.Imaging.ImageProcessing.EffectsPhotoPortraitCommand
    Atalasoft.Imaging.ImageProcessing.EffectsPhotoShadowBoostCommand
    Atalasoft.Imaging.ImageProcessing.EffectsPhotoSkinTonesCommand
    Atalasoft.Imaging.ImageProcessing.EffectsReduceColorsCommand
    Atalasoft.Imaging.ImageProcessing.EffectsRoundedBevelCommand
    Atalasoft.Imaging.ImageProcessing.EffectsScribbleCommand
    Atalasoft.Imaging.ImageProcessing.EffectsTintGrayscaleCommand
    Atalasoft.Imaging.ImageProcessing.FftFftCommand
    Atalasoft.Imaging.ImageProcessing.FiltersColorizeCommand
    Atalasoft.Imaging.ImageProcessingImageRegionCommand
    Atalasoft.Imaging.ImageProcessingOverlayCommand
    Atalasoft.Imaging.ImageProcessingOverlayMaskedCommand
    Atalasoft.Imaging.ImageProcessingOverlayMergedCommand
    Atalasoft.Imaging.ImageProcessingResampleColormappedToRgbCommand
    Atalasoft.Imaging.ImageProcessingResampleCommand
    Atalasoft.Imaging.ImageProcessingResampleMaskedCommand
    Atalasoft.Imaging.ImageProcessingThreadedCommand
    Atalasoft.Imaging.ImageProcessing.TransformsFlipCommand
    Atalasoft.Imaging.ImageProcessing.TransformsPushCommand
    Atalasoft.Imaging.ImageProcessing.TransformsQuadrilateralWarpCommand
    Atalasoft.Imaging.ImageProcessing.TransformsResizeCanvasCommand
    Atalasoft.Imaging.ImageProcessing.TransformsRotateCommand
    Atalasoft.Imaging.ImageProcessing.TransformsSkewCommand
    Atalasoft.Imaging.ImageProcessing.TransformsTransform
    Atalasoft.Imaging.ImageProcessing.TransformsTransformChainCommand