ChangeSaturationCommand Class

Summary

Increases or decreases the saturation of colors in an image.

Syntax

Objective-C

C++

Java

public class ChangeSaturationCommand : RasterCommand

Public Class ChangeSaturationCommand  
   Inherits RasterCommand

@interface LTChangeSaturationCommand : LTRasterCommand

public class ChangeSaturationCommand extends RasterCommand

public ref class ChangeSaturationCommand : public 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.

Example

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

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:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Color 
 
Public Sub ChangeSaturationCommandExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ImageProcessingDemo\\Image1.jpg")) 
 
   ' Prepare the command 
   Dim command As ChangeSaturationCommand = New ChangeSaturationCommand 
   'Increase the color saturation by 25 percent  of the possible range. 
   command.Change = 250 
 
   command.Run(leadImage) 
   codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24) 
 
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.ImageProcessing.Color; 
using Leadtools.Examples; 
 
public void ChangeSaturationCommandExample(RasterImage image, Stream outStream) 
{ 
   // Prepare the command 
   ChangeSaturationCommand command = new ChangeSaturationCommand(); 
   //Increase the color saturation by 25 percent  of the possible range. 
   command.Change = 250; 
   command.Run(image); 
 
   // Save result image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24); 
   image.Dispose(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Color 
 
Public Sub ChangeSaturationCommandExample(ByVal image As RasterImage, ByVal outStream As Stream) 
   ' Prepare the command 
   Dim command As ChangeSaturationCommand = New ChangeSaturationCommand() 
   'Increase the color saturation by 25 percent  of the possible range. 
   command.Change = 250 
   command.Run(image) 
 
   ' Save result image 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24) 
   image.Dispose() 
End Sub