Leadtools.ImageProcessing.Core Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
HolePunchRemoveCommand Class
See Also  Members   Example 
Leadtools.ImageProcessing.Core Namespace : HolePunchRemoveCommand Class



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

Syntax

Visual Basic (Declaration) 
Public Class HolePunchRemoveCommand 
   Inherits RasterCommand
   Implements IRasterCommand 
Visual Basic (Usage)Copy Code
Dim instance As HolePunchRemoveCommand
C# 
public class HolePunchRemoveCommand : RasterCommand, IRasterCommand 
C++/CLI 
public ref class HolePunchRemoveCommand : public RasterCommand, IRasterCommand 

Example

Run the HolePunchRemoveCommand on an image.

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

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "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)

   RasterCodecs.Shutdown()
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
C#Copy Code
public void HolePunchRemoveCommandExample() 
{ 
   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "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); 
 
   RasterCodecs.Shutdown(); 
} 
 
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; 
}

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 __Delegates.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.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.Core.HolePunchRemoveCommand

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also