DisplacementCommand Class

Summary

Displaces image pixels horizontally and vertically according to the values of the displacement map image.

Syntax

Objective-C

C++/CLI

Java

Python

public class DisplacementCommand : RasterCommand

@interface LTDisplacementCommand : LTRasterCommand

public class DisplacementCommand 
    extends RasterCommand

public ref class DisplacementCommand : public RasterCommand

class DisplacementCommand(RasterCommand):

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.

Displacement Function - Before

Displacement Function - After

View additional platform support for this Displacement function.

Example

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

Java

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:\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.DisplacementCommand; 
import leadtools.imageprocessing.effects.DisplacementCommandFlags; 
 
 
public void displacementCommandExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   final String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "Result.jpg"); 
 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.setThrowExceptionsOnInvalidImages(true); 
 
   RasterImage image = codecs.load(combine(LEAD_VARS_IMAGES_DIR, "Master.jpg")); 
 
   // Prepare the command 
   RasterColor fillColor = new RasterColor(0, 0, 0); 
   DisplacementCommand command = new DisplacementCommand(); 
 
   command.setDisplacementMapImage(codecs.load(combine(LEAD_VARS_IMAGES_DIR, "cannon.jpg"))); 
   command.setHorizontalFactor(17); 
   command.setVerticalFactor(24); 
   command.setFillColor(fillColor); 
   command.setFlags( 
         DisplacementCommandFlags.NO_CHANGE.getValue() | DisplacementCommandFlags.STRETCH_TO_FIT.getValue()); 
   int change = command.run(image); 
   assertTrue(change != RasterImageChangedFlags.NONE); 
 
   codecs.save(image, outputFileName, RasterImageFormat.JPEG, 0); 
   System.out.println("Command run and image saved to " + outputFileName); 
}