BlankPageDetectionCommand Class

Detect whether a given image (or a region of interest in the image) is blank.

Inheritance Hierarchy

SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessingImageRegionCommand
      Atalasoft.Imaging.ImageProcessing.DocumentBlankPageDetectionCommand

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 BlankPageDetectionCommand : ImageRegionCommand, 
	IProcessSpeedConfig, ISerializable

<SerializableAttribute>
Public Class BlankPageDetectionCommand
	Inherits ImageRegionCommand
	Implements IProcessSpeedConfig, ISerializable

The BlankPageDetectionCommand type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat. (Inherited from ImageCommand.)
	Denoise	Will remove noise in the image prior to detecting blank page when true.
	InPlaceProcessing	Returns true because this command doesn't actually return a new image, just returns the source image. (Overrides ImageCommandInPlaceProcessing.)
	MinObjectSize	Objects that are smaller than this size will be ignored when detecting blank pages.
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process. (Inherited from ImageCommand.)
	RegionOfInterest	Gets or sets a RegionOfInterest which will only process the indicated region of the image. (Inherited from ImageRegionCommand.)
	RemoveBorder	Will remove black borders in the image prior to detecting blank page when true.
	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 ImageCommandSupportedPixelFormats.)

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 ImageRegionCommandGetObjectData(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 ImageCommandPerformActualCommand(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 ImageCommandVerifyProperties(AtalaImage).)

Top

Remarks

A custom ImageResults is returned called BlankPageDetectionResults with the property IsImageBlank. Use this property to determine if the image is blank or not.

Note that this command supports bitonal images only, however it can be used with color images as well by setting ApplyToAnyPixelFormat to true. When doing this, be sure to set the DefaultPixelFormatChanger to one that uses a Document Thresholding method.

Examples

Simple example of determining if an image is blank.

Copy

BlankPageDetectionCommand bpd = new BlankPageDetectionCommand();
BlankPageDetectionResults results = bpd.Apply(image) as BlankPageDetectionResults;
bool isBlank = results.IsImageBlank;

Dim bpd As BlankPageDetectionCommand = New BlankPageDetectionCommand()
Dim results As BlankPageDetectionResults = CType(bpd.Apply(image), Typeof(BlankPageDetectionResults))
Dim isBlank As Boolean = results.IsImageBlank

Reference

Atalasoft.Imaging.ImageProcessing.Document Namespace

BlankPageDetectionResults Class