Class CyclicShiftImageFilter

java.lang.Object

org.itk.simple.ProcessObject

org.itk.simple.ImageFilter

org.itk.simple.CyclicShiftImageFilter

public class CyclicShiftImageFilter
extends ImageFilter

Perform a cyclic spatial shift of image intensities on the image grid. This filter supports arbitrary cyclic shifts of pixel values on the image grid. If the Shift is set to [xOff, yOff], the value of the pixel at [0, 0] in the input image will be the value of the pixel in the output image at index [xOff modulo xSize, yOff modulo ySize] where xSize and ySize are the sizes of the image in the x and y dimensions, respectively. If a pixel value is moved across a boundary, the pixel value is wrapped around that boundary. For example, if the image is 40-by-40 and the Shift is [13, 47], then the value of the pixel at [0, 0] in the input image will be the value of the pixel in the output image at index [13, 7]. Negative Shifts are supported. This filter also works with images whose largest possible region starts at a non-zero index. See: itk::simple::CyclicShift for the procedural interface itk::CyclicShiftImageFilter for the Doxygen on the original ITK class. C++ includes: sitkCyclicShiftImageFilter.h

Field Summary

Fields inherited from class ProcessObject

swigCMemOwn

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor	Description
	CyclicShiftImageFilter()	itk::simple::CyclicShiftImageFilter::CyclicShiftImageFilter() Default Constructor that takes no arguments and initializes default parameters
protected	CyclicShiftImageFilter(long cPtr, boolean cMemoryOwn)

Method Summary

Modifier and Type	Method	Description
void	delete()	virtual itk::simple::CyclicShiftImageFilter::~CyclicShiftImageFilter() Destructor
Image	execute(Image image1)	Image itk::simple::CyclicShiftImageFilter::Execute(const Image &image1) Execute the filter on the input image
protected void	finalize()
protected static long	getCPtr(CyclicShiftImageFilter obj)
String	getName()	std::string itk::simple::CyclicShiftImageFilter::GetName() const Name of this class
VectorInt32	getShift()	std::vector<int> itk::simple::CyclicShiftImageFilter::GetShift() const Set/get the shift.
void	setShift(int value)	Self& itk::simple::CyclicShiftImageFilter::SetShift(std::vector< int > Shift) Set/get the shift.
void	setShift(VectorInt32 Shift)	Self& itk::simple::CyclicShiftImageFilter::SetShift(std::vector< int > Shift) Set/get the shift.
protected static long	swigRelease(CyclicShiftImageFilter obj)
String	toString()	std::string itk::simple::CyclicShiftImageFilter::ToString() const Print ourselves out

Methods inherited from class ImageFilter

getCPtr, swigRelease

Modifier and Type	Method	Description
protected static long	getCPtr(ImageFilter obj)
protected static long	swigRelease(ImageFilter obj)

Methods inherited from class ProcessObject

abort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease

Modifier and Type	Method	Description
void	abort()	virtual void itk::simple::ProcessObject::Abort() Sets an abort flag on the active process.
int	addCommand(EventEnum event, Command cmd)	virtual int itk::simple::ProcessObject::AddCommand(itk::simple::EventEnum event, itk::simple::Command &cmd) Add a Command Object to observer the event.
void	debugOff()
void	debugOn()
protected static long	getCPtr(ProcessObject obj)
boolean	getDebug()
static double	getGlobalDefaultCoordinateTolerance()
static boolean	getGlobalDefaultDebug()
static double	getGlobalDefaultDirectionTolerance()
static long	getGlobalDefaultNumberOfThreads()
static String	getGlobalDefaultThreader()
static boolean	getGlobalWarningDisplay()
long	getNumberOfThreads()
long	getNumberOfWorkUnits()
float	getProgress()	virtual float itk::simple::ProcessObject::GetProgress() const An Active Measurement of the progress of execution.
static void	globalDefaultDebugOff()
static void	globalDefaultDebugOn()
static void	globalWarningDisplayOff()
static void	globalWarningDisplayOn()
boolean	hasCommand(EventEnum event)	virtual bool itk::simple::ProcessObject::HasCommand(itk::simple::EventEnum event) const Query of this object has any registered commands for event.
void	removeAllCommands()	virtual void itk::simple::ProcessObject::RemoveAllCommands() Remove all registered commands.
void	setDebug(boolean debugFlag)
static void	setGlobalDefaultCoordinateTolerance(double arg0)
static void	setGlobalDefaultDebug(boolean debugFlag)
static void	setGlobalDefaultDirectionTolerance(double arg0)
static void	setGlobalDefaultNumberOfThreads(long n)
static boolean	setGlobalDefaultThreader(String threader)
static void	setGlobalWarningDisplay(boolean flag)
void	setNumberOfThreads(long n)
void	setNumberOfWorkUnits(long n)
protected static long	swigRelease(ProcessObject obj)

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CyclicShiftImageFilter

protected CyclicShiftImageFilter(long cPtr,
 boolean cMemoryOwn)

CyclicShiftImageFilter

public CyclicShiftImageFilter()

itk::simple::CyclicShiftImageFilter::CyclicShiftImageFilter() Default Constructor that takes no arguments and initializes default parameters

Method Details

getCPtr

protected static long getCPtr(CyclicShiftImageFilter obj)

swigRelease

protected static long swigRelease(CyclicShiftImageFilter obj)

finalize

protected void finalize()

Overrides:

finalize in class ImageFilter

delete

public void delete()

virtual itk::simple::CyclicShiftImageFilter::~CyclicShiftImageFilter() Destructor

Overrides:

delete in class ImageFilter

setShift

public void setShift(VectorInt32 Shift)

Self& itk::simple::CyclicShiftImageFilter::SetShift(std::vector< int > Shift) Set/get the shift. Shifts may be positive or negative.

setShift

public void setShift(int value)

Self& itk::simple::CyclicShiftImageFilter::SetShift(std::vector< int > Shift) Set/get the shift. Shifts may be positive or negative.

getShift

public VectorInt32 getShift()

std::vector<int> itk::simple::CyclicShiftImageFilter::GetShift() const Set/get the shift. Shifts may be positive or negative.

getName

public String getName()

std::string itk::simple::CyclicShiftImageFilter::GetName() const Name of this class

Overrides:

getName in class ProcessObject

toString

public String toString()

std::string itk::simple::CyclicShiftImageFilter::ToString() const Print ourselves out

Overrides:

toString in class ProcessObject

execute

public Image execute(Image image1)

Image itk::simple::CyclicShiftImageFilter::Execute(const Image &image1) Execute the filter on the input image