HolePunchRemoveCommand Class

Finds and removes hole punches. This command is available in the Document/Medical Toolkits.

Object Model

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public class HolePunchRemoveCommand : Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

'Declaration
 
Public Class HolePunchRemoveCommand 
   Inherits Leadtools.ImageProcessing.RasterCommand
   Implements Leadtools.ImageProcessing.IRasterCommand

'Usage
 
Dim instance As HolePunchRemoveCommand

public sealed class HolePunchRemoveCommand : Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.Core.HolePunchRemoveCommand()

public ref class HolePunchRemoveCommand : public Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

Remarks

This command detects and removes hole punches that are common in scanned documents. The behavior of this command can be modified by using the HolePunchRemoveCommandEventHandler delegate method.
This command works only on 1-bit black and white images.
Hole punch configurations may consist of 2 or more holes.
If a region is selected, only the selected region will be changed by this command. If no region is selected, the whole image will be processed.
This command does not support signed data images.
This command does not support 32-bit grayscale images.
Before calling this function, ensure that the hole punch is free of any other stray marks. If you do not, the hole will not be recognized. Use the LineRemoveCommand command to remove any horizontal or vertical lines from the image. Use the other Document Cleanup functions to remove other imaging artifacts such as dots, blobs, borders, inverted text, bumps and nicks. This will have the added benefit of making your image smaller when compressed.

For example, the following image must have the vertical line removed:

Once the image has been cleaned, as shown in the following figure, the hole punch can be removed:

For more information, refer to Cleaning Up 1-Bit Images.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public WithEvents holePunchCommand_S1 As HolePunchRemoveCommand
Public Sub HolePunchRemoveCommandExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Clean.tif"))

   ' Prepare the command
   holePunchCommand_S1 = New HolePunchRemoveCommand
   holePunchCommand_S1.Flags = HolePunchRemoveCommandFlags.UseDpi Or HolePunchRemoveCommandFlags.UseCount Or HolePunchRemoveCommandFlags.UseLocation
   holePunchCommand_S1.Location = HolePunchRemoveCommandLocation.Left
   holePunchCommand_S1.MaximumHoleCount = 4
   holePunchCommand_S1.MinimumHoleCount = 2

   holePunchCommand_S1.Run(leadImage)

End Sub

Private Sub HolePunchCommand_HolePunchRemove_S1(ByVal sender As Object, ByVal e As HolePunchRemoveCommandEventArgs) Handles holePunchCommand_S1.HolePunchRemove
   MessageBox.Show("Size " + "( " + e.BoundingRectangle.Left.ToString() + ", " + e.BoundingRectangle.Top.ToString() + ") - " + "( " + e.BoundingRectangle.Right.ToString() + ", " + e.BoundingRectangle.Bottom.ToString() + ")" + _
           Chr(13) + " Hole Index " + e.HoleIndex.ToString() + _
           Chr(13) + " Holes Total Count " + e.HoleTotalCount.ToString() + _
           Chr(13) + " Black Count " + e.BlackCount.ToString() + _
           Chr(13) + " White Count " + e.WhiteCount.ToString())
   e.Status = RemoveStatus.Remove
