Leadtools.ImageProcessing.Color Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
DesaturateCommand Class
See Also  Members   Example 



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

Visual Basic (Declaration) 
Public Class DesaturateCommand 
   Inherits RasterCommand
   Implements IRasterCommand 
Visual Basic (Usage)Copy Code
Dim instance As DesaturateCommand
C# 
public class DesaturateCommand : RasterCommand, IRasterCommand 
C++/CLI 
public ref class DesaturateCommand : public RasterCommand, IRasterCommand 

Example

Run the DesaturateCommand on an image.

Visual BasicCopy Code
Public Sub DesaturateCommandExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   ' Apply deSaturate effect on the image.
   Dim command As DesaturateCommand = New DesaturateCommand
   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void DesaturateCommandExample() 
{ 
   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   // Apply deSaturate effect on the image. 
   DesaturateCommand command = new DesaturateCommand(); 
   command.Run(image); 
   codecs.Save(image, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

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.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.Color.DesaturateCommand

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also