DesaturateCommand Class

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public class DesaturateCommand : Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

'Declaration
 
Public Class DesaturateCommand 
   Inherits Leadtools.ImageProcessing.RasterCommand
   Implements Leadtools.ImageProcessing.IRasterCommand

'Usage
 
Dim instance As DesaturateCommand

public sealed class DesaturateCommand : Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.Color.DesaturateCommand()

public ref class DesaturateCommand : public Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

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.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub DesaturateCommandExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))

   ' 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

public void DesaturateCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"));

      // 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";
}

[TestMethod]
public async Task DesaturateCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   // Load the image
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Prepare the command
   // Apply deSaturate effect on the image.
   DesaturateCommand command = new DesaturateCommand();
   command.Run(image);

   string destFileName = @"result.jpg";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Jpeg, 0);
}

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

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

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DesaturateCommand Members
Leadtools.ImageProcessing.Color Namespace
Introduction to Image Processing With LEADTOOLS
Grayscale Images
Color Halftone and Halftone Images
BalanceColorsCommand Class
Leadtools.ImageProcessing.GrayscaleCommand
GrayScaleExtendedCommand Class
Leadtools.RasterImage.IsGray
AutoColorLevelCommand Class
ColorLevelCommand Class
Leadtools.ImageProcessing.Core.CorrelationListCommand
GrayScaleToDuotoneCommand Class
GrayScaleToMultitoneCommand Class
Leadtools.ImageProcessing.Core.HolePunchRemoveCommand
SelectiveColorCommand Class
Leadtools.ImageProcessing.Effects.SkeletonCommand