SetPalette Method

Summary

Sets the palette of this RasterImage object that will be used by 1-8 bit color or grayscale image.

Syntax

Objective-C

C++

Java

public void SetPalette( 
   RasterColor[] palette, 
   int startIndex, 
   int count 
)

Public Sub SetPalette( _ 
   ByVal palette() As RasterColor, _ 
   ByVal startIndex As Integer, _ 
   ByVal count As Integer _ 
)

- (BOOL)setPalette:(nullable NSArray<LTRasterColor *> *)palette range:(NSRange)range error:(NSError **)error

public void setPalette(RasterColor[] palette, int startIndex, int count)

public: 
void SetPalette(  
   array<RasterColor>^ palette, 
   int startIndex, 
   int count 
)

Parameters

palette
An array of RasterColor containing the new palette to use.

startIndex
Index of the first palette entry to replace.

count
Number of palette entries to replace.

Remarks

The image data of a RasterImage object with BitsPerPixel values of 1, 2, 3, 4, 5, 6, 7 or 8 consists of an index into the image palette. You can get a copy of the palette used by using the GetPalette method.

You can change the palette used by the RasterImage object with the SetPalette method.

This method does not support signed images.

For more information, refer to RasterPalette and Introduction: Palette Handling.

For information on 10 to 16-bit grayscale image, refer to the Grayscale Images.

Example

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 LeadtoolsExamples.Common; 
using Leadtools.Svg; 
 
public void PaletteExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(ImagesPath.Path, "Image1.cmp"); 
   string destFileName = Path.Combine(ImagesPath.Path, "Image1_RedPalette.bmp"); 
 
   // Load the image as 8 bits/pixel 
   RasterImage image = codecs.Load(srcFileName, 8, CodecsLoadByteOrder.Rgb, 1, 1); 
 
   // Get the palette of this image and change it to shades of red 
   RasterColor[] palette = image.GetPalette(); 
   for (int i = 0; i < palette.Length; i++) 
      palette[i] = new RasterColor(i, 0, 0); 
 
   // Set the palette back in the image then save the file 
   image.SetPalette(palette, 0, palette.Length); 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, image.BitsPerPixel); 
 
   image.Dispose(); 
 
   codecs.Dispose(); 
}

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 PaletteExample() 
   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_RedPalette.bmp") 
 
   ' Load the image as 8 bits/pixel 
   Dim image As RasterImage = codecs.Load(srcFileName, 8, CodecsLoadByteOrder.Rgb, 1, 1) 
 
   ' Get the palette of this image and change it to shades of red 
   Dim palette As RasterColor() = image.GetPalette() 
   Dim i As Integer = 0 
   Do While i < palette.Length 
      palette(i) = New RasterColor(i, 0, 0) 
      i += 1 
   Loop 
 
   ' Set the palette back in the image then save the file 
   image.SetPalette(palette, 0, palette.Length) 
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, image.BitsPerPixel) 
 
   image.Dispose() 
 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Dicom; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Examples; 
using Leadtools.Windows.Media; 
 
public void PaletteExample(RasterImage image, Stream destStream) 
{ 
   // image should be loaded as 8 bits/pixel 
 
   // Get the palette of this image and change it to shades of red 
   RasterColor[] palette = image.GetPalette(); 
   for (int i = 0; i < palette.Length; i++) 
      palette[i] = new RasterColor(i, 0, 0); 
 
   // Set the palette back in the image then save the file 
   image.SetPalette(palette, 0, palette.Length); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 0); 
   image.Dispose(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Dicom 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Windows.Media 
 
Public Sub PaletteExample(ByVal image As RasterImage, ByVal destStream As Stream) 
   ' image should be loaded as 8 bits/pixel 
 
   ' Get the palette of this image and change it to shades of red 
   Dim palette As RasterColor() = image.GetPalette() 
   Dim i As Integer = 0 
   Do While i < palette.Length 
      palette(i) = New RasterColor(i, 0, 0) 
      i += 1 
   Loop 
 
   ' Set the palette back in the image then save the file 
   image.SetPalette(palette, 0, palette.Length) 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 0) 
   image.Dispose() 
End Sub

Requirements

Target Platforms

Reference

RasterImage Class

RasterImage Members

Download our FREE evaluation

Help Version 20.0.2020.4.2