HolePunchRemovalCommand Class

Removes circular hole punch artifacts from an image.

Inheritance Hierarchy

System.Object
  Atalasoft.Imaging.ImageProcessing.ImageCommand
    Atalasoft.Imaging.ImageProcessing.ImageRegionCommand
      Atalasoft.Imaging.ImageProcessing.Document.HolePunchRemovalCommand

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

Syntax

Copy

[SerializableAttribute]
public class HolePunchRemovalCommand : ImageRegionCommand, 
	IProcessSpeedConfig, IPropertiesAutoConfigurable, ISerializable

<SerializableAttribute>
Public Class HolePunchRemovalCommand
	Inherits ImageRegionCommand
	Implements IProcessSpeedConfig, IPropertiesAutoConfigurable, ISerializable

The HolePunchRemovalCommand type exposes the following members.

Constructors

	Name	Description
	HolePunchRemovalCommand()	Creates a new instance of HolePunchRemovalCommand.
	HolePunchRemovalCommand(SerializationInfo, StreamingContext)	Initializes a new instance of the HolePunchRemovalCommand class

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	AutoPropertyConfigurationEnabled	Gets or sets a value indicating if properties in the PropertiesToAutoConfigure property will be automatically determined by the command when processed.
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat. (Inherited from ImageCommand.)
	ContentClusteringHint	The minimum distance in pixels between the hole punch boundary, and the text body.
	HolePunchLocation	The location of hole punches on the image (Left, Top, Right, Bottom).
	InPlaceProcessing	Gets a value indicating if the source image data is processed in-place as opposed to returning a new image. (Inherited from ImageCommand.)
	MaxHolePunchSize	The maximum size hole punch that will be removed in pixels.
	MinHolePunchSize	The minimum size hole punch that will be removed in pixels.
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process. (Inherited from ImageCommand.)
	PropertiesToAutoConfigure	Gets a collection of property names that will be auto configured when AutoPropertyConfigurationEnabled is true.
	RegionOfInterest	Gets or sets a RegionOfInterest which will only process the indicated region of the image. (Inherited from ImageRegionCommand.)
	SpeedFactor	Determines the sample size of the image to process, affecting quality and speed.
	SupportedPixelFormats	Gets a list of PixelFormats that this command will support without throwing an exception. This command supports Pixel1bppIndexed only. (Overrides ImageCommand.SupportedPixelFormats.)

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. (Inherited from ImageCommand.)
	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	(Overrides ImageRegionCommand.GetObjectData(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	(Overrides ImageCommand.PerformActualCommand(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. (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	(Overrides ImageCommand.VerifyProperties(AtalaImage).)

Top

Remarks

When applying this command, the resulting ImageResults is an instance of HolePunchRemovalResults containing the rectangular boundary of each detected hole punch.

Examples

Example

Copy

var cmd = new HolePunchRemovalCommand {HolePunchLocation = ImageEdges.Left | ImageEdges.Right};
var results = (HolePunchRemovalResults) cmd.Apply(sourceImage);
var newImage = results.Image;
foreach (HolePunch hole in results.HolePunches)
{
    Console.WriteLine(hole.Bounds);
}

if (!results.IsImageSourceImage)
    sourceImage.Dispose(); //free memory

Reference

Atalasoft.Imaging.ImageProcessing.Document Namespace

HolePunchRemovalResults Class