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++/CLI

Java

Python

public class AverageCommand : RasterCommand

@interface LTAverageCommand : LTRasterCommand

public class AverageCommand 
    extends RasterCommand

public ref class AverageCommand : public RasterCommand

class AverageCommand(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.

Average Filter Function - Before

Average Filter Function - After

View additional platform support for this Average Filter function.

Example

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

Java

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:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.effects.AverageCommand; 
 
 
public void averageCommandExample() { 
    final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
 
    // Load an image 
    RasterCodecs codecs = new RasterCodecs(); 
    codecs.setThrowExceptionsOnInvalidImages(true); 
 
    RasterImage image = codecs.load(combine(LEAD_VARS_IMAGES_DIR, "sample2.cmp")); 
 
    // Prepare the command 
    AverageCommand command = new AverageCommand(); 
 
    // Average with a neighorhood of 3x3 pixels 
    command.setDimension(3); 
    int change = command.run(image); 
    assertTrue(change != RasterImageChangedFlags.NONE); 
 
    codecs.save(image, combine(LEAD_VARS_IMAGES_DIR, "Result.jpg"), RasterImageFormat.JPEG, 24); 
    System.out.println("Command run and output image saved to " + combine(LEAD_VARS_IMAGES_DIR, "Result.jpg")); 
}