Permutes the image axes according to a user specified order. More...

#include <itkPermuteAxesImageFilter.h>

Inheritance diagram for itk::PermuteAxesImageFilter< TImage >:

Collaboration diagram for itk::PermuteAxesImageFilter< TImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef FixedArray< unsigned int, itkGetStaticConstMacro(ImageDimension) >	PermuteOrderArrayType
typedef SmartPointer< Self >	Pointer
typedef PermuteAxesImageFilter	Self
typedef ImageToImageFilter < TImage, TImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual const PermuteOrderArrayType &	GetInverseOrder ()
virtual const char *	GetNameOfClass () const
virtual const PermuteOrderArrayType &	GetOrder ()
void	SetOrder (const PermuteOrderArrayType &order)
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = TImage::ImageDimension
Protected Member Functions
	PermuteAxesImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	~PermuteAxesImageFilter ()
Private Member Functions
void	operator= (const Self &)
	PermuteAxesImageFilter (const Self &)
Private Attributes
PermuteOrderArrayType	m_InverseOrder
PermuteOrderArrayType	m_Order

Detailed Description

template<class TImage>
class itk::PermuteAxesImageFilter< TImage >

Permutes the image axes according to a user specified order.

PermuateAxesImageFilter permutes the image axes according to a user specified order. The permutation order is set via method SetOrder( order ) where the input is an array of ImageDimension number of unsigned int. The elements of the array must be a rearrangment of the numbers from 0 to ImageDimension - 1.

The i-th axis of the output image corresponds with the order[i]-th axis of the input image.

The output meta image information (LargestPossibleRegion, spacing, origin) is computed by permuting the corresponding input meta information.

Wiki Examples:

All Examples

Switch the axes of an image

Definition at line 51 of file itkPermuteAxesImageFilter.h.

Member Typedef Documentation

template<class TImage >

typedef SmartPointer< const Self > itk::PermuteAxesImageFilter< TImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 59 of file itkPermuteAxesImageFilter.h.

template<class TImage >

typedef Superclass::InputImagePointer itk::PermuteAxesImageFilter< TImage >::InputImagePointer

Inherited types

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 72 of file itkPermuteAxesImageFilter.h.

template<class TImage >

typedef Superclass::OutputImagePointer itk::PermuteAxesImageFilter< TImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TImage >.

Definition at line 73 of file itkPermuteAxesImageFilter.h.

template<class TImage >

typedef Superclass::OutputImageRegionType itk::PermuteAxesImageFilter< TImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 74 of file itkPermuteAxesImageFilter.h.

template<class TImage >

typedef FixedArray< unsigned int, itkGetStaticConstMacro(ImageDimension) > itk::PermuteAxesImageFilter< TImage >::PermuteOrderArrayType

PermuteOrderArray type.

Definition at line 77 of file itkPermuteAxesImageFilter.h.

template<class TImage >

typedef SmartPointer< Self > itk::PermuteAxesImageFilter< TImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 58 of file itkPermuteAxesImageFilter.h.

template<class TImage >

typedef PermuteAxesImageFilter itk::PermuteAxesImageFilter< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 56 of file itkPermuteAxesImageFilter.h.

template<class TImage >

typedef ImageToImageFilter< TImage, TImage > itk::PermuteAxesImageFilter< TImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 57 of file itkPermuteAxesImageFilter.h.

Constructor & Destructor Documentation

template<class TImage >

itk::PermuteAxesImageFilter< TImage >::PermuteAxesImageFilter ( ) [protected]

template<class TImage >

itk::PermuteAxesImageFilter< TImage >::~PermuteAxesImageFilter ( ) [inline, protected]

Definition at line 107 of file itkPermuteAxesImageFilter.h.

template<class TImage >

itk::PermuteAxesImageFilter< TImage >::PermuteAxesImageFilter ( const Self & ) [private]

Member Function Documentation

template<class TImage >

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

template<class TImage >

virtual void itk::PermuteAxesImageFilter< TImage >::GenerateInputRequestedRegion ( ) [virtual]

PermuteAxesImageFilter needs different input requested region than the output requested region. As such, PermuteAxesImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also:: ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage >

virtual void itk::PermuteAxesImageFilter< TImage >::GenerateOutputInformation ( ) [virtual]

PermuteAxesImageFilter produces an image which is a different resolution and with a different pixel spacing than its input image. As such, PermuteAxesImageFilter 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.

template<class TImage >

virtual const PermuteOrderArrayType& itk::PermuteAxesImageFilter< TImage >::GetInverseOrder ( ) [virtual]

Get the inverse permutation order.

template<class TImage >

virtual const char* itk::PermuteAxesImageFilter< TImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage >

virtual const PermuteOrderArrayType& itk::PermuteAxesImageFilter< TImage >::GetOrder ( ) [virtual]

Get the permutation order.

template<class TImage >

static Pointer itk::PermuteAxesImageFilter< TImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImage >

void itk::PermuteAxesImageFilter< TImage >::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< TImage, TImage >.

template<class TImage >

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

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::ImageToImageFilter< TImage, TImage >.

template<class TImage >

void itk::PermuteAxesImageFilter< TImage >::SetOrder ( const PermuteOrderArrayType & order )

Set the permutation order. The elements of order must be a rearrangement of the numbers from 0 to ImageDimension - 1.

template<class TImage >

void itk::PermuteAxesImageFilter< TImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		`[protected]`

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