SetPalette Method

Summary

Sets the custom palette to use when converting the image.

Syntax

Objective-C

C++/CLI

Java

Python

public void SetPalette( 
   RasterColor[] value 
)

@property (nonatomic, copy, nullable) NSArray<LTRasterColor *> *palette

public void setPalette(RasterColor[] value)

public: 
void SetPalette(  
   array<RasterColor>^ value 
)

def SetPalette(self,] value):

Parameters

value
The palette to use.

Remarks

Use the GetPalette method to get the palette to use.

The custom palette to use. Specify this parameter as follows:

If you want to use the fixed palette or a fully optimized palette, pass a null reference in this property.
If you want to supply the entire palette, specify ColorResolutionCommandPaletteFlags.UsePalette in the PaletteFlags property and set this property. Click here to see how to fill in the palette.
If you want the command to fill part of your palette with optimized colors, specify ColorResolutionCommandPaletteFlags.Optimized in the PaletteFlags property and set this property. Click here to see how to fill in the palette.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
 
 
public void ColorResolutionCommandExample() 
{ 
	RasterCodecs codecs = new RasterCodecs(); 
 
	string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
	string destFileName1 = Path.Combine(LEAD_VARS.ImagesDir, "Image1_colorres8.bmp"); 
	string destFileName2 = Path.Combine(LEAD_VARS.ImagesDir, "Image1_colorres4.bmp"); 
 
	// Load the source image from disk 
	RasterImage image = codecs.Load(srcFileName); 
 
	// First color-res it to 8 bits per pixel  using the Netscape palette into a seperate image 
	ColorResolutionCommand cmd = new ColorResolutionCommand(); 
	cmd.Mode = ColorResolutionCommandMode.CreateDestinationImage; 
	cmd.BitsPerPixel = 8; 
	cmd.Order = RasterByteOrder.Rgb; 
	cmd.DitheringMethod = RasterDitheringMethod.None; 
	cmd.PaletteFlags = ColorResolutionCommandPaletteFlags.UsePalette; 
	cmd.SetPalette(RasterPalette.Netscape()); 
	cmd.Run(image); 
 
	RasterImage destImage = cmd.DestinationImage; 
	Assert.IsTrue(destImage.BitsPerPixel == 8); 
 
	// Save it to disk 
	codecs.Save(destImage, destFileName1, RasterImageFormat.Bmp, 8); 
	destImage.Dispose(); 
 
	// Now color-res the image in-place to 4-bits per pixel using the Optimized palette 
	cmd.Mode = ColorResolutionCommandMode.InPlace; 
	cmd.BitsPerPixel = 4; 
	cmd.Order = RasterByteOrder.Rgb; 
	cmd.DitheringMethod = RasterDitheringMethod.None; 
	cmd.PaletteFlags = ColorResolutionCommandPaletteFlags.Optimized; 
	cmd.Run(image); 
	Assert.IsTrue(image.BitsPerPixel == 4); 
 
	// Save it to disk 
	codecs.Save(image, destFileName2, RasterImageFormat.Bmp, 4); 
 
	// Clean Up 
	destImage.Dispose(); 
	image.Dispose(); 
	codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.*; 
 
 
public void colorResolutionCommandExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "rgsref.cmp"); 
   String destFileName1 = combine(LEAD_VARS_IMAGES_DIR, "rgsref_colorres8.bmp"); 
   String destFileName2 = combine(LEAD_VARS_IMAGES_DIR, "rgsref_colorres4.bmp"); 
 
   // Load the source image from disk 
   RasterImage image = codecs.load(srcFileName); 
 
   // First color-res it to 8 bits per pixel using the Netscape palette into a 
   // seperate image 
   ColorResolutionCommand cmd = new ColorResolutionCommand(); 
   cmd.setMode(ColorResolutionCommandMode.CREATE_DESTINATION_IMAGE); 
   cmd.setBitsPerPixel(8); 
   cmd.setOrder(RasterByteOrder.RGB); 
   cmd.setDitheringMethod(RasterDitheringMethod.NONE); 
   cmd.setPaletteFlags(ColorResolutionCommandPaletteFlags.USE_PALETTE.getValue()); 
   cmd.setPalette(RasterPalette.netscape()); 
   cmd.run(image); 
 
   RasterImage destImage = cmd.getDestinationImage(); 
   assertTrue(destImage.getBitsPerPixel() == 8); 
 
   // Save it to disk 
   codecs.save(destImage, destFileName1, RasterImageFormat.BMP, 8); 
 
   assertTrue("file unsuccessfully saved to " + destFileName1, (new File(destFileName1)).exists()); 
   System.out.printf("File saved successfully to %s%n", destFileName1); 
 
   destImage.dispose(); 
 
   // Now color-res the image in-place to 4-bits per pixel using the Optimized 
   // palette 
   cmd.setMode(ColorResolutionCommandMode.IN_PLACE); 
   cmd.setBitsPerPixel(4); 
   cmd.setOrder(RasterByteOrder.RGB); 
   cmd.setDitheringMethod(RasterDitheringMethod.NONE); 
   cmd.setPaletteFlags(ColorResolutionCommandPaletteFlags.OPTIMIZED.getValue()); 
   cmd.run(image); 
   assertTrue(image.getBitsPerPixel() == 4); 
 
   // Save it to disk 
   codecs.save(image, destFileName2, RasterImageFormat.BMP, 4); 
 
   assertTrue("file unsuccessfully saved to " + destFileName1, (new File(destFileName1)).exists()); 
   System.out.printf("File saved successfully to %s%n", destFileName1); 
 
   // Clean Up 
   destImage.dispose(); 
   image.dispose(); 
   codecs.dispose(); 
}

Requirements

Target Platforms

Reference

ColorResolutionCommand Class

ColorResolutionCommand Members

Download our FREE evaluation

Help Version 23.0.2024.5.22