End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void HolePunchRemoveCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Clean.tif"));

      // Prepare the command
      HolePunchRemoveCommand command = new HolePunchRemoveCommand();
      command.HolePunchRemove  += new EventHandler<HolePunchRemoveCommandEventArgs>(HolePunchRemoveEvent_S1);
      command.Flags            = HolePunchRemoveCommandFlags.UseDpi | HolePunchRemoveCommandFlags.UseCount | HolePunchRemoveCommandFlags.UseLocation;
      command.Location         = HolePunchRemoveCommandLocation.Left;
      command.MaximumHoleCount = 4;
      command.MinimumHoleCount = 2;

      command.Run(image);

   }

   private void HolePunchRemoveEvent_S1(object sender, HolePunchRemoveCommandEventArgs e)
   {
      MessageBox.Show("Size "                 + "( " + e.BoundingRectangle.Left + ", " + e.BoundingRectangle.Top + ") - " + "( " + e.BoundingRectangle.Right + ", " + e.BoundingRectangle.Bottom + ")" +
         "\n Hole Index "        + e.HoleIndex.ToString() + 
         "\n Holes Total Count " + e.HoleTotalCount.ToString() + 
         "\n Black Count "       + e.BlackCount.ToString() + 
         "\n White Count "       + e.WhiteCount.ToString());
      e.Status= RemoveStatus.Remove;
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

function HolePunchRemoveCommandExample() {
   var codecs = new Leadtools.Codecs.RasterCodecs();
   codecs.throwExceptionsOnInvalidImages = true;

   // Load the image
   var srcFileName = "Assets\\clean.tif";
   return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
      return codecs.loadAsync(Leadtools.LeadStreamFactory.create(loadFile));
   }).then(function (image) {
      // Prepare the command
      with (Leadtools.ImageProcessing.Core) {
         var command = new HolePunchRemoveCommand();
         command.addEventListener("holepunchremove", HolePunchRemoveEvent_S1);
         command.flags = HolePunchRemoveCommandFlags.useDpi | HolePunchRemoveCommandFlags.useCount | HolePunchRemoveCommandFlags.useLocation;
         command.location = HolePunchRemoveCommandLocation.left;
         command.maximumHoleCount = 4;
         command.minimumHoleCount = 2;

         command.run(image);
      }
   });
}

function HolePunchRemoveEvent_S1(e) {
   console.error("Size " + "( " + e.boundingRectangle.x + ", " + e.boundingRectangle.y + ") - " + "( " + e.boundingRectangle.width + ", " + e.boundingRectangle.height + ")" +
      "\n Hole Index " + e.holeIndex.toString() +
      "\n Holes Total Count " + e.holeTotalCount.toString() +
      "\n Black Count " + e.blackCount.toString() +
      "\n White Count " + e.whiteCount.toString());
   e.status = Leadtools.ImageProcessing.Core.RemoveStatus.remove;
}

[TestMethod]
public async Task HolePunchRemoveCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   // Load the image
   string srcFileName = @"Assets\Clean.tif";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Prepare the command
   HolePunchRemoveCommand command = new HolePunchRemoveCommand();
   command.HolePunchRemove  += new EventHandler<HolePunchRemoveCommandEventArgs>(HolePunchRemoveEvent_S1);
   command.Flags            = HolePunchRemoveCommandFlags.UseDpi | HolePunchRemoveCommandFlags.UseCount | HolePunchRemoveCommandFlags.UseLocation;
   command.Location         = HolePunchRemoveCommandLocation.Left;
   command.MaximumHoleCount = 4;
   command.MinimumHoleCount = 2;

   command.Run(image);

}

private void HolePunchRemoveEvent_S1(object sender, HolePunchRemoveCommandEventArgs e)
{
   Debug.WriteLine("Size "                 + "( " + e.BoundingRectangle.X + ", " + e.BoundingRectangle.Y + ") - " + "( " + e.BoundingRectangle.Width + ", " + e.BoundingRectangle.Height + ")" +
      "\n Hole Index "        + e.HoleIndex.ToString() + 
      "\n Holes Total Count " + e.HoleTotalCount.ToString() + 
      "\n Black Count "       + e.BlackCount.ToString() + 
      "\n White Count "       + e.WhiteCount.ToString());
   e.Status= RemoveStatus.Remove;
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

HolePunchRemoveCommand Members
Leadtools.ImageProcessing.Core Namespace
Cleaning Up 1-Bit Images
SmoothCommand Class
BorderRemoveCommand Class
LineRemoveCommand Class
InvertedTextCommand Class
InvertedPageCommand Class
DotRemoveCommand Class
HighQualityRotateCommand Class
MinimumCommand Class
MaximumCommand Class
Leadtools.ImageProcessing.Effects.RegionHolesRemovalCommand