Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
AddBorderToRegion Method
See Also  Example
Leadtools Namespace > RasterImage Class : AddBorderToRegion Method



left
X coordinate of a point. The color of the specified point will be used to set the region.
top
Y coordinate of a point. The color of the specified point will be used to set the region.
borderColor
Border color.
lowerToleranceColor
Lower tolerance values that set the lower stopping point for the region.
upperToleranceColor
Upper tolerance values that set the lower stopping point for the region.
combineMode
The action to take regarding the existing image region, if one is defined.
Creates a region of pixels with values that fall within a range defined by the value of a specific pixel and a lower and upper tolerance value but are not equal to the borderColor.

Syntax

Visual Basic (Declaration)  
Public Sub AddBorderToRegion( _
   ByVal left As Integer, _
   ByVal top As Integer, _
   ByVal borderColor As RasterColor, _
   ByVal lowerToleranceColor As RasterColor, _
   ByVal upperToleranceColor As RasterColor, _
   ByVal combineMode As RasterRegionCombineMode _
)
Visual Basic (Usage) Copy Code
Dim instance As RasterImage
Dim left As Integer
Dim top As Integer
Dim borderColor As RasterColor
Dim lowerToleranceColor As RasterColor
Dim upperToleranceColor As RasterColor
Dim combineMode As RasterRegionCombineMode
 
instance.AddBorderToRegion(left, top, borderColor, lowerToleranceColor, upperToleranceColor, combineMode)
C#  
public void AddBorderToRegion( 
   int left,
   int top,
   RasterColor borderColor,
   RasterColor lowerToleranceColor,
   RasterColor upperToleranceColor,
   RasterRegionCombineMode combineMode
)
C++/CLI  
public:
void AddBorderToRegion( 
   int left,
   int top,
   RasterColor borderColor,
   RasterColor lowerToleranceColor,
   RasterColor upperToleranceColor,
   RasterRegionCombineMode combineMode
)

Parameters

left
X coordinate of a point. The color of the specified point will be used to set the region.
top
Y coordinate of a point. The color of the specified point will be used to set the region.
borderColor
Border color.
lowerToleranceColor
Lower tolerance values that set the lower stopping point for the region.
upperToleranceColor
Upper tolerance values that set the lower stopping point for the region.
combineMode
The action to take regarding the existing image region, if one is defined.

Example

Visual Basic Copy Code
Public Sub AddBorderToRegionExample()
   RasterCodecs.Startup()
   Dim codecs As RasterCodecs = New RasterCodecs()

   Dim srcFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"
   Dim destFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1_AddBorderToRegion.bmp"

   ' Load the image
   Dim image As RasterImage = codecs.Load(srcFileName)

   ' Posterize the image to decrease the number of colors
   Dim posterize As PosterizeCommand = New PosterizeCommand(16)
   posterize.Run(image)

   ' Specify a pixel in the upper left of the displayed image
   Dim pt As Point = New Point(image.ImageWidth \ 8, image.ImageHeight \ 8)

   ' Adjust the point in case the view perspective is not TopLeft
   pt = image.PointToImage(RasterViewPerspective.TopLeft, pt)

   ' Create a border region at this point
   Dim borderColor As RasterColor = image.GetPixelColor(pt.Y, pt.X)
   Dim lowerColor As RasterColor = New RasterColor(20, 30, 150)
   Dim upperColor As RasterColor = New RasterColor(15, 30, 10)
   image.AddBorderToRegion(pt.X, pt.Y, borderColor, lowerColor, upperColor, RasterRegionCombineMode.Set)

   ' Fill the region with blue
   Dim fill As FillCommand = New FillCommand(RasterColor.FromGdiPlusColor(Color.Blue))
   fill.Run(image)

   ' Save the image
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24)

   image.Dispose()
   codecs.Dispose()
   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void AddBorderToRegionExample() 
{ 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"; 
   string destFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1_AddBorderToRegion.bmp"; 
 
   // Load the image 
   RasterImage image = codecs.Load(srcFileName); 
 
   // Posterize the image to decrease the number of colors 
   PosterizeCommand posterize = new PosterizeCommand(16); 
   posterize.Run(image); 
 
   // Specify a pixel in the upper left of the displayed image 
   Point pt = new Point(image.ImageWidth / 8, image.ImageHeight / 8); 
 
   // Adjust the point in case the view perspective is not TopLeft 
   pt = image.PointToImage(RasterViewPerspective.TopLeft, pt); 
 
   // Create a border region at this point 
   RasterColor borderColor = image.GetPixelColor(pt.Y, pt.X); 
   RasterColor lowerColor = new RasterColor(20, 30, 150); 
   RasterColor upperColor = new RasterColor(15, 30, 10); 
   image.AddBorderToRegion(pt.X, pt.Y, borderColor, lowerColor, upperColor, RasterRegionCombineMode.Set); 
 
   // Fill the region with blue 
   FillCommand fill = new FillCommand(RasterColor.FromGdiPlusColor(Color.Blue)); 
   fill.Run(image); 
 
   // Save the image 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24); 
 
   image.Dispose(); 
   codecs.Dispose(); 
   RasterCodecs.Shutdown(); 
}

Remarks

For color bitmaps:

If the value of the pixel at (x, y) is (125, 125, 125) and lowerToleranceColor is (20,30,15), then the lower stopping point is (105, 95, 110). If upperToleranceColor is (20,30,15), then the upper stopping point is (145,155,140). In this case, the pixels with values between (105,95,110) and (145,155,140) are non-border pixels and will be included in the region. Any pixel with a value outside this range or equal to borderColor is considered a border pixel.

For gray scale bitmaps:

The minimum channel tolerance value of lowerToleranceColor will be used to set the lower stopping point, and the minimum channel tolerance value of upperToleranceColor will be used to set the upper stopping point. For example, if the value of the pixel at (x, y) is (125, 125, 125) and lowerToleranceColor is (20,30,15), the smallest value of the triplet (15) will be used to create the lower stopping point of (110,110,110). If upperToleranceColor is (10,25,20), the smallest value of that triplet (10) will be used to create the upper stopping point of (135,135,135). In this case, the pixels with values between (110, 110, 110) and (135,135,135) are non-border pixels and will be included in the region. Any pixel with a value outside this range or equal to borderColor is considered a border pixel.

This method does not support signed data images.

To update an existing region, you specify how the new region is to be combined with the existing one using the combineMode parameter. For more information, refer to RasterRegionCombineMode.

For more information, refer to Creating a Region.

For more information, refer to Saving A Region.

For more information, refer to Working with the Existing Region.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also