itk::ExtractImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkExtractImageFilter.h>

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

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

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.

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 Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OutputImageType	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef InPlaceImageFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef ImageToImageFilter	Self
typedef ImageSource< TOutputImage >	Superclass
Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

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
Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const
virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace () const
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual double	GetCoordinateTolerance ()
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance ()
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ExtractImageFilter ()
void	GenerateData ()
virtual void	GenerateOutputInformation ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	~ExtractImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	GenerateInputRequestedRegion ()
virtual void	VerifyInputInformation ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
	ImageToImageFilter ()
	~ImageToImageFilter ()
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
void	PrintSelf (std::ostream &os, Indent indent) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName () const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

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

Additional Inherited Members
Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

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

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

Definition at line 120 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 116 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 112 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 122 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Image type information.

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.

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.

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.

Definition at line 111 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 121 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 108 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 97 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Standard class typedefs.

Definition at line 95 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

inlineprotected

Definition at line 236 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  )

protectedvirtual

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

protectedvirtual

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

protectedvirtual

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.

template<class TInputImage , class TOutputImage >

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

private

template<class TInputImage , class TOutputImage >

void itk::ExtractImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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 application 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 > )

Member Data Documentation

template<class TInputImage , class TOutputImage >

const unsigned int itk::ExtractImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

static

ImageDimension enumeration

Definition at line 208 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

DIRECTIONCOLLAPSESTRATEGY itk::ExtractImageFilter< TInputImage, TOutputImage >::m_DirectionCollapseStrategy

private

Definition at line 287 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

InputImageRegionType itk::ExtractImageFilter< TInputImage, TOutputImage >::m_ExtractionRegion

protected

Definition at line 279 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

OutputImageRegionType itk::ExtractImageFilter< TInputImage, TOutputImage >::m_OutputImageRegion

protected

Definition at line 281 of file itkExtractImageFilter.h.

template<class TInputImage , class TOutputImage >

const unsigned int itk::ExtractImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

ImageDimension enumeration

Definition at line 210 of file itkExtractImageFilter.h.

---

The documentation for this class was generated from the following file:

• itkExtractImageFilter.h