ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkRegionOfInterestImageFilter.h>
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.
Definition at line 53 of file itkRegionOfInterestImageFilter.h.
typedef SmartPointer< const Self > itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::ConstPointer |
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 61 of file itkRegionOfInterestImageFilter.h.
typedef TInputImage::IndexType itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::IndexType |
Definition at line 72 of file itkRegionOfInterestImageFilter.h.
typedef TInputImage::PixelType itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::InputImagePixelType |
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 77 of file itkRegionOfInterestImageFilter.h.
typedef Superclass::InputImageRegionType itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::InputImageRegionType |
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 62 of file itkRegionOfInterestImageFilter.h.
typedef TOutputImage::PixelType itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::OutputImagePixelType |
Typedef to describe the type of pixel.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 76 of file itkRegionOfInterestImageFilter.h.
typedef SmartPointer< Self > itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::Pointer |
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 60 of file itkRegionOfInterestImageFilter.h.
typedef TInputImage::RegionType itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::RegionType |
Typedef to describe the input image region types.
Definition at line 68 of file itkRegionOfInterestImageFilter.h.
typedef RegionOfInterestImageFilter itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::Self |
Standard class typedefs.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 58 of file itkRegionOfInterestImageFilter.h.
typedef TInputImage::SizeType itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::SizeType |
Definition at line 73 of file itkRegionOfInterestImageFilter.h.
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::Superclass |
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 59 of file itkRegionOfInterestImageFilter.h.
itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::RegionOfInterestImageFilter | ( | ) | [protected] |
End concept checking
itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::~RegionOfInterestImageFilter | ( | ) | [inline, protected] |
End concept checking
Definition at line 102 of file itkRegionOfInterestImageFilter.h.
itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::RegionOfInterestImageFilter | ( | const Self & | ) | [private] |
virtual::itk::LightObject::Pointer itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::CreateAnother | ( | void | ) | const [virtual] |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
virtual void itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion | ( | DataObject * | ) | [protected, virtual] |
Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.
Reimplemented from itk::ProcessObject.
virtual void itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion | ( | ) | [protected, virtual] |
What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.
This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
virtual void itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation | ( | ) | [protected, virtual] |
RegionOfInterestImageFilter can produce an image which is a different size than its input image. As such, RegionOfInterestImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.
Reimplemented from itk::ProcessObject.
virtual const char* itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
virtual RegionType itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::GetRegionOfInterest | ( | ) | const [virtual] |
Set/Get the output image region.
static Pointer itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::Object.
void itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::operator= | ( | const Self & | ) | [private] |
PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
void itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::PrintSelf | ( | std::ostream & | os, |
Indent | indent | ||
) | const [protected, virtual] |
End concept checking
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
virtual void itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::SetRegionOfInterest | ( | RegionType | _arg | ) | [virtual] |
Set/Get the output image region.
void itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData | ( | const RegionType & | outputRegionForThread, |
ThreadIdType | threadId | ||
) | [protected] |
RegionOfInterestImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"
itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::typedef | ( | Concept::SameDimension< ImageDimension, OutputImageDimension > | ) |
Begin concept checking This class requires SameDimensionCheck in the form of ( Concept::SameDimension< ImageDimension, OutputImageDimension > )
itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::typedef | ( | Concept::Convertible< InputImagePixelType, OutputImagePixelType > | ) |
This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > )
const unsigned int itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static] |
ImageDimension enumeration
Definition at line 86 of file itkRegionOfInterestImageFilter.h.
RegionType itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::m_RegionOfInterest [private] |
Definition at line 136 of file itkRegionOfInterestImageFilter.h.
const unsigned int itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static] |
ImageDimension enumeration
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
Definition at line 88 of file itkRegionOfInterestImageFilter.h.