←Select platform

Region Property (BorderRemoveCommand)

Summary

Gets the handle to a LEADTOOLS RasterRegion.

Syntax

Java

Objective-C

WinRT C#

C++

public Leadtools.RasterRegion Region {get;}

Public ReadOnly Property Region As Leadtools.RasterRegion

public Leadtools.RasterRegion Region {get;}

@property (nonatomic, strong, readonly, nullable) LTRasterRegion *region

public RasterRegion getRegion()

get_Region();

public: 
property Leadtools.RasterRegion^ Region { 
   Leadtools.RasterRegion^ get(); 
}

Property Value

Handle to a windows region. When BorderRemoveCommand returns, this is updated with a single windows region corresponding to all changes, only if BorderRemoveCommandFlags.SingleRegion has been set in Flags and BorderRemoveCommandFlags.LeadRegion has not been set. To use this, set the Flags to BorderRemoveCommandFlags.SingleRegion. It is the programmer's responsibility to dispose of this region when the region is no longer needed.

Example

Run the BorderRemoveCommand on an image.

WinRT C#

Silverlight C#

Silverlight VB

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
 
    
Public Sub RegionPropertyExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Clean.tif")) 
 
   ' Prepare the command 
   Dim command As BorderRemoveCommand = New BorderRemoveCommand 
   command.Border = BorderRemoveBorderFlags.All 
   command.Flags = BorderRemoveCommandFlags.UseVariance Or BorderRemoveCommandFlags.SingleRegion 
   command.Percent = 20 
   command.Variance = 3 
   command.WhiteNoiseLength = 9 
 
   command.Run(leadImage) 
   leadImage.SetRegion(Nothing, command.Region, RasterRegionCombineMode.Set) 
 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
 
       
public void RegionPropertyExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Clean.tif")); 
 
   // Prepare the command 
   BorderRemoveCommand command = new BorderRemoveCommand(); 
   command.Border = BorderRemoveBorderFlags.All; 
   command.Flags = BorderRemoveCommandFlags.UseVariance |   BorderRemoveCommandFlags.SingleRegion ; 
   command.Percent = 20; 
   command.Variance = 3; 
   command.WhiteNoiseLength = 9; 
 
   command.Run(image); 
   image.SetRegion(null, command.Region, RasterRegionCombineMode.Set); 
 
} 
 
static class LEAD_VARS 
{ 
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
 
       
public async Task RegionPropertyExample() 
{ 
   // 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 
   BorderRemoveCommand command = new BorderRemoveCommand(); 
   command.Border = BorderRemoveBorderFlags.All; 
   command.Flags = BorderRemoveCommandFlags.UseVariance |   BorderRemoveCommandFlags.SingleRegion ; 
   command.Percent = 20; 
   command.Variance = 3; 
   command.WhiteNoiseLength = 9; 
 
   command.Run(image); 
   image.SetRegion(null, command.Region, RasterRegionCombineMode.Set); 
 
}

using Leadtools; 
using Leadtools.Examples; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
 
public void RegionPropertyExample(RasterImage image, Stream outStream) 
{ 
   // Prepare the command 
   BorderRemoveCommand command = new BorderRemoveCommand(); 
   command.Border = BorderRemoveBorderFlags.All; 
   command.Flags = BorderRemoveCommandFlags.UseVariance |   BorderRemoveCommandFlags.SingleRegion ; 
   command.Percent = 20; 
   command.Variance = 3; 
   command.WhiteNoiseLength = 9; 
   command.Run(image); 
 
   // Save result image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1); 
   image.Dispose(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Core 
 
Public Sub RegionPropertyExample(ByVal image As RasterImage, ByVal outStream As Stream) 
   ' Prepare the command 
   Dim command As BorderRemoveCommand = New BorderRemoveCommand() 
   command.Border = BorderRemoveBorderFlags.All 
   command.Flags = BorderRemoveCommandFlags.UseVariance Or BorderRemoveCommandFlags.SingleRegion 
   command.Percent = 20 
   command.Variance = 3 
   command.WhiteNoiseLength = 9 
   command.Run(image) 
 
   ' Save result image 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1) 
   image.Dispose() 
End Sub