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



Removes low frequency details in an image, resulting in a sharpened image. Supported in Silverlight, Windows Phone 7

Object Model

HighPassCommand Class

Syntax

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

Example

Run the Leadtools.ImageProcessing.Effects.HighPassCommand on an image and applies the HighPass filter.

Visual BasicCopy Code
Public Sub HighPassCommandExample()
   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 HighPassCommand = New HighPassCommand
   command.Radius = 6
   command.Opacity = 100
   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 HighPassCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      HighPassCommand command = new HighPassCommand () ;
      command.Radius = 6 ;
      command.Opacity = 100 ;
      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 HighPassCommandExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   HighPassCommand command = new HighPassCommand();
   command.Radius = 6;
   command.Opacity = 100;
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}
SilverlightVBCopy Code
Public Sub HighPassCommandExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As HighPassCommand = New HighPassCommand()
   command.Radius = 6
   command.Opacity = 100
   command.Run(image)
   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
End Sub

Remarks

  • This command removes low-frequency detail in the image. The method is opposite to that of the Gaussian Blur method
  • To increase the thickness of the edges, increase the value of radius. Usually a low value for radius is better.
  • Unlike the UnsharpMaskCommand, when using this command, the low frequency features are removed from the image.
  • As an example, if you use the following image:

    And you were to call HighPassCommand using the following settings:
    Parameter Value
    Radius 6
    Opacity 100

    The following figure results:
  • If the image has a region, the command will be applied on the region only.
  • This command 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 command does not support 32-bit grayscale images.
For more information, refer to Removing Noise.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.Effects.HighPassCommand

Requirements

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

See Also