LEADTOOLS Image Processing (Leadtools.ImageProcessing.Color assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
BalanceColorsCommand Class
See Also  Members  



Redistributes the RGB values of a specific image, using the values in the BalanceColorCommandFactor class. Supported in Silverlight, Windows Phone 7

Object Model

BalanceColorsCommand ClassBalanceColorCommandFactor ClassBalanceColorCommandFactor ClassBalanceColorCommandFactor Class

Syntax

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

Example

Run the BalanceColorsCommand on an image.

Visual BasicCopy Code
Public Sub BalanceColorsCommandExample()
   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 BalanceColorsCommand = New BalanceColorsCommand
   command.RedFactor = New BalanceColorCommandFactor(0.25, 0.5, 0.25)
   command.GreenFactor = New BalanceColorCommandFactor(0.3, 0.4, 0.3)
   command.BlueFactor = New BalanceColorCommandFactor(0.1, 0.6, 0.3)
   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#Copy Code
public void BalanceColorsCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      BalanceColorsCommand command   = new BalanceColorsCommand();
      command.RedFactor              = new BalanceColorCommandFactor(0.25, 0.50, 0.25);
      command.GreenFactor            = new BalanceColorCommandFactor(0.30, 0.40, 0.30);
      command.BlueFactor             = new BalanceColorCommandFactor(0.10, 0.60, 0.30);
      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";
}
SilverlightCSharpCopy Code
public void BalanceColorsCommandExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   BalanceColorsCommand command   = new BalanceColorsCommand();
   command.RedFactor              = new BalanceColorCommandFactor(0.25, 0.50, 0.25);
   command.GreenFactor            = new BalanceColorCommandFactor(0.30, 0.40, 0.30);
   command.BlueFactor             = new BalanceColorCommandFactor(0.10, 0.60, 0.30);
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}
SilverlightVBCopy Code
Public Sub BalanceColorsCommandExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As BalanceColorsCommand = New BalanceColorsCommand()
   command.RedFactor = New BalanceColorCommandFactor(0.25, 0.50, 0.25)
   command.GreenFactor = New BalanceColorCommandFactor(0.30, 0.40, 0.30)
   command.BlueFactor = New BalanceColorCommandFactor(0.10, 0.60, 0.30)
   command.Run(image)
   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
End Sub

Remarks

  • For each pixel in the image, the red value is modified using the values in the RedFactor property. This generates an intermediate red value, an intermediate green value and an intermediate blue value.
  • For each pixel in the image, the green value is modified using the values in the GreenFactor property. This generates an intermediate red value, an intermediate green value and an intermediate blue value.
  • For each pixel in the image the blue value is modified using the values in the BlueFactor property. This generates an intermediate red value, an intermediate green value and an intermediate blue value.
  • The intermediate red values are added to generate the new red value for the pixel. The intermediate green values are added to generate the new green value for the pixel and the intermediate blue values are added to generate the new blue value for the pixel. This triplet forms the new RGB value for the pixel.
  • The BalanceColorCommandFactor class has three components of type double: ToRed, ToGreen and ToBlue. The possible values of each component must be within the range: 0.0 - 1.0.
  • This class supports 48 and 64-bit colored images.
  • This method does not support signed data images.
  • This command does not support 32-bit grayscale images.
For more information, refer to Correcting Colors.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.Color.BalanceColorsCommand

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also