Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::PermuteAxesImageFilter< TImage > Class Template Reference
[Geometric Transformation FiltersMultithreaded FiltersFilters supporting Streaming]

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

#include <itkPermuteAxesImageFilter.h>

Inheritance diagram for itk::PermuteAxesImageFilter< TImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::PermuteAxesImageFilter< TImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef PermuteAxesImageFilter Self
typedef ImageToImageFilter<
TImage, TImage > 
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef Superclass::InputImagePointer InputImagePointer
typedef Superclass::OutputImagePointer OutputImagePointer
typedef Superclass::OutputImageRegionType OutputImageRegionType
typedef FixedArray< unsigned
int, itkGetStaticConstMacro(ImageDimension) 
PermuteOrderArrayType )

Public Member Functions

virtual const char * GetClassName () const
 itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
void SetOrder (const PermuteOrderArrayType &order)
virtual const PermuteOrderArrayTypeGetOrder ()
virtual const PermuteOrderArrayTypeGetInverseOrder ()
virtual void GenerateOutputInformation ()
virtual void GenerateInputRequestedRegion ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

 PermuteAxesImageFilter ()
 ~PermuteAxesImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

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.

Definition at line 46 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 55 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 68 of file itkPermuteAxesImageFilter.h.

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

Reimplemented from itk::ImageSource< TImage >.

Definition at line 69 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 70 of file itkPermuteAxesImageFilter.h.

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

PermuteOrderArray type. Definition at line 73 of file itkPermuteAxesImageFilter.h.

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

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

Definition at line 54 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 52 of file itkPermuteAxesImageFilter.h.

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

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

Definition at line 53 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 104 of file itkPermuteAxesImageFilter.h.


Member Function Documentation

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 char* itk::PermuteAxesImageFilter< TImage >::GetClassName  )  const [virtual]
 

Run-time type information (and related methods).

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

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

Get the inverse permutation order.

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

Get the permutation order.

template<class TImage>
itk::PermuteAxesImageFilter< TImage >::itkStaticConstMacro ImageDimension  ,
unsigned  int,
TImage::ImageDimension 
 

ImageDimension enumeration

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

Method for creation through the object factory.

Reimplemented from itk::Object.

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,
int  threadId
[protected, virtual]
 

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"

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

Reimplemented from itk::ImageSource< TImage >.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 02:49:47 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000