FREE::SpatialRegionOfInterestImageFilter

FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage > Class Template Reference
[ITK image filter controller]

Extract a region of interest from the input image that is defined by a spatial object. More...

#include <freSpatialRegionOfInterestImageFilter.h>

List of all members.

Public Types

typedef
SpatialRegionOfInterestImageFilter 		Self
typedef
itk::ImageToImageFilter
< TInputImage,
TOutputImage > 		Superclass
typedef
itk::SmartPointer
< Self > 		Pointer
typedef
itk::SmartPointer
< const Self > 		ConstPointer
typedef
Superclass::InputImageRegionType 		InputImageRegionType
typedef
TInputImage::RegionType 		RegionType
typedef
TInputImage::IndexType 		IndexType
typedef
TInputImage::SizeType 		SizeType
typedef
TInputImage::PointType 		PointType
typedef
TOutputImage::PixelType 		OutputImagePixelType
typedef
TInputImage::PixelType 		InputImagePixelType
typedef
itk::SpatialObject
< TInputImage::ImageDimension > 		SpatialObjectType
typedef
SpatialObjectType::Pointer 		SpatialObjectPointer

Public Member Functions

virtual
::itk::LightObject::Pointer 		CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual void SetSpatialRegionOfInterest (SpatialObjectType *pROI)
virtual
SpatialObjectType * 		GetSpatialRegionOfInterest ()
virtual void SetOutsideValue (const OutputImagePixelType _arg)
virtual
OutputImagePixelType 		GetOutsideValue ()
virtual void SetCropByInput (const bool _arg)
virtual bool GetCropByInput ()

Static Public Member Functions

static Pointer New (void)

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

 SpatialRegionOfInterestImageFilter ()
 ~SpatialRegionOfInterestImageFilter ()
void PrintSelf (std::ostream &os, itk::Indent indent) const
virtual void GenerateInputRequestedRegion ()
virtual void EnlargeOutputRequestedRegion (itk::DataObject *output)
virtual void GenerateOutputInformation ()
void ThreadedGenerateData (const RegionType &outputRegionForThread, int threadId)
RegionType GenerateLargestSpatialRegion (const TInputImage *pInput)

Private Member Functions

 SpatialRegionOfInterestImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

SpatialObjectPointer m_SpatialObject
OutputImagePixelType m_OutsideValue
bool m_CropByInput

Detailed Description

template<class TInputImage, class TOutputImage>
class FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >

Extract a region of interest from the input image that is defined by a spatial object.

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. In difference to the itk::RegionOfInterestImageFilter the region of interest is defined by a passed spatial object (plus children). The bounding box of the spatial object defines the region. Any pixel of the output image that is not inside the spatial object will be set to the OutsideValue.

Definition at line 50 of file freSpatialRegionOfInterestImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TOutputImage>
typedef SpatialRegionOfInterestImageFilter FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 55 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef itk::ImageToImageFilter< TInputImage, TOutputImage> FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 56 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef itk::SmartPointer<Self> FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 57 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef itk::SmartPointer<const Self> FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 58 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImageRegionType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 59 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::RegionType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::RegionType

Typedef to describe the input image region types.

Definition at line 65 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::IndexType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 69 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::SizeType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 70 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::PointType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::PointType

Definition at line 71 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::PixelType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

Definition at line 74 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::PixelType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 75 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef itk::SpatialObject< TInputImage::ImageDimension > FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SpatialObjectType

Typedef to describe the spatial object.

Definition at line 78 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef SpatialObjectType::Pointer FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SpatialObjectPointer

Definition at line 79 of file freSpatialRegionOfInterestImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>
FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SpatialRegionOfInterestImageFilter (  )  [inline, protected]

Definition at line 41 of file freSpatialRegionOfInterestImageFilter.txx.

template<class TInputImage, class TOutputImage>
FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::~SpatialRegionOfInterestImageFilter (  )  [inline, protected]

Definition at line 108 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SpatialRegionOfInterestImageFilter ( const Self &   )  [private]

Member Function Documentation

template<class TInputImage, class TOutputImage>
static Pointer FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::New ( void   )  [inline, static]

