ChangeSaturationCommand Class

Summary

Increases or decreases the saturation of colors in an image.

Syntax

Objective-C

C++/CLI

Java

Python

public class ChangeSaturationCommand : RasterCommand

@interface LTChangeSaturationCommand : LTRasterCommand

public class ChangeSaturationCommand 
    extends RasterCommand

public ref class ChangeSaturationCommand : public RasterCommand

class ChangeSaturationCommand(RasterCommand):

Remarks

Negative values decrease the saturation of colors. Positive values increase the saturation. The saturation level is increased or decreased by a percentage of its present saturation level. For example, an increase of 20 percent of the current saturation level "L" will raise the new saturation level "L1" to a value L + 0.20 * L. Likewise, increasing the saturation level 100 percent doubles the saturation level ( L1 = L + 1.0 * L). Decreasing the saturation level 100 percent will set the new saturation level to 0. This process is carried out for every pixel.
This command supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.
This command supports unsigned data images, but not signed ones.
This command does not support 32-bit grayscale images.

For more information, refer to Changing Brightness and Contrast. For more information, refer to Correcting Colors.

Change Saturation Function - Before

Change Saturation Function - After

View additional platform support for this Change Saturation function.

Example

Run the ChangeSaturationCommand on an image and increase its color saturation.

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Color; 
 
 
public void ChangeSaturationCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ImageProcessingDemo\\Image1.jpg")); 
 
   // Prepare the command 
   ChangeSaturationCommand command = new ChangeSaturationCommand(); 
   //Increase the color saturation by 25 percent  of the possible range. 
   command.Change = 250; 
   command.Run(image); 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24); 
 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import static org.junit.Assert.assertTrue; 
 
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 leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.color.*; 
 
 
public void changeSaturationCommandExample() { 
 
    final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
 
    // Load an image 
    RasterCodecs codecs = new RasterCodecs(); 
    codecs.setThrowExceptionsOnInvalidImages(true); 
 
    RasterImage image = codecs.load(combine(LEAD_VARS_IMAGES_DIR, "Image1.jpg")); 
 
    // Prepare the command 
    ChangeSaturationCommand command = new ChangeSaturationCommand(); 
    // Increase the color saturation by 25 percent of the possible range. 
    command.setChange(250); 
    command.run(image); 
    codecs.save(image, combine(LEAD_VARS_IMAGES_DIR, "Result.jpg"), RasterImageFormat.JPEG, 24); 
 
    System.out.println("Command run and image saved to " + combine(LEAD_VARS_IMAGES_DIR, "Result.jpg")); 
    assertTrue(new File(combine(LEAD_VARS_IMAGES_DIR, "Result.jpg")).exists()); 
 
}