Package org.itk.simple
Class SliceImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.SliceImageFilter
Slices an image based on a starting index and a stopping index, and a
step size.
This class is designed to facilitate the implementation of extended
sliced based indexing into images.
The input and output image must be of the same dimension.
The input parameters are a starting and stopping index as well as a
stepping size. The starting index indicates the first pixels to be
used and for each dimension the index is incremented by the step until
the index is equal to or "beyond" the stopping index. If the step is
negative then the image will be reversed in the dimension, and the
stopping index is expected to be less then the starting index. If the
stopping index is already beyond the starting index then an image of
size zero will be returned.
The output image's starting index is always zero. The origin is the
physical location of the starting index. The output directions cosine
matrix is that of the input but with sign changes matching that of the
step's sign.
In certain combinations such as with start=1, and step>1 while the
physical location of the center of the pixel remains the same, the
extent (edge to edge space) of the output image will be beyond the
extent of the original image.
See:
itk::simple::Slice for the procedural interface
itk::SliceImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkSliceImageFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::SliceImageFilter::SliceImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
SliceImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::SliceImageFilter::~SliceImageFilter() DestructorImage itk::simple::SliceImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected void
finalize()
protected static long
getCPtr
(SliceImageFilter obj) getName()
std::string itk::simple::SliceImageFilter::GetName() const Name of this classgetStart()
std::vector<int32_t> itk::simple::SliceImageFilter::GetStart() const Set/Get the first index extracted from the input imagegetStep()
std::vector<int> itk::simple::SliceImageFilter::GetStep() const Set/Get the stride of indexes extracted An exception will be generated if 0.getStop()
std::vector<int32_t> itk::simple::SliceImageFilter::GetStop() const Set/Get the excluded end of the rangevoid
setStart
(VectorInt32 Start) Self& itk::simple::SliceImageFilter::SetStart(std::vector< int32_t > Start) Set/Get the first index extracted from the input imagevoid
setStep
(int value) Self& itk::simple::SliceImageFilter::SetStep(std::vector< int > Step) Set/Get the stride of indexes extracted An exception will be generated if 0.void
setStep
(VectorInt32 Step) Self& itk::simple::SliceImageFilter::SetStep(std::vector< int > Step) Set/Get the stride of indexes extracted An exception will be generated if 0.void
setStop
(VectorInt32 Stop) Self& itk::simple::SliceImageFilter::SetStop(std::vector< int32_t > Stop) Set/Get the excluded end of the rangeprotected static long
toString()
std::string itk::simple::SliceImageFilter::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
-
SliceImageFilter
protected SliceImageFilter(long cPtr, boolean cMemoryOwn) -
SliceImageFilter
public SliceImageFilter()itk::simple::SliceImageFilter::SliceImageFilter() 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::SliceImageFilter::~SliceImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setStart
Self& itk::simple::SliceImageFilter::SetStart(std::vector< int32_t > Start) Set/Get the first index extracted from the input image -
getStart
std::vector<int32_t> itk::simple::SliceImageFilter::GetStart() const Set/Get the first index extracted from the input image -
setStop
Self& itk::simple::SliceImageFilter::SetStop(std::vector< int32_t > Stop) Set/Get the excluded end of the range -
getStop
std::vector<int32_t> itk::simple::SliceImageFilter::GetStop() const Set/Get the excluded end of the range -
setStep
Self& itk::simple::SliceImageFilter::SetStep(std::vector< int > Step) Set/Get the stride of indexes extracted An exception will be generated if 0. -
setStep
public void setStep(int value) Self& itk::simple::SliceImageFilter::SetStep(std::vector< int > Step) Set/Get the stride of indexes extracted An exception will be generated if 0. -
getStep
std::vector<int> itk::simple::SliceImageFilter::GetStep() const Set/Get the stride of indexes extracted An exception will be generated if 0. -
getName
std::string itk::simple::SliceImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::SliceImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::SliceImageFilter::Execute(const Image &image1) Execute the filter on the input image
-