Class FFTShiftImageFilter

java.lang.Object

org.itk.simple.ProcessObject

org.itk.simple.ImageFilter

org.itk.simple.FFTShiftImageFilter

public class FFTShiftImageFilter
extends ImageFilter

Shift the zero-frequency components of a Fourier transform to the center of the image. The Fourier transform produces an image where the zero frequency components are in the corner of the image, making it difficult to understand. This filter shifts the component to the center of the image. For images with an odd-sized dimension, applying this filter twice will not produce the same image as the original one without using SetInverse(true) on one (and only one) of the two filters. https://doi.org/10.54294/xd0lzg Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. See: ForwardFFTImageFilter , InverseFFTImageFilter itk::simple::FFTShift for the procedural interface itk::FFTShiftImageFilter for the Doxygen on the original ITK class. C++ includes: sitkFFTShiftImageFilter.h

Field Summary

Fields inherited from class ProcessObject

swigCMemOwn

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	delete()	virtual itk::simple::FFTShiftImageFilter::~FFTShiftImageFilter() Destructor
Image	execute(Image image1)	Image itk::simple::FFTShiftImageFilter::Execute(const Image &image1) Execute the filter on the input image
protected void	finalize()
protected static long	getCPtr(FFTShiftImageFilter obj)
boolean	getInverse()	bool itk::simple::FFTShiftImageFilter::GetInverse() const Set/Get whether the filter must invert the transform or not.
String	getName()	std::string itk::simple::FFTShiftImageFilter::GetName() const Name of this class
void	inverseOff()	Self& itk::simple::FFTShiftImageFilter::InverseOff()
void	inverseOn()	Self& itk::simple::FFTShiftImageFilter::InverseOn() Set the value of Inverse to true or false respectfully.
void	setInverse(boolean Inverse)	Self& itk::simple::FFTShiftImageFilter::SetInverse(bool Inverse) Set/Get whether the filter must invert the transform or not.
protected static long	swigRelease(FFTShiftImageFilter obj)
String	toString()	std::string itk::simple::FFTShiftImageFilter::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

FFTShiftImageFilter

protected FFTShiftImageFilter(long cPtr,
 boolean cMemoryOwn)

FFTShiftImageFilter

public FFTShiftImageFilter()

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

Method Details

getCPtr

protected static long getCPtr(FFTShiftImageFilter obj)

swigRelease

protected static long swigRelease(FFTShiftImageFilter obj)

finalize

protected void finalize()

Overrides:

finalize in class ImageFilter

delete

public void delete()

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

Overrides:

delete in class ImageFilter

setInverse

public void setInverse(boolean Inverse)

Self& itk::simple::FFTShiftImageFilter::SetInverse(bool Inverse) Set/Get whether the filter must invert the transform or not. This option has no effect if none of the size of the input image is even, but is required to restore the original image if at least one of the dimensions has an odd size.

inverseOn

public void inverseOn()

Self& itk::simple::FFTShiftImageFilter::InverseOn() Set the value of Inverse to true or false respectfully.

inverseOff

public void inverseOff()

Self& itk::simple::FFTShiftImageFilter::InverseOff()

getInverse

public boolean getInverse()

bool itk::simple::FFTShiftImageFilter::GetInverse() const Set/Get whether the filter must invert the transform or not. This option has no effect if none of the size of the input image is even, but is required to restore the original image if at least one of the dimensions has an odd size.

getName

public String getName()

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

Overrides:

getName in class ProcessObject

toString

public String toString()

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

Overrides:

toString in class ProcessObject

execute

public Image execute(Image image1)

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