#include <itkExtractImageFilter.h>

Inheritance diagram for itk::ExtractImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::ExtractImageFilter< TInputImage, TOutputImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef enum itk::ExtractImageFilter::DirectionCollapseStrategyEnum	DIRECTIONCOLLAPSESTRATEGY
enum	DirectionCollapseStrategyEnum { DIRECTIONCOLLAPSETOUNKOWN = 0, DIRECTIONCOLLAPSETOIDENTITY = 1, DIRECTIONCOLLAPSETOSUBMATRIX = 2, DIRECTIONCOLLAPSETOGUESS = 3 }
typedef ImageToImageFilterDetail::ExtractImageFilterRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	ExtractImageFilterRegionCopierType
typedef TInputImage::IndexType	InputImageIndexType
typedef TInputImage::PixelType	InputImagePixelType
typedef TInputImage::RegionType	InputImageRegionType
typedef TInputImage::SizeType	InputImageSizeType
typedef TInputImage	InputImageType
typedef TOutputImage::IndexType	OutputImageIndexType
typedef TOutputImage::PixelType	OutputImagePixelType
typedef TOutputImage::RegionType	OutputImageRegionType
typedef TOutputImage::SizeType	OutputImageSizeType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ExtractImageFilter	Self
typedef InPlaceImageFilter < TInputImage, TOutputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
	typedef (Concept::Convertible< InputImagePixelType, OutputImagePixelType >) InputCovertibleToOutputCheck

void	SetExtractionRegion (InputImageRegionType extractRegion)
virtual InputImageRegionType	GetExtractionRegion () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	GenerateData ()
virtual void	GenerateOutputInformation ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

	ExtractImageFilter ()
	~ExtractImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
InputImageRegionType	m_ExtractionRegion
OutputImageRegionType	m_OutputImageRegion
Private Member Functions
	ExtractImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
DIRECTIONCOLLAPSESTRATEGY	m_DirectionCollapseStrategy
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
void	SetDirectionCollapseToStrategy (const DIRECTIONCOLLAPSESTRATEGY choosenStrategy)
DIRECTIONCOLLAPSESTRATEGY	GetDirectionCollapseToStrategy () const
void	SetDirectionCollapseToGuess ()
void	SetDirectionCollapseToIdentity ()
void	SetDirectionCollapseToSubmatrix ()

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::ExtractImageFilter< TInputImage, TOutputImage >

Decrease the image size by cropping the image to the selected region bounds.

ExtractImageFilter changes the image boundary of an image by removing pixels outside the target region. The target region must be specified.

ExtractImageFilter also collapses dimensions so that the input image may have more dimensions than the output image (i.e. 4-D input image to a 3-D output image). To specify what dimensions to collapse, the ExtractionRegion must be specified. For any dimension dim where ExtractionRegion.Size[dim] = 0, that dimension is collapsed. The index to collapse on is specified by ExtractionRegion.Index[dim]. For example, we have a image 4D = a 4x4x4x4 image, and we want to get a 3D image, 3D = a 4x4x4 image, specified as [x,y,z,2] from 4D (i.e. the 3rd "time" slice from 4D). The ExtractionRegion.Size = [4,4,4,0] and ExtractionRegion.Index = [0,0,0,2].

The number of dimension in ExtractionRegion.Size and Index must = InputImageDimension. The number of non-zero dimensions in ExtractionRegion.Size must = OutputImageDimension.

The output image produced by this filter will have the same origin as the input image, while the ImageRegion of the output image will start at the starting index value provided in the ExtractRegion parameter. If you are looking for a filter that will re-compute the origin of the output image, and provide an output image region whose index is set to zeros, then you may want to use the RegionOfInterestImageFilter. The output spacing is is simply the collapsed version of the input spacing.

Determining the direction of the collapsed output image from an larger dimensional input space is an ill defined problem in general. It is required that the application developer select the desired transformation strategy for collapsing direction cosigns. It is REQUIRED that a strategy be explicitly requested (i.e. there is no working default). Direction Collapsing Strategies: 1) DirectionCollapseToUnknown(); This is the default and the filter can not run when this is set. The reason is to explicitly force the application developer to define their desired behavior. 1) DirectionCollapseToIdentity(); Output has identity direction no matter what 2) DirectionCollapseToSubmatrix(); Output direction is the sub-matrix if it is positive definite, else throw an exception.

This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

Note:: This filter is derived from InPlaceImageFilter. When the input to this filter matched the output requirested region, like with streaming filter for input, then setting this filter to run in-place will result in no copying of the bulk pixel data.

See also:: CropImageFilter

Wiki Examples:

All Examples

Crop an image by specifying the region to keep

Definition at line 90 of file itkExtractImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef SmartPointer< const Self > itk::ExtractImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 98 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef enum itk::ExtractImageFilter::DirectionCollapseStrategyEnum itk::ExtractImageFilter< TInputImage, TOutputImage >::DIRECTIONCOLLAPSESTRATEGY

template<class TInputImage , class TOutputImage >

