ImageRegion Property (BorderRemoveCommand)

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

public RasterImage ImageRegion {get;}

'Declaration
 
Public ReadOnly Property ImageRegion As RasterImage

'Usage
 
Dim instance As BorderRemoveCommand
Dim value As RasterImage
 
value = instance.ImageRegion

public RasterImage ImageRegion {get;}

 get_ImageRegion();

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

Property Value

If BorderRemoveCommandFlags.SingleRegion| BorderRemoveCommandFlags.LeadRegion have been set in Flags, then when BorderRemoveCommand returns, this is updated with a shallow copy of image that also has a region that contains the removed borders. So set Flags to (BorderRemoveCommandFlags.SingleRegion| BorderRemoveCommandFlags.LeadRegion). It is the programmer's responsibility to dispose the region when it is no longer needed.

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

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
   Dim command As BorderRemoveCommand = New BorderRemoveCommand
   command.Border = BorderRemoveBorderFlags.All
   command.Flags = BorderRemoveCommandFlags.UseVariance Or BorderRemoveCommandFlags.SingleRegion Or BorderRemoveCommandFlags.LeadRegion
   command.Percent = 20
   command.Variance = 3
   command.WhiteNoiseLength = 9

   command.Run(leadImage)

   Using tempRegion As RasterRegion = command.ImageRegion.GetRegion(Nothing)
      leadImage.SetRegion(Nothing, tempRegion, RasterRegionCombineMode.Set)
   End Using

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
      BorderRemoveCommand command = new BorderRemoveCommand();
      command.Border = BorderRemoveBorderFlags.All;
      command.Flags = BorderRemoveCommandFlags.UseVariance | BorderRemoveCommandFlags.SingleRegion | BorderRemoveCommandFlags.LeadRegion;
      command.Percent = 20;
      command.Variance = 3;
      command.WhiteNoiseLength = 9;

      command.Run(image);

      using(RasterRegion tempRegion = command.ImageRegion.GetRegion(null))
      {
         image.SetRegion(null, tempRegion, RasterRegionCombineMode.Set);
      }

   }

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";
   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 | BorderRemoveCommandFlags.leadRegion;
         command.percent = 20;
         command.variance = 3;
         command.whiteNoiseLength = 9;
         
         command.run(image);

         var tempRegion = command.imageRegion.getRegion(null);
         image.setRegion(null, tempRegion, Leadtools.RasterRegionCombineMode.set);
         tempRegion = null;
      }
   });
}

[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
   BorderRemoveCommand command = new BorderRemoveCommand();
   command.Border = BorderRemoveBorderFlags.All;
   command.Flags = BorderRemoveCommandFlags.UseVariance | BorderRemoveCommandFlags.SingleRegion | BorderRemoveCommandFlags.LeadRegion;
   command.Percent = 20;
   command.Variance = 3;
   command.WhiteNoiseLength = 9;

   command.Run(image);

   using(RasterRegion tempRegion = command.ImageRegion.GetRegion(null))
   {
      image.SetRegion(null, tempRegion, RasterRegionCombineMode.Set);
   }

}

public void ImageRegionPropertyExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   BorderRemoveCommand command = new BorderRemoveCommand();
   command.Border = BorderRemoveBorderFlags.All;
   command.Flags = BorderRemoveCommandFlags.UseVariance | BorderRemoveCommandFlags.SingleRegion | BorderRemoveCommandFlags.LeadRegion;
   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 ImageRegionPropertyExample(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 Or BorderRemoveCommandFlags.LeadRegion
   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