DisplacementCommand Class

C#
Visual Basic
WinRT C#
Java
Objective-C
WinRT JavaScript
C++

public class DisplacementCommand : Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

'Declaration

Public Class DisplacementCommand 
   Inherits Leadtools.ImageProcessing.RasterCommand
   Implements Leadtools.ImageProcessing.IRasterCommand

'Usage

Dim instance As DisplacementCommand

public sealed class DisplacementCommand : Leadtools.ImageProcessing.IRasterCommand

@interface LTDisplacementCommand : LTRasterCommand

public class DisplacementCommand extends RasterCommand

function Leadtools.ImageProcessing.Effects.DisplacementCommand()

public ref class DisplacementCommand : public Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

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.

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

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing.Effects

   
Public Sub DisplacementCommandExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ImageProcessingDemo\\Image2.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, "ImageProcessingDemo\\Image1.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

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.Effects;

      
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";
}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.Effects;
using Leadtools.ImageProcessing;

      
public async Task DisplacementCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   // Load the image
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

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

   srcFileName = @"Assets\Image1.cmp";
   loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   command.DisplacementMapImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));
   command.HorizontalFactor = 17;
   command.VerticalFactor = 24;
   command.FillColor = fillColor;
   command.Flags = DisplacementCommandFlags.NoChange | DisplacementCommandFlags.StretchToFit;
   command.Run (image);

   //Save as BMP
   string destFileName = @"result.bmp";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24);
}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.Effects;
using Leadtools.Examples;

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();
}

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing.Effects

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

Target Platforms

Reference