Method for creation through the object factory.

Definition at line 62 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
virtual ::itk::LightObject::Pointer FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::CreateAnother ( void   )  const [inline, virtual]

Definition at line 62 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
virtual const char* FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::GetNameOfClass (  )  const [inline, virtual]

Run-time type information (and related methods).

Definition at line 65 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SetSpatialRegionOfInterest ( SpatialObjectType *  pROI  )  [inline, virtual]

Set/Get the ROI spatial object.

Definition at line 50 of file freSpatialRegionOfInterestImageFilter.txx.

Referenced by FREE::SpatialRegionOfInterestImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent().

template<class TInputImage, class TOutputImage>
SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SpatialObjectType * FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::GetSpatialRegionOfInterest (  )  [inline, virtual]

Definition at line 63 of file freSpatialRegionOfInterestImageFilter.txx.

template<class TInputImage, class TOutputImage>
virtual void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SetOutsideValue ( const OutputImagePixelType  _arg  )  [inline, virtual]

Definition at line 85 of file freSpatialRegionOfInterestImageFilter.h.

Referenced by FREE::SpatialRegionOfInterestImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent().

template<class TInputImage, class TOutputImage>
virtual OutputImagePixelType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::GetOutsideValue (  )  [inline, virtual]

Definition at line 86 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
virtual void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::SetCropByInput ( const bool  _arg  )  [inline, virtual]

Definition at line 88 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
virtual bool FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::GetCropByInput (  )  [inline, virtual]

Definition at line 89 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const [inline, protected]

Definition at line 113 of file freSpatialRegionOfInterestImageFilter.txx.

template<class TInputImage, class TOutputImage>
void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (  )  [inline, protected, virtual]

Definition at line 126 of file freSpatialRegionOfInterestImageFilter.txx.

template<class TInputImage, class TOutputImage>
void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( itk::DataObject *  output  )  [inline, protected, virtual]

Definition at line 147 of file freSpatialRegionOfInterestImageFilter.txx.

template<class TInputImage, class TOutputImage>
void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation (  )  [inline, protected, virtual]

SpatialRegionOfInterestImageFilter can produce an image which is a different size than its input image. As such, SpatialRegionOfInterestImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also:
ProcessObject::GenerateOutputInformaton()
SpatialRegionOfInterestImageFilter can produce an image which is a different size than its input image. As such, SpatialRegionOfInterestImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also:
ProcessObject::GenerateOutputInformaton()

Definition at line 171 of file freSpatialRegionOfInterestImageFilter.txx.

template<class TInputImage, class TOutputImage>
void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const RegionType &  outputRegionForThread,
int  threadId 
) [inline, protected]

SpatialRegionOfInterestImageFilter 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"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()
SpatialRegionOfInterestImageFilter 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"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Definition at line 249 of file freSpatialRegionOfInterestImageFilter.txx.

template<class TInputImage, class TOutputImage>
SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::RegionType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::GenerateLargestSpatialRegion ( const TInputImage *  pInput  )  [inline, protected]

Computes the largest possible region of the spatial object, by regarding the spacing of the input image.

Parameters:
[in] pInput Pointer to the input image to retriev the spacing and do point to index transformation.
Returns:
The largest region of interest of the spatial object.

Definition at line 72 of file freSpatialRegionOfInterestImageFilter.txx.

template<class TInputImage, class TOutputImage>
void FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::operator= ( const Self &   )  [private]

Member Data Documentation

template<class TInputImage, class TOutputImage>
const unsigned int FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]

ImageDimension enumeration

Definition at line 93 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
const unsigned int FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

Definition at line 95 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
SpatialObjectPointer FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::m_SpatialObject [private]

Definition at line 149 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
OutputImagePixelType FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::m_OutsideValue [private]

Definition at line 150 of file freSpatialRegionOfInterestImageFilter.h.

template<class TInputImage, class TOutputImage>
bool FREE::SpatialRegionOfInterestImageFilter< TInputImage, TOutputImage >::m_CropByInput [private]

Definition at line 151 of file freSpatialRegionOfInterestImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Sat Oct 13 18:17:29 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000