ThreadedCommandPerformActualCommand Method |
PerformActualCommand does the actual work of the image processing command.
Namespace:
Atalasoft.Imaging.ImageProcessing
Assembly:
Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax protected override AtalaImage PerformActualCommand(
AtalaImage source,
AtalaImage dest,
Rectangle imageArea,
ref ImageResults results
)
Protected Overrides Function PerformActualCommand (
source As AtalaImage,
dest As AtalaImage,
imageArea As Rectangle,
ByRef results As ImageResults
) As AtalaImage
Parameters
- source
- Type: Atalasoft.ImagingAtalaImage
The source image for processing. This may be different from the original image. - dest
- Type: Atalasoft.ImagingAtalaImage
The destination image. Dest will be null when InPlaceProcessing is true or when
ConstructFinalImage returns null. - imageArea
- Type: System.DrawingRectangle
An area of the source image to process. When the destination image is non-null, it will
always be the same size as imageArea. ImageArea only differs in size from the source image when the command is a
subclass of ImageRegionCommand and when there is a region of interest. - results
- Type: Atalasoft.Imaging.ImageProcessingImageResults
The results object that will be used for this command.
Return Value
Type:
AtalaImage
In most cases, PerformActualCommand should return null. When PerformActualCommand returns a non-null
image, it is indicating that it has allocated a new image to use for the final image. This must be true if
ConstructFinalImage returned null.
Exceptions Exception | Condition |
---|
ImageProcessException | ThreadedCommands can't be embedded in themselves. |
ArgumentNullException | source;cannot process a null image. |
ArgumentOutOfRangeException | adjustedBands;an image cannot be processed with zero bands |
Exception | |
See Also