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



Gets the 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 (Declaration) 
Public ReadOnly Property ImageRegion As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As SmoothCommand
Dim value As RasterImage
 
value = instance.ImageRegion
C# 
public RasterImage ImageRegion {get;}
C++/CLI 
public:
property RasterImage ImageRegion {
   RasterImage get();
}

Return Value

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

Example

Run the SmoothCommand on an image.

Visual BasicCopy Code
Public WithEvents smoothEventExample_S3 As SmoothCommand
Public Sub ImageRegionPropertyExample()
   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
   smoothEventExample_S3 = New SmoothCommand
   smoothEventExample_S3.Flags = SmoothCommandFlags.FavorLong Or SmoothCommandFlags.SingleRegion Or SmoothCommandFlags.LeadRegion
   smoothEventExample_S3.Length = 2
   smoothEventExample_S3.Run(leadImage)

   RasterCodecs.Shutdown()
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
C#Copy Code
public void ImageRegionPropertyExample() 
{ 
   // 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 
   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); 
 
   RasterCodecs.Shutdown(); 
} 
 
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; 
}

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.

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