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.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

[SerializableAttribute]
public class ResampleDocumentCommand : ImageCommand, 
	ISerializable, IThreadableCommand, ICloneable

<SerializableAttribute>
Public Class ResampleDocumentCommand
	Inherits ImageCommand
	Implements ISerializable, IThreadableCommand, ICloneable

The ResampleDocumentCommand type exposes the following members.

Constructors

	Name	Description
	ResampleDocumentCommand	Creates a new instance of ResampleDocumentCommand.
	ResampleDocumentCommand(SerializationInfo, StreamingContext)	Creates a new instance of ResampleDocumentCommand from serialization information.
	ResampleDocumentCommand(Rectangle, Size, ResampleDocumentMethod)	Creates a new instance of ResampleDocumentCommand specifying sourceRect, destSize and documentMethod.
	ResampleDocumentCommand(Rectangle, Size, ResampleMethod)	Creates a new instance of ResampleDocumentCommand specifying sourceRect, destSize and scaleToGrayMethod.
	ResampleDocumentCommand(Rectangle, Size, ResampleDocumentMethod, Int32)	Creates a new instance of ResampleDocumentCommand specifying sourceRect, destSize, documentMethod and cutOff.

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	AutoThread	If set to true the IThreadableCommand will automatically parallelize image processing.
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat. (Inherited from ImageCommand.)
	CutOff	Gets or sets the grayscale value which is the cutoff value for a black pixel when using AreaAverage.
	DestSize	Gets or sets the final size of the image.
	DocumentMethod	Gets or sets the 1-bit specialized resampling method to apply.
	InPlaceProcessing	Gets a value indicating if the source image data is processed in-place as opposed to returning a new image. (Inherited from ImageCommand.)
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process. (Inherited from ImageCommand.)
	ScaleToGrayMethod	Gets or sets the %ResampleMethod% to apply when the DocumentMethod is ScaleToGray.
	SourceRect	Gets or sets the rectangular region of the source image which will be resized.
	SupportedPixelFormats	Returns an array of PixelFormats supported by this command. (Overrides ImageCommandSupportedPixelFormats.)

Top

Methods

	Name	Description
	AdjustBands	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.
	Apply	Apply the command to the given image. (Inherited from ImageCommand.)
	ApplyToImage	Obsolete. Applies the command to the source AtalaImage. (Inherited from ImageCommand.)
	Clone	Returns a copy of the command.
	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	Populates a SerializationInfo with the data needed to serialize the target object.
	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).)
	PerformSectionCommand	Performs the command on a specified section of the image.
	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 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.

Reference

Atalasoft.Imaging.ImageProcessing.Document Namespace