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



Divides the image into rectangular or circular cells and then recreates the image by filling those cells with the minimum, maximum, or average pixel value, depending upon the effect that was selected. This command is available in the Raster Pro and above toolkits.

Syntax

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

Example

Run the PixelateCommand on an image. by dividing it into circular cells with angle length = 5, and radius = 10.

Visual Basic Copy Code
Public Sub PixelateCommandExample()
   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 PixelateCommand = New PixelateCommand
   command.CenterPoint = New Point(leadImage.Width \ 2, leadImage.Height \ 2)
   command.CellWidth = 5
   command.CellHeight = 10
   command.Opacity = 100
   command.Flags = PixelateCommandFlags.Radial Or _
      PixelateCommandFlags.WidthPeriod Or _
      PixelateCommandFlags.HeightPeriod Or _
   PixelateCommandFlags.Average
   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void PixelateCommandExample() 
{ 
   // 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 
   PixelateCommand command   = new PixelateCommand(); 
   command.CenterPoint       = new Point((image.Width / 2), (image.Height / 2)); 
   command.CellWidth         = 5; 
   command.CellHeight        = 10; 
   command.Opacity           = 100; 
   command.Flags             = PixelateCommandFlags.Radial | 
      PixelateCommandFlags.WidthPeriod  | 
      PixelateCommandFlags.HeightPeriod | 
      PixelateCommandFlags.Average; 
   command.Run(image); 
   codecs.Save(image, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

Remarks

  • This command will divide the image into rectangular or circular cells.
  • Flags indicate whether to use rectangular or circular cells and indicates the type of information in the other properties or parameters.
  • If the image is divided into circular cells by setting the PixelateCommandFlags.Radial flag, the cells will be centered around the specified center point. This center point must be defined inside the image or inside the region, if the image has a region. If the image has a region, the effect will be applied on the region only.
  • This command supports 12- and 16-bit grayscale and 48- and 64-bit color images. Supportfor 12- and 16-bit grayscale and 48- and 64-bit color images is available only in the Document/Medical toolkits.
  • An example of circular cell division can be seen below:
    This is the original image:



    The image below is the result of the following settings:
    command.Flags = PixelateCommandFlags.Radial | PixelateCommandFlags.WidthPeriod | PixelateCommandFlags.HeightPeriod | PixelateCommandFlags.Average;
    command.CellWidth = 90;
    command.CellHeight = 40;

    This indicates the circular cells are divided into 90 degree cell divisions and each cell has a radial length of 40 pixels. Each cell division is filled with the average value for that cell division.



    The image below is the result of the following settings:

    command.Flags = PixelateCommandFlags.Radial | PixelateCommandFlags.WidthFrequency | PixelateCommandFlags.HeightFrequency | PixelateCommandFlags.Average;
    command.CellWidth = 90;
    command.CellHeight = 40;

    This indicates the circular cells are divided into 90 separate cell divisions around the center point and there are 40 cell divisions along the radius. Each cell division is filled with the average value for that cell division.

  • This command does not support signed data images.
  • This command does not support 32-bit grayscale images.
For more information, refer to Applying Artistic Effects.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.SpecialEffects.PixelateCommand

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