ImageRegion Property

Summary

This property is updated with a shallow copy of the image that also has a region that contains the hole punches.

Syntax

C++

public RasterImage ImageRegion { get; }

Public ReadOnly Property ImageRegion As RasterImage

public: 
property RasterImage^ ImageRegion { 
   RasterImage^ get(); 
}

Property Value

A shallow copy of the image that also has a region that contains the hole punches.

Remarks

If HolePunchRemoveCommandFlags.SingleRegion| HolePunchRemoveCommandFlags.LeadRegion has been set in the Flags property, then when HolePunchRemoveCommand returns, this property is updated with a shallow copy of the image that also has a region that contains the hole punches. So set Flags to HolePunchRemoveCommandFlags.SingleRegion| HolePunchRemoveCommandFlags.LeadRegion. It is the programmer's responsibility to dispose of the region when it is no longer needed.

Example

Run the HolePunchRemoveCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
 
public void ImageRegionPropertyExample() 
{ 
   // 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_S3); 
   command.Flags = HolePunchRemoveCommandFlags.UseDpi | HolePunchRemoveCommandFlags.UseSize | HolePunchRemoveCommandFlags.UseLocation | HolePunchRemoveCommandFlags.SingleRegion | HolePunchRemoveCommandFlags.LeadRegion; 
   command.Location = HolePunchRemoveCommandLocation.Left; 
   command.MaximumHoleHeight = image.Height; 
   command.MaximumHoleWidth = image.Width; 
   command.MinimumHoleHeight = 0; 
   command.MinimumHoleWidth = 0; 
   command.Run(image); 
 
} 
 
private void HolePunchRemoveEvent_S3(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_S3 As HolePunchRemoveCommand 
Public Sub ImageRegionPropertyExample() 
   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_S3 = New HolePunchRemoveCommand 
   holePunchCommand_S3.Flags = HolePunchRemoveCommandFlags.UseDpi Or HolePunchRemoveCommandFlags.UseSize Or 
      HolePunchRemoveCommandFlags.UseLocation Or HolePunchRemoveCommandFlags.SingleRegion Or 
      HolePunchRemoveCommandFlags.LeadRegion 
   holePunchCommand_S3.Location = HolePunchRemoveCommandLocation.Left 
   holePunchCommand_S3.MaximumHoleHeight = leadImage.Height 
   holePunchCommand_S3.MaximumHoleWidth = leadImage.Width 
   holePunchCommand_S3.MinimumHoleHeight = 0 
   holePunchCommand_S3.MinimumHoleWidth = 0 
   holePunchCommand_S3.Run(leadImage) 
 
End Sub 
 
Private Sub HolePunchCommand_HolePunchRemove_S3(ByVal sender As Object, ByVal e As HolePunchRemoveCommandEventArgs) Handles holePunchCommand_S3.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

Reference

HolePunchRemoveCommand Class

HolePunchRemoveCommand Members

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.ImageProcessing.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.Core Namespace

Assemblies