Click or drag to resize

AutoBorderCropCommand Class

Crops black borders from the edges of a bi-tonal image.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessing.DocumentAutoBorderCropCommand

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 AutoBorderCropCommand : ImageCommand, 
	IProcessSpeedConfig, ISerializable

The AutoBorderCropCommand type exposes the following members.

Constructors
  NameDescription
Public methodAutoBorderCropCommand
Creates a new instance of AutoBorderCropCommand.
Protected methodAutoBorderCropCommand(SerializationInfo, StreamingContext)
Initializes a new instance of the AutoBorderCropCommand class
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyBorderNoiseTolerance

The acceptable percentage of white pixel "noise" within the black border area.

Public propertyBorderStreakTolerance

The acceptable percentage of white streaks within the black border area.

Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
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 propertyMaxBorderThickness
Gets or sets the maximum border thickness, in pixels, that will be removed.
Public propertyMaxBoundaryWhitespace
The maximum amount of white space in pixels from the edge of the image to the start of the border.
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 propertySpeedFactor
Determines the sample size of the image to process, affecting quality and speed.
Public propertySupportedPixelFormats
Gets a list of PixelFormats that this command will support without throwing an exception. This command supports Pixel1bppIndexed only.
(Overrides ImageCommandSupportedPixelFormats.)
Top
Methods
  NameDescription
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.)
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 (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
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 (Overrides ImageCommandPerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
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 (Overrides ImageCommandVerifyProperties(AtalaImage).)
Top
Remarks

Similar to AdvancedBorderRemovalCommand, but crops the image as opposed to making the border white. This command is much faster than AdvancedBorderRemoval.

Uses a more advanced algorithm than AutoCropCommand and BorderRemovalCommand included with DotImage Document Imaging.

When applying this command, the resulting ImageResults is an instance of AutoBorderCropResults containing the coordinates of the detected border.

Examples
[New Example] (C#)
Copy
AutoBorderCropCommand cmd = new AutoBorderCropCommand(); 
AutoBorderCropResults results = (AutoBorderCropResults)cmd.Apply(sourceImage); 
AtalaImage newImage = results.Image;
Rectangle borderRect = results.BorderRectangle;
if (!results.IsImageSourceImage) 
  sourceImage.Dispose(); //free memory
[New Example] (Visual Basic)
Copy
Dim cmd As AutoBorderCropCommand = New AutoBorderCropCommand()
Dim results As AutoBorderCropResults = CType(cmd.Apply(sourceImage), TypeOf(AutoBorderCropResults))
Dim newImage As AtalaImage = results.Image
Dim borderRect As Rectangle = results.BorderRectangle
If Not results.IsImageSourceImage Then 
  sourceImage.Dispose() 'free memory
End If
See Also

Reference

Atalasoft.Imaging.ImageProcessing.Document Namespace
AdvancedBorderRemovalCommand Class
AutoBorderCropResults Class