Leadtools.ImageProcessing.Effects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
AverageCommand Class
See Also  Members   Example 
Leadtools.ImageProcessing.Effects Namespace : AverageCommand Class



Changes the color of each pixel in an image to the average color of pixels in its neighborhood. This results in a blur effect.

Syntax

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

Example

Run the AverageCommand on an image with a neighborhood Dimensions = 3x3 pixels.

Visual BasicCopy Code
Public Sub AverageCommandExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   Dim command As AverageCommand = New AverageCommand
   ' Average with a neighborhood of 3x3 pixels
   command.Dimension = 3

   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void AverageCommandExample() 
{ 
   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   AverageCommand command = new AverageCommand(); 
   // Average with a neighborhood of 3x3 pixels  
   command.Dimension = 3; 
   command.Run(image); 
   codecs.Save(image, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

Remarks

  • You control the amount of blur by specifying the size of the neighborhood that is used for averaging.
  • 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.AverageCommand

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also