OffsetCommand Class

Summary

Shifts the image data horizontally and vertically.

Syntax

Objective-C

C++/CLI

Java

Python

public class OffsetCommand : RasterCommand

@interface LTOffsetCommand : LTRasterCommand

public class OffsetCommand 
    extends RasterCommand

public ref class OffsetCommand : public RasterCommand

class OffsetCommand(RasterCommand):

Remarks

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 Applying Artistic Effects.

Offset Function - Before

Offset Function - After

View additional platform support for this Offset function.

Example

Run the OffsetCommand on an image.

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Effects; 
 
 
public void OffsetCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, @"ImageProcessingDemo\NaturalFruits.jpg")); 
 
   // Prepare the command 
   OffsetCommand command = new OffsetCommand(); 
   command.HorizontalShift = image.Width / 2; 
   command.VerticalShift = image.Height / 2; 
   command.BackColor = new RasterColor(128, 128, 128); 
   command.Type = OffsetCommandType.Color; 
   //Apply offset on the image. 
   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:\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.*; 
 
 
public void offsetCommandExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.setThrowExceptionsOnInvalidImages(true); 
 
   RasterImage image = codecs.load(combine(LEAD_VARS_IMAGES_DIR, "NaturalFruits.jpg")); 
 
   // Prepare the command 
   OffsetCommand command = new OffsetCommand(); 
   command.setHorizontalShift(image.getWidth() / 2); 
   command.setVerticalShift(image.getHeight() / 2); 
   command.setBackColor(new RasterColor(128, 128, 128)); 
   command.setType(OffsetCommandType.COLOR); 
 
   // Apply offset on the image. 
   int change = command.run(image); 
   assertTrue(change != RasterImageChangedFlags.NONE); 
 
   codecs.save(image, combine(LEAD_VARS_IMAGES_DIR, "Result.jpg"), RasterImageFormat.JPEG, 24); 
   System.out.println("Command run, image saved to " + combine(LEAD_VARS_IMAGES_DIR, "Result.jpg")); 
}