AddColorToRegion Method

Summary

Creates or updates the image region by adding a region that consists of all the pixels of a specified color.

Syntax

Objective-C

C++

Java

public void AddColorToRegion( 
   RasterColor color, 
   RasterRegionCombineMode combineMode 
)

Public Sub AddColorToRegion( _ 
   ByVal color As RasterColor, _ 
   ByVal combineMode As RasterRegionCombineMode _ 
)

- (BOOL)addColorToRegion:(LTRasterColor *)color  
             combineMode:(LTRasterRegionCombineMode)combineMode  
                   error:(NSError **)error

public void addColorToRegion( 
  RasterColor color,  
  RasterRegionCombineMode combineMode 
)

public: 
void AddColorToRegion(  
   RasterColor color, 
   RasterRegionCombineMode combineMode 
)

Parameters

color
Specifies the color to use for the region.

combineMode
The action to take regarding the existing image region, if one is defined.

Remarks

You can use this method to simulate the use of a transparent color as follows:

Call AddColorToRegion, with the transparent color in the color parameter and RasterRegionCombineMode.SetNot in the combineMode parameter.
Call PaintRegion to paint the resulting region, which includes everything in the image, except the transparent color.

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

The AddColorToRegion function can use the Extended Grayscale mask. For more information, refer to Grayscale Images

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.

This method supports unsigned data images, but not signed ones.

In the Document and Medical toolkits, the COLORREF value can represent a 16 bit grayscale value if RasterImage is a 12 or 16-bit grayscale bitmap. To avoid confusion with an RGB value, set the COLORREF_GRAY16 mask (0x04000000). In this case (0x0400YYYY), the lower 16 bits (0xYYYY) of the COLORREF value represent the 16-bit grayscale value. (0x0400FFFF is 16-bit white and 0x04000000 is 16-bit black.) This is not a standard Windows value. Therefore, although LEADTOOLS methods will recognize a COLORREF having this format, but Windows methods will not.

Example

This example will load an image, adds a region all pixels of a specified color. It then fills the region with blue before saving it back to disk.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Dicom; 
using Leadtools.Drawing; 
using Leadtools.Controls; 
using Leadtools.Svg; 
 
 
public void AddColorToRegionExample() 
{ 
	RasterCodecs codecs = new RasterCodecs(); 
 
	string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
	string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_AddColorToRegion.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 
	LeadPoint pt = new LeadPoint(image.ImageWidth / 8, image.ImageHeight / 8); 
 
	// Adjust the point in case the view perspective is not TopLeft 
	pt = image.PointToImage(RasterViewPerspective.TopLeft, pt); 
 
	// Get the color of the specified pixel 
	RasterColor regionColor = image.GetPixelColor(pt.Y, pt.X); 
 
	// Create a region that includes all pixels of that color 
	image.AddColorToRegion(regionColor, RasterRegionCombineMode.Set); 
 
	// Fill the region with blue 
	FillCommand fill = new FillCommand(RasterColor.FromKnownColor(RasterKnownColor.Blue)); 
	fill.Run(image); 
 
	// Save the image 
	codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24); 
 
	image.Dispose(); 
	codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Controls 
Imports Leadtools.Dicom 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub AddColorToRegionExample() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp") 
   Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_AddColorToRegion.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 LeadPoint = New LeadPoint(image.ImageWidth \ 8, image.ImageHeight \ 8) 
 
   ' Adjust the point in case the view perspective is not TopLeft 
   pt = image.PointToImage(RasterViewPerspective.TopLeft, pt) 
 
   ' Get the color of the specified pixel 
   Dim regionColor As RasterColor = image.GetPixelColor(pt.Y, pt.X) 
 
   ' Create a region that includes all pixels of that color 
   image.AddColorToRegion(regionColor, RasterRegionCombineMode.Set) 
 
   ' Fill the region with blue 
   Dim fill As FillCommand = New FillCommand(RasterColor.FromKnownColor(RasterKnownColor.Blue)) 
   fill.Run(image) 
 
   ' Save the image 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24) 
 
   image.Dispose() 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\LEADTOOLS21\Resources\Images" 
End Class

Requirements

Target Platforms

Reference

RasterImage Class

RasterImage Members

Gray Scale Images

Introduction: Bits Per Pixel and Related Ideas

Using Color Values in LEADTOOLS

Download our FREE evaluation

Help Version 21.0.2021.7.2