MultiscaleEnhancementCommand Constructor(Int32,Int32,Int32,Int32,Int32,MultiscaleEnhancementCommandType,MultiscaleEnhancementCommandFlags)

Initializes a new MultiscaleEnhancementCommand class object with explicit parameters.

Syntax

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

public MultiscaleEnhancementCommand( 
   int contrast,
   int edgeLevels,
   int edgeCoefficient,
   int latitudeLevels,
   int latitudeCoefficient,
   MultiscaleEnhancementCommandType type,
   MultiscaleEnhancementCommandFlags flags
)

'Declaration
 
Public Function New( _
   ByVal contrast As Integer, _
   ByVal edgeLevels As Integer, _
   ByVal edgeCoefficient As Integer, _
   ByVal latitudeLevels As Integer, _
   ByVal latitudeCoefficient As Integer, _
   ByVal type As MultiscaleEnhancementCommandType, _
   ByVal flags As MultiscaleEnhancementCommandFlags _
)

'Usage
 
Dim contrast As Integer
Dim edgeLevels As Integer
Dim edgeCoefficient As Integer
Dim latitudeLevels As Integer
Dim latitudeCoefficient As Integer
Dim type As MultiscaleEnhancementCommandType
Dim flags As MultiscaleEnhancementCommandFlags
 
Dim instance As New MultiscaleEnhancementCommand(contrast, edgeLevels, edgeCoefficient, latitudeLevels, latitudeCoefficient, type, flags)

public MultiscaleEnhancementCommand( 
   int contrast,
   int edgeLevels,
   int edgeCoefficient,
   int latitudeLevels,
   int latitudeCoefficient,
   MultiscaleEnhancementCommandType type,
   MultiscaleEnhancementCommandFlags flags
)

function MultiscaleEnhancementCommand( 
   contrast ,
   edgeLevels ,
   edgeCoefficient ,
   latitudeLevels ,
   latitudeCoefficient ,
   type ,
   flags 
)

public:
MultiscaleEnhancementCommand( 
   int contrast,
   int edgeLevels,
   int edgeCoefficient,
   int latitudeLevels,
   int latitudeCoefficient,
   MultiscaleEnhancementCommandType type,
   MultiscaleEnhancementCommandFlags flags
)

Parameters

contrast: Fraction of contrast enhancement applied to the image. Valid values range from 0 - 10000, which are interpreted as 0 percent - 100 percent. This value is internally divided by 10000. Greater values will produce stronger contrast.
edgeLevels: The number of levels that will be used for edge enhancement. Valid values are from 1 to the maximum number of levels of the image. -1 will use the default number of levels (which is 3). This option will take effect only if MultiscaleEnhancementCommandFlags.EdgeEnhancement is set in the flags parameter. Passing zero will return an error code.
edgeCoefficient: The edge enhancement coefficient. This value will be internally divided by 100. Pass -1 to use the default values (which is 170 interpreted as 1.7). This option will be used only if EdgeEnhancment is set in the flags parameter. Any value (>= 0) is valid. A value of 100 will be interpreted as 1.0 and will keep the image's edges un-enhanced. Larger values will produce more visible edges. Smaller values will produce less visible edges. Practically, the enhancement levels out at 200000 (interpreted as 2000.0) - values bigger than that will not enhance the image's edges any more.
latitudeLevels: The number of levels that will be used for Latitude reduction. Valid values are from 1 to maximum number of levels of the image. You can also pass -1 to use the default level value (which is 5). This option will be used only if the MultiscaleEnhancementCommandFlags.LatitudeReduction is set in Flags. Passing zero will return an error code.
latitudeCoefficient: The latitude reduction coefficient. This value will be internally divided by 100. Pass -1 to use the default values (which is 140 interpreted as 1.4). This option will be used only if MultiscaleEnhancementCommandFlags.LatitudeReduction is set in the flags parameter. Any value (>= 0) is valid. A value of 100 will be interpreted as 1.0 and will keep the image's latitude un-enhanced. Decreasing latitude makes the image brighter, increasing latitude makes the image dimmer. Practically, the enhancement levels out at 200000 (interpreted as 2000,0) - values bigger than that will not decrease the image's latitude any more.
type: Value that indicates the type of filter used.
flags: Flag that determines the command behavior.

Example

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

Public Sub MultiScaleEnhancementConstructorExample_S3()
   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 MultiscaleEnhancementCommand = New MultiscaleEnhancementCommand(2000, 4, -1, 0, 0, MultiscaleEnhancementCommandType.Gaussian, MultiscaleEnhancementCommandFlags.EdgeEnhancement)
   ' Apply multiscale enhancement
   command.Run(leadImage)

End Sub

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

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

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

      // Prepare the command
      MultiscaleEnhancementCommand command = new MultiscaleEnhancementCommand(2000, 4, -1, 0, 0, MultiscaleEnhancementCommandType.Gaussian, MultiscaleEnhancementCommandFlags.EdgeEnhancement);
      // Apply multiscale enhancement
      command.Run(image);

   }

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

[TestMethod]
public async Task MultiScaleEnhancementConstructorExample_S3()
{
   // 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
   MultiscaleEnhancementCommand command = new MultiscaleEnhancementCommand(2000, 4, -1, 0, 0, MultiscaleEnhancementCommandType.Gaussian, MultiscaleEnhancementCommandFlags.EdgeEnhancement);
   // Apply multiscale enhancement
   command.Run(image);

}

public void MultiScaleEnhancementConstructorExample_S3(RasterImage image, Stream outStream)
{
   // Prepare the command
   MultiscaleEnhancementCommand command = new MultiscaleEnhancementCommand(2000, 4, -1, 0, 0, MultiscaleEnhancementCommandType.Gaussian, MultiscaleEnhancementCommandFlags.EdgeEnhancement);
   // Apply multiscale enhancement
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}

Public Sub MultiScaleEnhancementConstructorExample_S3(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As MultiscaleEnhancementCommand = New MultiscaleEnhancementCommand(2000, 4, -1, 0, 0, MultiscaleEnhancementCommandType.Gaussian, _
                                                                                  MultiscaleEnhancementCommandFlags.EdgeEnhancement)
   ' Apply multiscale enhancement
   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

MultiscaleEnhancementCommand Class
MultiscaleEnhancementCommand Members
Overload List