Region Property (BorderRemoveCommand)

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

public RasterRegion Region {get;}

'Declaration
 
Public ReadOnly Property Region As RasterRegion

'Usage
 
Dim instance As BorderRemoveCommand
Dim value As RasterRegion
 
value = instance.Region

public RasterRegion Region {get;}

 get_Region();

public:
property RasterRegion^ Region {
   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.

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

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

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";
}

function RegionPropertyExample()
{
   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 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, Leadtools.RasterRegionCombineMode.set);
      }
   });
}

[TestMethod]
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);

}

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();
}

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

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

BorderRemoveCommand Class
BorderRemoveCommand Members