Package org.itk.simple
Class CyclicShiftImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.CyclicShiftImageFilter
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 org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::CyclicShiftImageFilter::CyclicShiftImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
CyclicShiftImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::CyclicShiftImageFilter::~CyclicShiftImageFilter() DestructorImage itk::simple::CyclicShiftImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected void
finalize()
protected static long
getName()
std::string itk::simple::CyclicShiftImageFilter::GetName() const Name of this classgetShift()
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
toString()
std::string itk::simple::CyclicShiftImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.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
-
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
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::CyclicShiftImageFilter::~CyclicShiftImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setShift
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
std::vector<int> itk::simple::CyclicShiftImageFilter::GetShift() const Set/get the shift. Shifts may be positive or negative. -
getName
std::string itk::simple::CyclicShiftImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::CyclicShiftImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::CyclicShiftImageFilter::Execute(const Image &image1) Execute the filter on the input image
-