ImageRegion Property (LineRemoveCommand)

RasterImage object that is updated with a shallow copy of the image that also has a region that contains the removed lines.

Syntax

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

public RasterImage ImageRegion {get;}

'Declaration
 
Public ReadOnly Property ImageRegion As RasterImage

'Usage
 
Dim instance As LineRemoveCommand
Dim value As RasterImage
 
value = instance.ImageRegion

public RasterImage ImageRegion {get;}

 get_ImageRegion();

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

Property Value

The Leadtools.RasterImage object, updated with a shallow copy of the image that has a region that contains the removed lines.

Remarks

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

Example

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

Public WithEvents lineRemoveCommand_S3 As LineRemoveCommand
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
   lineRemoveCommand_S3 = New LineRemoveCommand
   lineRemoveCommand_S3.Type = LineRemoveCommandType.Horizontal
   lineRemoveCommand_S3.Flags = LineRemoveCommandFlags.UseVariance Or LineRemoveCommandFlags.SingleRegion Or LineRemoveCommandFlags.LeadRegion
   lineRemoveCommand_S3.GapLength = 2
   lineRemoveCommand_S3.MaximumLineWidth = 5
   lineRemoveCommand_S3.MinimumLineLength = 200
   lineRemoveCommand_S3.MaximumWallPercent = 10
   lineRemoveCommand_S3.Wall = 7
   lineRemoveCommand_S3.Variance = 2
   lineRemoveCommand_S3.Run(leadImage)

End Sub

Private Sub LineRemoveCommand_LineRemove_S3(ByVal sender As Object, ByVal e As LineRemoveCommandEventArgs) Handles lineRemoveCommand_S3.LineRemove
   MessageBox.Show("Row Col " + "( " + e.StartRow.ToString() + ", " + e.StartColumn.ToString() + " )" + _
      Chr(13) + " Length " + e.Length.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 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
      LineRemoveCommand command = new LineRemoveCommand();
      command.LineRemove += new EventHandler<LineRemoveCommandEventArgs>(LineRemoveEvent_S3);
      command.Type  = LineRemoveCommandType.Horizontal;
      command.Flags = LineRemoveCommandFlags.UseVariance | LineRemoveCommandFlags.SingleRegion ;
      command.GapLength = 2;
      command.MaximumLineWidth = 5;
      command.MinimumLineLength = 200;
      command.MaximumWallPercent = 10;
      command.Wall = 7;
      command.Variance = 2;
      command.Run(image);

   }

   private void LineRemoveEvent_S3(object sender, LineRemoveCommandEventArgs e)
   {
      MessageBox.Show("Row Col "   + "( " + e.StartRow.ToString() + ", " + e.StartColumn + " )" +
         "\n Length " + e.Length.ToString());
      e.Status= RemoveStatus.Remove;
   }

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

function ImageRegionPropertyExample()
{
   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 LineRemoveCommand();
         command.addEventListener("lineremove", LineRemoveEvent_S3);
         command.type  = LineRemoveCommandType.horizontal;
         command.flags = LineRemoveCommandFlags.useVariance | LineRemoveCommandFlags.singleRegion ;
         command.gapLength = 2;
         command.maximumLineWidth = 5;
         command.minimumLineLength = 200;
         command.maximumWallPercent = 10;
         command.wall = 7;
         command.variance = 2;
         command.run(image);
      }
   });

}

function LineRemoveEvent_S3(e)
{
   console.error("Row Col " + "( " + e.startRow.toString() + ", " + e.startColumn + " )" +
      "\n Length " + e.length.toString());
   e.status = Leadtools.ImageProcessing.Core.RemoveStatus.remove;
}

[TestMethod]
public async Task ImageRegionPropertyExample()
{
   // 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
   LineRemoveCommand command = new LineRemoveCommand();
   command.LineRemove += new EventHandler<LineRemoveCommandEventArgs>(LineRemoveEvent_S3);
   command.Type  = LineRemoveCommandType.Horizontal;
   command.Flags = LineRemoveCommandFlags.UseVariance | LineRemoveCommandFlags.SingleRegion ;
   command.GapLength = 2;
   command.MaximumLineWidth = 5;
   command.MinimumLineLength = 200;
   command.MaximumWallPercent = 10;
   command.Wall = 7;
   command.Variance = 2;
   command.Run(image);

}

private void LineRemoveEvent_S3(object sender, LineRemoveCommandEventArgs e)
{
   Debug.WriteLine("Row Col "   + "( " + e.StartRow.ToString() + ", " + e.StartColumn + " )" +
      "\n Length " + e.Length.ToString());
   e.Status= RemoveStatus.Remove;
}

public void ImageRegionPropertyExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   LineRemoveCommand command = new LineRemoveCommand();
   command.LineRemove += new EventHandler<LineRemoveCommandEventArgs>(LineRemoveEvent_S3);
   command.Type  = LineRemoveCommandType.Horizontal;
   command.Flags = LineRemoveCommandFlags.UseVariance | LineRemoveCommandFlags.SingleRegion ;
   command.GapLength = 2;
   command.MaximumLineWidth = 5;
   command.MinimumLineLength = 200;
   command.MaximumWallPercent = 10;
   command.Wall = 7;
   command.Variance = 2;
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1);
   image.Dispose();
}

private void LineRemoveEvent_S3(object sender, LineRemoveCommandEventArgs e)
{
   Debug.WriteLine("Row Col "   + "( " + e.StartRow.ToString() + ", " + e.StartColumn + " )" +
      "\n Length " + e.Length.ToString());
   e.Status= RemoveStatus.Remove;
}

Public Sub ImageRegionPropertyExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As LineRemoveCommand = New LineRemoveCommand()
   AddHandler command.LineRemove, AddressOf LineRemoveEvent_S3
   command.Type = LineRemoveCommandType.Horizontal
   command.Flags = LineRemoveCommandFlags.UseVariance Or LineRemoveCommandFlags.SingleRegion
   command.GapLength = 2
   command.MaximumLineWidth = 54
   command.MinimumLineLength = 200
   command.MaximumWallPercent = 10
   command.Wall = 7
   command.Variance = 2
   command.Run(image)
   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1)
   image.Dispose()
End Sub

Private Sub LineRemoveEvent_S3(ByVal sender As Object, ByVal e As LineRemoveCommandEventArgs)
   Debug.WriteLine("Row Col " & "( " & e.StartRow.ToString() & ", " & e.StartColumn & " )" & Constants.vbLf & " Length " & e.Length.ToString())
   e.Status= RemoveStatus.Remove
End Sub

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

LineRemoveCommand Class
LineRemoveCommand Members