Package org.itk.simple
Class RegionOfInterestImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.RegionOfInterestImageFilter
Extract a region of interest from the input image.
This filter produces an output image of the same dimension as the
input image. The user specifies the region of the input image that
will be contained in the output image. The origin coordinates of the
output images will be computed in such a way that if mapped to
physical space, the output image will overlay the input image with
perfect registration. In other words, a registration process between
the output image and the input image will return an identity
transform.
If you are interested in changing the dimension of the image, you may
want to consider the ExtractImageFilter . For example for extracting a 2D image from a slice of a 3D image.
The region to extract is set using the method SetRegionOfInterest.
See:
ExtractImageFilter
itk::simple::RegionOfInterest for the procedural interface
itk::RegionOfInterestImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkRegionOfInterestImageFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::RegionOfInterestImageFilter::RegionOfInterestImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
RegionOfInterestImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::RegionOfInterestImageFilter::~RegionOfInterestImageFilter() DestructorImage itk::simple::RegionOfInterestImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected void
finalize()
protected static long
getIndex()
std::vector<int> itk::simple::RegionOfInterestImageFilter::GetIndex() constgetName()
std::string itk::simple::RegionOfInterestImageFilter::GetName() const Name of this classgetSize()
std::vector<unsigned int> itk::simple::RegionOfInterestImageFilter::GetSize() constvoid
setIndex
(VectorInt32 Index) Self& itk::simple::RegionOfInterestImageFilter::SetIndex(std::vector< int > Index) Set the inclusive starting index of the region extracted.void
setRegionOfInterest
(VectorUInt32 Region) void itk::simple::RegionOfInterestImageFilter::SetRegionOfInterest(const std::vector< unsigned int > &Region) Sets the region extracted by a single array of the starting indexes followed by the sizes in pixels.void
setSize
(VectorUInt32 Size) Self& itk::simple::RegionOfInterestImageFilter::SetSize(std::vector< unsigned int > Size) Size in pixels of the region extracted.protected static long
toString()
std::string itk::simple::RegionOfInterestImageFilter::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
-
RegionOfInterestImageFilter
protected RegionOfInterestImageFilter(long cPtr, boolean cMemoryOwn) -
RegionOfInterestImageFilter
public RegionOfInterestImageFilter()itk::simple::RegionOfInterestImageFilter::RegionOfInterestImageFilter() 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::RegionOfInterestImageFilter::~RegionOfInterestImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setSize
Self& itk::simple::RegionOfInterestImageFilter::SetSize(std::vector< unsigned int > Size) Size in pixels of the region extracted. -
getSize
std::vector<unsigned int> itk::simple::RegionOfInterestImageFilter::GetSize() const -
setIndex
Self& itk::simple::RegionOfInterestImageFilter::SetIndex(std::vector< int > Index) Set the inclusive starting index of the region extracted. -
getIndex
std::vector<int> itk::simple::RegionOfInterestImageFilter::GetIndex() const -
getName
std::string itk::simple::RegionOfInterestImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::RegionOfInterestImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::RegionOfInterestImageFilter::Execute(const Image &image1) Execute the filter on the input image -
setRegionOfInterest
void itk::simple::RegionOfInterestImageFilter::SetRegionOfInterest(const std::vector< unsigned int > &Region) Sets the region extracted by a single array of the starting indexes followed by the sizes in pixels.
-