←Select platform

HolePunchRemoveCommand Class

Summary

Finds and removes hole punches.

Syntax
C#
VB
C++
public class HolePunchRemoveCommand : RasterCommand 
Public Class HolePunchRemoveCommand  
   Inherits RasterCommand 
public ref class HolePunchRemoveCommand : public RasterCommand   

Remarks

This command is available in the Document/Medical Toolkits.

  • 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:

holewithline.gif

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

hole.gif

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

Example

Run the HolePunchRemoveCommand on an image.

C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
 
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"; 
} 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Core 
 
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 

Requirements

Target Platforms

Help Version 20.0.2019.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.ImageProcessing.Core Assembly