←Select platform

RippleCommand Class

Summary

Warps the image in concentric rings. This command is available in the Imaging Pro and above toolkits.

Syntax

WinRT C#

C++

public class RippleCommand : RasterCommand

  
Public Class RippleCommand  
   Inherits Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand 
   Implements Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

public sealed class RippleCommand : Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.SpecialEffects.RippleCommand()

public ref class RippleCommand : public Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand, Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

Remarks

This command will warp the image as a series of rings radiating out from the center point. The 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-bit and 16-bit grayscale and 48-bit and 64-bit color images. Support for 12-bit and 16-bit grayscale and 48-bit and 64-bit color images is available only in the Document/Medical toolkits.
This command does not support signed data images.
This command does not support 32-bit grayscale images.

For more information, refer to Introduction to Image Processing With LEADTOOLS. For more information, refer to Applying Artistic Effects.

Example

Run the RippleCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public void RippleCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")); 
 
   // Prepare the command 
   RippleCommand command = new RippleCommand(); 
   command.CenterPoint = new LeadPoint((image.Width / 2), (image.Height / 2)); 
   command.Amplitude = 20; 
   command.Frequency = 10; 
   command.Phase = 0; 
   command.Attenuation = 0; 
   command.FillColor = new RasterColor(0, 0, 0); 
   command.Type = RippleCommandType.Repeat; 
   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.SpecialEffects 
      Leadtools.Examples.Support.SetLicense() 
 
Public Sub RippleCommandExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")) 
 
   ' Prepare the command 
   Dim command As RippleCommand = New RippleCommand 
   command.CenterPoint = New LeadPoint(leadImage.Width \ 2, leadImage.Height \ 2) 
   command.Amplitude = 20 
   command.Frequency = 10 
   command.Phase = 0 
   command.Attenuation = 0 
   command.FillColor = New RasterColor(0, 0, 0) 
   command.Type = RippleCommandType.Repeat 
   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