ImageRegion Property (SmoothCommand)

Gets the Leadtools.RasterImage object that is updated with a shallow copy of the image that also has a region that contains the removed bumps and nicks.

Syntax

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

public RasterImage ImageRegion {get;}

'Declaration
 
Public ReadOnly Property ImageRegion As RasterImage

'Usage
 
Dim instance As SmoothCommand
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 that is updated with a shallow copy of the image that also has a region that contains the removed bumps and nicks.

Remarks

If SmoothCommandFlags.SingleRegion | SmoothCommandFlags.LeadRegion has been set in the Flags property, then when SmoothCommand returns, this property is updated with a shallow copy of the image that also has a region that contains the removed bumps and nicks. So set Flags to SmoothCommandFlags.SingleRegion | SmoothCommandFlags.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 smoothEventExample_S3 As SmoothCommand
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
   smoothEventExample_S3 = New SmoothCommand
   smoothEventExample_S3.Flags = SmoothCommandFlags.FavorLong Or SmoothCommandFlags.SingleRegion Or SmoothCommandFlags.LeadRegion
   smoothEventExample_S3.Length = 2
   smoothEventExample_S3.Run(leadImage)

End Sub

Private Sub SmoothEventExample_SmoothCommand_S3(ByVal sender As Object, ByVal e As SmoothCommandEventArgs) Handles smoothEventExample_S3.Smooth
   Dim BumpOrNeck As String
   If (e.BumpNick = SmoothCommandBumpNickType.Bump) Then
      BumpOrNeck = "Bump"
   Else
      BumpOrNeck = "Neck"
   End If

   Dim Direction As String
   If (e.Direction = SmoothCommandDirectionType.Horizontal) Then
      Direction = "Horizontal"
   Else
      Direction = "Vertical"
   End If

   MessageBox.Show("Type " + BumpOrNeck.ToString() + _
          Chr(13) + " Row Column " + e.StartRow.ToString() + e.StartColumn.ToString() + _
          Chr(13) + " Length " + e.Length.ToString() + _
          Chr(13) + " Direction " + Direction.ToString() + _
          Chr(13) + " Bump Or Neck" + BumpOrNeck.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
      SmoothCommand command = new SmoothCommand();
      command.Smooth += new EventHandler<SmoothCommandEventArgs>(SmoothEventExample_S3);
      command.Flags  = SmoothCommandFlags.FavorLong | SmoothCommandFlags.SingleRegion | SmoothCommandFlags.LeadRegion;
      command.Length = 2; 
      command.Run(image);

   }

   private void SmoothEventExample_S3(object sender, SmoothCommandEventArgs e)
   {
      string BumpOrNeck;
      if (e.BumpNick == SmoothCommandBumpNickType.Bump)
         BumpOrNeck = "Bump";
      else
         BumpOrNeck = "Neck";

      string Direction;
      if (e.Direction == SmoothCommandDirectionType.Horizontal)
         Direction = "Horizontal";
      else
         Direction = "Vertical";

      MessageBox.Show("Type " + BumpOrNeck +
         "\n Row Column " + e.StartRow.ToString() + e.StartColumn.ToString() +
         "\n Length " + e.Length +
         "\n Direction " + Direction +
         "\n Bump Or Neck " + BumpOrNeck);

      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";
   var processedImage;
   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 SmoothCommand();
         command.addEventListener("smooth", SmoothEventExample_S3);
         command.flags = SmoothCommandFlags.favorLong | SmoothCommandFlags.singleRegion | SmoothCommandFlags.leadRegion;
         command.length = 2;
         command.run(image);
      }
   });
}