typedef ImageToImageFilterDetail::ExtractImageFilterRegionCopier< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) > itk::ExtractImageFilter< TInputImage, TOutputImage >::ExtractImageFilterRegionCopierType

Definition at line 215 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::IndexType itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageIndexType

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 120 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::PixelType itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 116 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::RegionType itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 112 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::SizeType itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 122 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageType

Image type information.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 104 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::IndexType itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 119 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::PixelType itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 115 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::RegionType itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output and input image region types.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 111 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::SizeType itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 121 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageType

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 108 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::ExtractImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 97 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef ExtractImageFilter itk::ExtractImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 95 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InPlaceImageFilter< TInputImage, TOutputImage > itk::ExtractImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

Definition at line 96 of file itkExtractImageFilter.h.

Member Enumeration Documentation

template<class TInputImage , class TOutputImage >

enum itk::ExtractImageFilter::DirectionCollapseStrategyEnum

Enumerator:

DIRECTIONCOLLAPSETOUNKOWN
DIRECTIONCOLLAPSETOIDENTITY
DIRECTIONCOLLAPSETOSUBMATRIX
DIRECTIONCOLLAPSETOGUESS

Definition at line 124 of file itkExtractImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::ExtractImageFilter< TInputImage, TOutputImage >::ExtractImageFilter ( ) [protected]

End concept checking

template<class TInputImage , class TOutputImage >

itk::ExtractImageFilter< TInputImage, TOutputImage >::~ExtractImageFilter ( ) [inline, protected]

End concept checking

Definition at line 235 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::ExtractImageFilter< TInputImage, TOutputImage >::ExtractImageFilter ( const Self & ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual void itk::ExtractImageFilter< TInputImage, TOutputImage >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)		`[protected, virtual]`

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

See also:: ImageToImageFilter::CallCopyRegion()

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::ExtractImageFilter< 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.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual]

Overridden to check if there is no work to be done, before calling superclass' implementation.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual void itk::ExtractImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( ) [protected, virtual]

ExtractImageFilter can produce an image which is a different resolution than its input image. As such, ExtractImageFilter 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()

Reimplemented from itk::ProcessObject.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

DIRECTIONCOLLAPSESTRATEGY itk::ExtractImageFilter< TInputImage, TOutputImage >::GetDirectionCollapseToStrategy ( ) const [inline]

NOTE: The SetDirectionCollapseToUknown is explicitly not defined. It is a state that a filter can be in only when it is first instantiate prior to being initialized. Get the currently set strategy for collapsing directions of physical space.

Definition at line 182 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

virtual InputImageRegionType itk::ExtractImageFilter< TInputImage, TOutputImage >::GetExtractionRegion ( ) const [virtual]

Set/Get the output image region. If any of the ExtractionRegion.Size = 0 for any particular dimension dim, we have to collapse dimension dim. This means the output image will have 'c' dimensions less than the input image, where c = number of ExtractionRegion.Size = 0.

template<class TInputImage , class TOutputImage >

virtual const char* itk::ExtractImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

static Pointer itk::ExtractImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::operator= ( const Self & ) [private]

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

End concept checking

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToGuess ( ) [inline]

See also:: SetDirectionCollapseToStrategy

Definition at line 188 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToIdentity ( ) [inline]

See also:: SetDirectionCollapseToStrategy

Definition at line 194 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToStrategy ( const DIRECTIONCOLLAPSESTRATEGY choosenStrategy ) [inline]

Set the strategy to be used to collapse pysical space dimensions.

itk::itkExtractImageFilter::DIRECTIONCOLLAPSETOIDENTITY Set the strategy so that all collapsed images have an identity direction. Use this strategy when you know that retention of the physical space orientation of the collapsed image is not important.

itk::itkExtractImageFilter::DIRECTIONCOLLAPSETOGUESS Set the strategy so that all collapsed images where output direction is the sub-matrix it it is positive definite, else return identity. This is backwards compatible with ITKv3, but is highly discouraged because the results are difficult to anticipate under differing data scenerios.

itk::itkExtractImageFilter::DIRECTIONCOLLAPSETOSUBMATRIX Set the strategy so that all collapsed images where output direction is the sub-matrix it it is positive definite, else throw an exception. Use this strategy when it is known that properly identified physical space sub-volumes can be reliably extracted from a higher dimensional space. For example when the applicaiton programmer knows that a 4D image is 3D+time, and that the 3D sub-space is properly defined.

Definition at line 156 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToSubmatrix ( ) [inline]

See also:: SetDirectionCollapseToStrategy

Definition at line 200 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::SetExtractionRegion ( InputImageRegionType extractRegion )

Set/Get the output image region. If any of the ExtractionRegion.Size = 0 for any particular dimension dim, we have to collapse dimension dim. This means the output image will have 'c' dimensions less than the input image, where c = number of ExtractionRegion.Size = 0.

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		`[protected]`

ExtractImageFilter 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()

template<class TInputImage , class TOutputImage >

itk::ExtractImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > )

Begin concept checking This class requires InputCovertibleToOutputCheck in the form of ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > )

Reimplemented in itk::CropImageFilter< TInputImage, TOutputImage >.