Click or drag to resize

ResampleDocumentCommand Class

Resamples a binary image.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessing.DocumentResampleDocumentCommand

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

The ResampleDocumentCommand type exposes the following members.

Constructors
  NameDescription
Public methodResampleDocumentCommand
Creates a new instance of ResampleDocumentCommand.
Protected methodResampleDocumentCommand(SerializationInfo, StreamingContext)
Creates a new instance of ResampleDocumentCommand from serialization information.
Public methodResampleDocumentCommand(Rectangle, Size, ResampleDocumentMethod)
Creates a new instance of ResampleDocumentCommand specifying sourceRect, destSize and documentMethod.
Public methodResampleDocumentCommand(Rectangle, Size, ResampleMethod)
Creates a new instance of ResampleDocumentCommand specifying sourceRect, destSize and scaleToGrayMethod.
Public methodResampleDocumentCommand(Rectangle, Size, ResampleDocumentMethod, Int32)
Creates a new instance of ResampleDocumentCommand specifying sourceRect, destSize, documentMethod and cutOff.
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 propertyCutOff
Gets or sets the grayscale value which is the cutoff value for a black pixel when using AreaAverage.
Public propertyDestSize
Gets or sets the final size of the image.
Public propertyDocumentMethod
Gets or sets the 1-bit specialized resampling method to apply.
Public propertyInPlaceProcessing
Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
(Inherited from ImageCommand.)
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 propertyScaleToGrayMethod
Gets or sets the %ResampleMethod% to apply when the DocumentMethod is ScaleToGray.
Public propertySourceRect
Gets or sets the rectangular region of the source image which will be resized.
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 the 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.
(Overrides ImageCommandConstructFinalImage(AtalaImage).)
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
Populates a SerializationInfo with the data needed to serialize the target object.
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 command can be used to efficiently perform a "scale to gray" resample on a document image as well as "favor to black" using the AreaAverage method and specifying the cut-off value.
See Also