ConvertToColoredGrayCommand Class

Converts an image to a grayscale image, then enhances the color components based on the class properties. This class is available in the Document Toolkits.

Object Model

Syntax

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

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

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

'Usage
 
Dim instance As ConvertToColoredGrayCommand

public sealed class ConvertToColoredGrayCommand : Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.Color.ConvertToColoredGrayCommand()

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

Remarks

This class is more general than the GrayScaleExtendedCommand class. The ConvertToColoredGrayCommand class can be used to give images a "sepia" look by adding a blue or brown color.
RedFactor + GreenFactor + BlueFactor must equal 1000. (Internally the values are divided by 1000).
For each pixel in the image the red, green and blue values are modified by the RedFactor, GreenFactor and BlueFactor properties, respectively. This allows the user to give more weight to one color, essentially enhancing that color, before the pixel is converted to grayscale.
For example, if this class is used with the RedFactor set to 500, the GreenFactor set to 250 and the BlueFactor set to 250, the red value of each pixel will get 50 percent of the weight when determining the grayscale value. The green value will get 25 percent of the weight and the blue value will get 25 percent of the weight when determining the grayscale value. This highlights or enhances the red in the image, prior to conversion to grayscale. Upon conversion to grayscale, the red, green and blue components of the output pixel are the same. Call this value G. Therefore, the RGB values for the pixel would be (G, G, G).
Once the grayscale value for the pixel has been obtained, the red component of the output pixel can be further modified using the RedGrayFactor value. The equation for this can be seen below:
The green and blue components are found similarly, using the GreenGrayFactor and the BlueGrayFactor values, respectively.
Please note that the RedGrayFactor, GreenGrayFactor and BlueGrayFactor values can be negative. A negative value results in a decrease in pixel intensity. A positive value results in an increase in pixel intensity.
If RedGrayFactor = GreenGrayFactor = BlueGrayFactor = 0, then the output is the same as the output from the GrayScaleExtendedCommand method.
This class 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 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

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

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

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

   ' Prepare the command
   Dim command As ConvertToColoredGrayCommand = New ConvertToColoredGrayCommand
   'These arguments will transform the image into a grayscale image.
   command.RedFactor = 300
   command.GreenFactor = 590
   command.BlueFactor = 110
   command.RedGrayFactor = 500
   command.GreenGrayFactor = 300
   command.BlueGrayFactor = 200
   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 ConvertToColoredGrayCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      ConvertToColoredGrayCommand command = new ConvertToColoredGrayCommand();
      //These arguments will transform the image into a grayscale image.
      command.RedFactor       = 300; 
      command.GreenFactor     = 590;
      command.BlueFactor      = 110;
      command.RedGrayFactor   = 500;
      command.GreenGrayFactor = 300;
      command.BlueGrayFactor  = 200;
      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 ConvertToColoredGrayCommandExample()
{
   // 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
   ConvertToColoredGrayCommand command = new ConvertToColoredGrayCommand();
   //These arguments will transform the image into a grayscale image.
   command.RedFactor       = 300; 
   command.GreenFactor     = 590;
   command.BlueFactor      = 110;
   command.RedGrayFactor   = 500;
   command.GreenGrayFactor = 300;
   command.BlueGrayFactor  = 200;
   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 ConvertToColoredGrayCommandExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   ConvertToColoredGrayCommand command = new ConvertToColoredGrayCommand();
   //These arguments will transform the image into a grayscale image.
   command.RedFactor       = 300; 
   command.GreenFactor     = 590;
   command.BlueFactor      = 110;
   command.RedGrayFactor   = 500;
   command.GreenGrayFactor = 300;
   command.BlueGrayFactor  = 200;
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}

Public Sub ConvertToColoredGrayCommandExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As ConvertToColoredGrayCommand = New ConvertToColoredGrayCommand()
   'These arguments will transform the image into a grayscale image.
   command.RedFactor = 300
   command.GreenFactor = 590
   command.BlueFactor = 110
   command.RedGrayFactor = 500
   command.GreenGrayFactor = 300
   command.BlueGrayFactor = 200
   command.Run(image)
   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
End Sub

Requirements

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

ConvertToColoredGrayCommand Members
Leadtools.ImageProcessing.Color Namespace
Introduction to Image Processing With LEADTOOLS
Grayscale Images
BalanceColorsCommand Class
Leadtools.ImageProcessing.GrayscaleCommand
GrayScaleExtendedCommand Class
Leadtools.RasterImage.IsGray