LEADTOOLS Image Processing (Leadtools.ImageProcessing.Effects assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
DisplacementCommand Class
See Also  Members  
Leadtools.ImageProcessing.Effects Namespace : DisplacementCommand Class



Displaces image pixels horizontally and vertically according to the values of the displacement map image. Supported in Silverlight, Windows Phone 7

Object Model

DisplacementCommand Class

Syntax

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

Example

Run the Leadtools.ImageProcessing.Effects.DisplacementCommand on an image and applies the Displace Map filter.

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

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))

   ' Prepare the command
   Dim fillColor As RasterColor = New RasterColor(0, 0, 0)
   Dim command As DisplacementCommand = New DisplacementCommand

   command.DisplacementMapImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "cannon.jpg"))
   command.HorizontalFactor = 17
   command.VerticalFactor = 24
   command.FillColor = fillColor
   command.Flags = DisplacementCommandFlags.NoChange Or DisplacementCommandFlags.StretchToFit
   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#Copy Code
public void DisplacementCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"));

      // Prepare the command
      RasterColor fillColor = new RasterColor(0, 0, 0);
      DisplacementCommand command = new DisplacementCommand();

      command.DisplacementMapImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "cannon.jpg"));
      command.HorizontalFactor = 17;
      command.VerticalFactor = 24;
      command.FillColor = fillColor;
      command.Flags = DisplacementCommandFlags.NoChange | DisplacementCommandFlags.StretchToFit;
      command.Run (image);

   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
public void DisplacementCommandExample(RasterImage image, RasterImage displacementMapImage, Stream outStream)
{
   // Prepare the command
   RasterColor fillColor = new RasterColor(0, 0, 0);
   DisplacementCommand command = new DisplacementCommand();
   command.DisplacementMapImage = displacementMapImage;
   command.HorizontalFactor = 17;
   command.VerticalFactor = 24;
   command.FillColor = fillColor;
   command.Flags = DisplacementCommandFlags.NoChange | DisplacementCommandFlags.StretchToFit;
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
   displacementMapImage.Dispose();
}
SilverlightVBCopy Code
Public Sub DisplacementCommandExample(ByVal image As RasterImage, ByVal displacementMapImage As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim fillColor As RasterColor = New RasterColor(0, 0, 0)
   Dim command As DisplacementCommand = New DisplacementCommand()
   command.DisplacementMapImage = displacementMapImage
   command.HorizontalFactor = 17
   command.VerticalFactor = 24
   command.FillColor = fillColor
   command.Flags = DisplacementCommandFlags.NoChange Or DisplacementCommandFlags.StretchToFit
   command.Run(image)
   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
   displacementMapImage.Dispose()
End Sub

Remarks

  • This command shifts image pixels according to the values of the displacement map. Red values in the displacement map shift the original pixels horizontally. Green values in the displacement map shift the original values vertically. Blue values are ignored. A displacement map value of 128 means not to shift anything. A displacement map value of 0 means to shift pixels the complete vertical or horizontal percentage, to the left or down. A displacement map value of 255 means to shift pixels the complete vertical or horizontal percentage, to the right or up.
  • Displacement maps modify the geometry of the object. As a result, pixel shifts and forms may be added to the image, and the image may be warped or distorted.
  • As an example, if you use the following image:

    And you were to use the following image as your displacement map:

    And you were to call DisplacementCommand using the following settings:
    Parameter Value
    HorizontalFactor 17
    VerticalFactor 24
    FillColor na
    Flags DisplacementCommandFlags.NoChange | DisplacementCommandFlags.StretchToFit

    The following figure results:
  • 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 signed data images.
  • 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.DisplacementCommand

Requirements

Target Platforms: Silverlight 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also

Reference

DisplacementCommand Members
Leadtools.ImageProcessing.Effects Namespace
Removing Noise
AddNoiseCommand Class
EmbossCommand Class
MosaicCommand Class
MotionBlurCommand Class
OilifyCommand Class
Leadtools.ImageProcessing.Color.PosterizeCommand
Leadtools.ImageProcessing.Color.RemoveRedEyeCommand
Leadtools.ImageProcessing.Color.SolarizeCommand
Leadtools.ImageProcessing.SpecialEffects.BendCommand
Leadtools.ImageProcessing.SpecialEffects.CylinderCommand
Leadtools.ImageProcessing.SpecialEffects.FreeHandShearCommand
Leadtools.ImageProcessing.SpecialEffects.FreeHandWaveCommand
Leadtools.ImageProcessing.SpecialEffects.PixelateCommand
Leadtools.ImageProcessing.SpecialEffects.ImpressionistCommand
Leadtools.ImageProcessing.SpecialEffects.PolarCommand
Leadtools.ImageProcessing.SpecialEffects.RadialBlurCommand
Leadtools.ImageProcessing.SpecialEffects.RadialWaveCommand
Leadtools.ImageProcessing.SpecialEffects.RippleCommand
Leadtools.ImageProcessing.SpecialEffects.SphereCommand
Leadtools.ImageProcessing.SpecialEffects.SwirlCommand
Leadtools.ImageProcessing.SpecialEffects.WindCommand
Leadtools.ImageProcessing.SpecialEffects.ZoomBlurCommand
Leadtools.ImageProcessing.SpecialEffects.ZoomWaveCommand
Leadtools.ImageProcessing.SpecialEffects.BumpMapCommand
CubismCommand Class
Leadtools.ImageProcessing.SpecialEffects.DrawStarCommand
Leadtools.ImageProcessing.SpecialEffects.DryCommand
Leadtools.ImageProcessing.SpecialEffects.FreePlaneBendCommand
Leadtools.ImageProcessing.SpecialEffects.FreeRadialBendCommand
Leadtools.ImageProcessing.SpecialEffects.GlassEffectCommand
Leadtools.ImageProcessing.SpecialEffects.GlowCommand
Leadtools.ImageProcessing.SpecialEffects.LensFlareCommand
Leadtools.ImageProcessing.SpecialEffects.LightCommand
Leadtools.ImageProcessing.SpecialEffects.OceanCommand
Leadtools.ImageProcessing.SpecialEffects.PlaneBendCommand
Leadtools.ImageProcessing.SpecialEffects.PlaneCommand
Leadtools.ImageProcessing.Color.SampleTargetCommand
Leadtools.ImageProcessing.SpecialEffects.TunnelCommand