ImageRegion Property

Summary

RasterImage object that is updated with a shallow copy of image that also has a region that contains the removed borders.

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

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.

Example

Run the BorderRemoveCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
 
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:\LEADTOOLS21\Resources\Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
 
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:\LEADTOOLS21\Resources\Images" 
End Class

Requirements

Target Platforms

Reference

BorderRemoveCommand Class

BorderRemoveCommand 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