function SmoothEventExample_S3(e) {
   with (Leadtools.ImageProcessing.Core) {
      var BumpOrNeck;
      if (e.bumpNick == SmoothCommandBumpNickType.bump)
         BumpOrNeck = "Bump";
      else
         BumpOrNeck = "Neck";

      var Direction;
      if (e.direction == SmoothCommandDirectionType.horizontal)
         Direction = "Horizontal";
      else
         Direction = "Vertical";

      console.error("Type " + BumpOrNeck +
         "\n Row Column " + e.startRow.toString() + e.startColumn.toString() +
         "\n Length " + e.length +
         "\n Direction " + Direction +
         "\n Bump Or Neck " + BumpOrNeck);

      e.status = 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
   SmoothCommand command = new SmoothCommand();
   command.Smooth += new EventHandler<SmoothCommandEventArgs>(SmoothEventExample_S3);
   command.Flags  = SmoothCommandFlags.FavorLong | SmoothCommandFlags.SingleRegion | SmoothCommandFlags.LeadRegion;
   command.Length = 2; 
   command.Run(image);

}

private void SmoothEventExample_S3(object sender, SmoothCommandEventArgs e)
{
   string BumpOrNeck;
   if (e.BumpNick == SmoothCommandBumpNickType.Bump)
      BumpOrNeck = "Bump";
   else
      BumpOrNeck = "Neck";

   string Direction;
   if (e.Direction == SmoothCommandDirectionType.Horizontal)
      Direction = "Horizontal";
   else
      Direction = "Vertical";

   Debug.WriteLine("Type " + BumpOrNeck +
      "\n Row Column " + e.StartRow.ToString() + e.StartColumn.ToString() +
      "\n Length " + e.Length +
      "\n Direction " + Direction +
      "\n Bump Or Neck " + BumpOrNeck);

   e.Status = RemoveStatus.Remove;
}

public void ImageRegionPropertyExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   SmoothCommand command = new SmoothCommand();
   command.Smooth += new EventHandler<SmoothCommandEventArgs>(SmoothEventExample_S3);
   command.Flags = SmoothCommandFlags.FavorLong | SmoothCommandFlags.SingleRegion | SmoothCommandFlags.LeadRegion;
   command.Length = 2;
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1);
   image.Dispose();
}
private void SmoothEventExample_S3(object sender, SmoothCommandEventArgs e)
{
   string BumpOrNeck;
   if (e.BumpNick == SmoothCommandBumpNickType.Bump)
      BumpOrNeck = "Bump";
   else
      BumpOrNeck = "Neck";

   string Direction;
   if (e.Direction == SmoothCommandDirectionType.Horizontal)
      Direction = "Horizontal";
   else
      Direction = "Vertical";

   Debug.WriteLine("Type " + BumpOrNeck +
      "\n Row Column " + e.StartRow.ToString() + e.StartColumn.ToString() +
      "\n Length " + e.Length +
      "\n Direction " + Direction +
      "\n Bump Or Neck " + BumpOrNeck);

   e.Status = RemoveStatus.Remove;
}

Public Sub ImageRegionPropertyExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As SmoothCommand = New SmoothCommand()
   AddHandler command.Smooth, AddressOf SmoothEventExample_S3
   command.Flags = SmoothCommandFlags.FavorLong Or SmoothCommandFlags.SingleRegion Or SmoothCommandFlags.LeadRegion
   command.Length = 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 SmoothEventExample_S3(ByVal sender As Object, ByVal e As SmoothCommandEventArgs)
   Dim BumpOrNeck As String
   If e.BumpNick = SmoothCommandBumpNickType.Bump Then
      BumpOrNeck = "Bump"
   Else
      BumpOrNeck = "Neck"
   End If

   Dim Direction As String
   If e.Direction = SmoothCommandDirectionType.Horizontal Then
      Direction = "Horizontal"
   Else
      Direction = "Vertical"
   End If

   Debug.WriteLine("Type " & BumpOrNeck & Constants.vbLf & " Row Column " & e.StartRow.ToString() & e.StartColumn.ToString() & Constants.vbLf & _
                   " Length " & e.Length + Constants.vbLf & " Direction " & Direction & Constants.vbLf & " Bump Or Neck " & BumpOrNeck)

   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

SmoothCommand Class
SmoothCommand Members