SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::PermuteAxesImageFilter Class Reference

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

#include <sitkPermuteAxesImageFilter.h>

+ Inheritance diagram for itk::simple::PermuteAxesImageFilter:
+ Collaboration diagram for itk::simple::PermuteAxesImageFilter:

Public Types

typedef NonLabelPixelIDTypeList PixelIDTypeList
 
typedef PermuteAxesImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const std::vector< unsigned int > &order)
 
std::string GetName () const
 
std::vector< unsigned int > GetOrder () const
 
 PermuteAxesImageFilter ()
 
SelfSetOrder (const std::vector< unsigned int > &Order)
 
std::string ToString () const
 
virtual ~PermuteAxesImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 

Static Public Attributes

static const unsigned int DefaultOrder [3]
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_Order
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

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.

See also
itk::simple::PermuteAxes for the procedural interface
itk::PermuteAxesImageFilter for the Doxygen on the original ITK class.

Definition at line 46 of file sitkPermuteAxesImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::PermuteAxesImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 91 of file sitkPermuteAxesImageFilter.h.

Define the pixels types supported by this filter

Definition at line 58 of file sitkPermuteAxesImageFilter.h.

Definition at line 48 of file sitkPermuteAxesImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::PermuteAxesImageFilter::~PermuteAxesImageFilter ( )
virtual

Destructor

itk::simple::PermuteAxesImageFilter::PermuteAxesImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::PermuteAxesImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::PermuteAxesImageFilter::Execute ( const Image image1,
const std::vector< unsigned int > &  order 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::PermuteAxesImageFilter::ExecuteInternal ( const Image image1)
private
std::string itk::simple::PermuteAxesImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 74 of file sitkPermuteAxesImageFilter.h.

std::vector<unsigned int> itk::simple::PermuteAxesImageFilter::GetOrder ( ) const
inline

Get the permutation order.

Definition at line 72 of file sitkPermuteAxesImageFilter.h.

Self& itk::simple::PermuteAxesImageFilter::SetOrder ( const std::vector< unsigned int > &  Order)
inline

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

Definition at line 67 of file sitkPermuteAxesImageFilter.h.

std::string itk::simple::PermuteAxesImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 95 of file sitkPermuteAxesImageFilter.h.

Member Data Documentation

const unsigned int itk::simple::PermuteAxesImageFilter::DefaultOrder[3]
static

Custom public declarations

Definition at line 60 of file sitkPermuteAxesImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::PermuteAxesImageFilter::m_MemberFactory
private

Definition at line 97 of file sitkPermuteAxesImageFilter.h.

std::vector<unsigned int> itk::simple::PermuteAxesImageFilter::m_Order
private

Definition at line 101 of file sitkPermuteAxesImageFilter.h.


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