Flag Property

Gets or sets a value that indicates whether the method will process the image.

Syntax

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

public AutoColorLevelCommandFlags Flag {get; set;}

'Declaration
 
Public Property Flag As AutoColorLevelCommandFlags

'Usage
 
Dim instance As AutoColorLevelCommand
Dim value As AutoColorLevelCommandFlags
 
instance.Flag = value
 
value = instance.Flag

public AutoColorLevelCommandFlags Flag {get; set;}

 get_Flag();
 set_Flag(value);

public:
property AutoColorLevelCommandFlags Flag {
   AutoColorLevelCommandFlags get();
   void set (    AutoColorLevelCommandFlags value);
}

Property Value

The method to process the image.

Example

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

Public Sub FlagPropertyExample()
   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 AutoColorLevelCommand = New AutoColorLevelCommand(AutoColorLevelCommandType.Intensity, AutoColorLevelCommandFlags.None)
   command.Flag = AutoColorLevelCommandFlags.NoProcess
   command.Type = AutoColorLevelCommandType.Level

   ' Apply "Auto Leveling" to the image.
   command.Run(leadImage)
   codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24)

   MessageBox.Show("Master Leveling Value: " & Chr(13) & " Gamma: " & command.Master.Gamma & Chr(13) & _
      " Minimum Input: " & command.Master.MinimumInput & Chr(13) & _
      " Minimum Input: " & command.Master.MaximumInput & Chr(13) & _
      " Minimum Input: " & command.Master.MinimumOutput & Chr(13) & _
      " Minimum Input: " & command.Master.MaximumOutput)

   MessageBox.Show("Red Leveling Value: " & Chr(13) & " Gamma: " & command.Red.Gamma & Chr(13) & _
      " Minimum Input: " & command.Red.MinimumInput & Chr(13) & _
      " Minimum Input: " & command.Red.MaximumInput & Chr(13) & _
      " Minimum Input: " & command.Red.MinimumOutput & Chr(13) & _
      " Minimum Input: " & command.Red.MaximumOutput)

   MessageBox.Show("Green Leveling Value: " & Chr(13) & " Gamma: " & command.Green.Gamma & Chr(13) & _
      " Minimum Input: " & command.Green.MinimumInput & Chr(13) & _
      " Minimum Input: " & command.Green.MaximumInput & Chr(13) & _
      " Minimum Input: " & command.Green.MinimumOutput & Chr(13) & _
      " Minimum Input: " & command.Green.MaximumOutput)

   MessageBox.Show("Blue Leveling Value: " & Chr(13) & " Gamma: " & command.Blue.Gamma & Chr(13) & _
      " Minimum Input: " & command.Blue.MinimumInput & Chr(13) & _
      " Minimum Input: " & command.Blue.MaximumInput & Chr(13) & _
      " Minimum Input: " & command.Blue.MinimumOutput & Chr(13) & _
      " Minimum Input: " & command.Blue.MaximumOutput)

End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

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

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

      // Prepare the command
      AutoColorLevelCommand command = new AutoColorLevelCommand();
      command.Flag = AutoColorLevelCommandFlags.NoProcess;
      command.Type = AutoColorLevelCommandType.Level;

      // Apply "Auto Leveling" to the image.
      command.Run(image);

      MessageBox.Show("Master Leveling Value: \n Gamma: " + command.Master.Gamma + "\n" +
         " Minimum Input: " + command.Master.MinimumInput + "\n" +
         " Minimum Input: " + command.Master.MaximumInput + "\n" +
         " Minimum Input: " + command.Master.MinimumOutput + "\n" +
         " Minimum Input: " + command.Master.MaximumOutput);

      MessageBox.Show("Red Leveling Value: \n Gamma: " + command.Red.Gamma + "\n" +
         " Minimum Input: " + command.Red.MinimumInput + "\n" +
         " Minimum Input: " + command.Red.MaximumInput + "\n" +
         " Minimum Input: " + command.Red.MinimumOutput + "\n" +
         " Minimum Input: " + command.Red.MaximumOutput);

      MessageBox.Show("Green Leveling Value: \n Gamma: " + command.Green.Gamma + "\n" +
         " Minimum Input: " + command.Green.MinimumInput + "\n" +
         " Minimum Input: " + command.Green.MaximumInput + "\n" +
         " Minimum Input: " + command.Green.MinimumOutput + "\n" +
         " Minimum Input: " + command.Green.MaximumOutput);

      MessageBox.Show("Blue Leveling Value: \n Gamma: " + command.Blue.Gamma + "\n" +
         " Minimum Input: " + command.Blue.MinimumInput + "\n" +
         " Minimum Input: " + command.Blue.MaximumInput + "\n" +
         " Minimum Input: " + command.Blue.MinimumOutput + "\n" +
         " Minimum Input: " + command.Blue.MaximumOutput);

   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

