SetPalette Method

Summary

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

Syntax

Objective-C

C++/CLI

Java

Python

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

- (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 
)

def SetPalette(self,] palette,startIndex,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 Leadtools.Svg; 
 
 
public void PaletteExample() 
{ 
	RasterCodecs codecs = new RasterCodecs(); 
 
	string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
	string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "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(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

RasterImage Class

RasterImage Members

Download our FREE evaluation

Help Version 22.0.2023.5.16

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies