ImageRegion Property

Summary

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

Objective-C

C++

Java

public RasterImage ImageRegion { get; }

Public ReadOnly Property ImageRegion As RasterImage

@property (nonatomic, strong, readonly, nullable) LTRasterImage *imageRegion

public RasterImage getImageRegion()

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

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

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

Run the SmoothCommand 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 
   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"; 
 
   System.Diagnostics.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; 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Core 
 
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 
 
   System.Diagnostics.Debug.WriteLine("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:\LEADTOOLS21\Resources\Images" 
End Class

Requirements

Target Platforms

Reference

SmoothCommand Class

SmoothCommand Members

Download our FREE evaluation

Help Version 21.0.2021.7.2

Leadtools.ImageProcessing.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.Core Namespace

Assemblies