AverageCommand Class

Summary

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

Objective-C

C++

Java

public class AverageCommand : RasterCommand

Public Class AverageCommand  
   Inherits RasterCommand

@interface LTAverageCommand : LTRasterCommand

public class AverageCommand extends RasterCommand

public ref class AverageCommand : public RasterCommand

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.
This command supports signed/unsigned data images.

For more information, refer to Removing Noise.

Example

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

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Effects; 
 
public void AverageCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample2.cmp")); 
 
   // Prepare the command 
   AverageCommand command = new AverageCommand(); 
   // Average with a neighborhood of 3x3 pixels  
   command.Dimension = 3; 
   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"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Effects 
 
Public Sub AverageCommandExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample2.cmp")) 
 
   ' 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, 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#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Effects; 
using Leadtools.Examples; 
 
public void AverageCommandExample(RasterImage image, Stream outStream) 
{ 
   // Prepare the command 
   AverageCommand command = new AverageCommand(); 
   // Average with a neighborhood of 3x3 pixels  
   command.Dimension = 3; 
   command.Run(image); 
   // Save result image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24); 
   image.Dispose(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Effects 
 
Public Sub AverageCommandExample(ByVal image As RasterImage, ByVal outStream As Stream) 
   ' Prepare the command 
   Dim command As AverageCommand = New AverageCommand() 
   ' Average with a neighborhood of 3x3 pixels  
   command.Dimension = 3 
   command.Run(image) 
   ' Save result image 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24) 
   image.Dispose() 
End Sub