DesaturateCommand Class

Summary

Converts the image to a grayscale level by reducing the saturation of each color to zero. The conversion will not change the color resolution.

Syntax

Objective-C

C++

Java

public class DesaturateCommand : RasterCommand

Public Class DesaturateCommand  
   Inherits RasterCommand

@interface LTDesaturateCommand : LTRasterCommand

public class DesaturateCommand extends RasterCommand

public ref class DesaturateCommand : public RasterCommand

Remarks

The image is converted to a grayscale level by reducing the saturation of each color to zero.
This class supports only RGB images. It does not support grayscale images.
Support for 48-bit and 64-bit colored images are available only in the Document/Medical toolkits.
This class does not support signed data images.
This command does not support 32-bit grayscale images.

For more information, refer to Introduction to Image Processing With LEADTOOLS. For more information, refer to Grayscale Images.

Example

Run the DesaturateCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Color; 
 
public void DesaturateCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")); 
 
   // Prepare the command 
   // Apply deSaturate effect on the image. 
   DesaturateCommand command = new DesaturateCommand(); 
   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 DesaturateCommandExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")) 
 
   ' Prepare the command 
   ' Apply deSaturate effect on the image. 
   Dim command As DesaturateCommand = New DesaturateCommand 
   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 DesaturateCommandExample(RasterImage image, Stream outStream) 
{ 
   // Prepare the command 
   // Apply deSaturate effect on the image. 
   DesaturateCommand command = new DesaturateCommand(); 
   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 DesaturateCommandExample(ByVal image As RasterImage, ByVal outStream As Stream) 
   ' Prepare the command 
   ' Apply deSaturate effect on the image. 
   Dim command As DesaturateCommand = New DesaturateCommand() 
   command.Run(image) 
 
   ' Save result image 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24) 
   image.Dispose() 
End Sub