[TestMethod]
public async Task FlagPropertyExample()
{
   // 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
   AutoColorLevelCommand command = new AutoColorLevelCommand();
   command.Flag = AutoColorLevelCommandFlags.NoProcess;
   command.Type = AutoColorLevelCommandType.Level;

   // Apply "Auto Leveling" to the image.
   command.Run(image);

   Debug.WriteLine("Master Leveling Value: \n Gamma: " + command.Master.Gamma + "\n" +
      " Minimum Input: " + command.Master.MinimumInput + "\n" +
      " Minimum Input: " + command.Master.MaximumInput + "\n" +
      " Minimum Input: " + command.Master.MinimumOutput + "\n" +
      " Minimum Input: " + command.Master.MaximumOutput);

   Debug.WriteLine("Red Leveling Value: \n Gamma: " + command.Red.Gamma + "\n" +
      " Minimum Input: " + command.Red.MinimumInput + "\n" +
      " Minimum Input: " + command.Red.MaximumInput + "\n" +
      " Minimum Input: " + command.Red.MinimumOutput + "\n" +
      " Minimum Input: " + command.Red.MaximumOutput);

   Debug.WriteLine("Green Leveling Value: \n Gamma: " + command.Green.Gamma + "\n" +
      " Minimum Input: " + command.Green.MinimumInput + "\n" +
      " Minimum Input: " + command.Green.MaximumInput + "\n" +
      " Minimum Input: " + command.Green.MinimumOutput + "\n" +
      " Minimum Input: " + command.Green.MaximumOutput);

   Debug.WriteLine("Blue Leveling Value: \n Gamma: " + command.Blue.Gamma + "\n" +
      " Minimum Input: " + command.Blue.MinimumInput + "\n" +
      " Minimum Input: " + command.Blue.MaximumInput + "\n" +
      " Minimum Input: " + command.Blue.MinimumOutput + "\n" +
      " Minimum Input: " + command.Blue.MaximumOutput);

}

public void FlagPropertyExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   AutoColorLevelCommand command = new AutoColorLevelCommand();
   command.Flag = AutoColorLevelCommandFlags.NoProcess;
   command.Type = AutoColorLevelCommandType.Level;
   // Apply "Auto Leveling" to the image.
   command.Run(image);

   Debug.WriteLine("Master Leveling Value: \n Gamma: " + command.Master.Gamma + "\n" +
      " Minimum Input: " + command.Master.MinimumInput + "\n" +
      " Minimum Input: " + command.Master.MaximumInput + "\n" +
      " Minimum Input: " + command.Master.MinimumOutput + "\n" +
      " Minimum Input: " + command.Master.MaximumOutput);

   Debug.WriteLine("Red Leveling Value: \n Gamma: " + command.Red.Gamma + "\n" +
      " Minimum Input: " + command.Red.MinimumInput + "\n" +
      " Minimum Input: " + command.Red.MaximumInput + "\n" +
      " Minimum Input: " + command.Red.MinimumOutput + "\n" +
      " Minimum Input: " + command.Red.MaximumOutput);

   Debug.WriteLine("Green Leveling Value: \n Gamma: " + command.Green.Gamma + "\n" +
      " Minimum Input: " + command.Green.MinimumInput + "\n" +
      " Minimum Input: " + command.Green.MaximumInput + "\n" +
      " Minimum Input: " + command.Green.MinimumOutput + "\n" +
      " Minimum Input: " + command.Green.MaximumOutput);

   Debug.WriteLine("Blue Leveling Value: \n Gamma: " + command.Blue.Gamma + "\n" +
      " Minimum Input: " + command.Blue.MinimumInput + "\n" +
      " Minimum Input: " + command.Blue.MaximumInput + "\n" +
      " Minimum Input: " + command.Blue.MinimumOutput + "\n" +
      " Minimum Input: " + command.Blue.MaximumOutput);

   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}

Public Sub FlagPropertyExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As AutoColorLevelCommand = New AutoColorLevelCommand()
   command.Flag = AutoColorLevelCommandFlags.NoProcess
   command.Type = AutoColorLevelCommandType.Level
   ' Apply "Auto Leveling" to the image.
   command.Run(image)

   Debug.WriteLine("Master Leveling Value: " & Constants.vbLf & " Gamma: " & command.Master.Gamma + Constants.vbLf & " Minimum Input: " & _
                   command.Master.MinimumInput + Constants.vbLf & " Minimum Input: " & command.Master.MaximumInput + Constants.vbLf & _
                   " Minimum Input: " & command.Master.MinimumOutput + Constants.vbLf & " Minimum Input: " & command.Master.MaximumOutput)

   Debug.WriteLine("Red Leveling Value: " & Constants.vbLf & " Gamma: " & command.Red.Gamma + Constants.vbLf & " Minimum Input: " & _
                   command.Red.MinimumInput + Constants.vbLf & " Minimum Input: " & command.Red.MaximumInput + Constants.vbLf & " Minimum Input: " & _
                   command.Red.MinimumOutput + Constants.vbLf & " Minimum Input: " & command.Red.MaximumOutput)

   Debug.WriteLine("Green Leveling Value: " & Constants.vbLf & " Gamma: " & command.Green.Gamma + Constants.vbLf & " Minimum Input: " & _
                   command.Green.MinimumInput + Constants.vbLf & " Minimum Input: " & command.Green.MaximumInput + Constants.vbLf & " Minimum Input: " & _
                   command.Green.MinimumOutput + Constants.vbLf & " Minimum Input: " & command.Green.MaximumOutput)

   Debug.WriteLine("Blue Leveling Value: " & Constants.vbLf & " Gamma: " & command.Blue.Gamma + Constants.vbLf & " Minimum Input: " & _
                   command.Blue.MinimumInput + Constants.vbLf & " Minimum Input: " & command.Blue.MaximumInput + Constants.vbLf & " Minimum Input: " & _
                   command.Blue.MinimumOutput + Constants.vbLf & " Minimum Input: " & command.Blue.MaximumOutput)

   ' 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

AutoColorLevelCommand Class
AutoColorLevelCommand Members