itk::simple::FlipImageFilter Class Reference

Flips an image across user specified axes. More...

#include <sitkFlipImageFilter.h>

Inheritance diagram for itk::simple::FlipImageFilter:

Collaboration diagram for itk::simple::FlipImageFilter:

Public Types
typedef NonLabelPixelIDTypeList	PixelIDTypeList
typedef FlipImageFilter	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< bool > &flipAxes, bool flipAboutOrigin)
Self &	FlipAboutOriginOff ()
Self &	FlipAboutOriginOn ()
	FlipImageFilter ()
bool	GetFlipAboutOrigin () const
std::vector< bool >	GetFlipAxes () const
std::string	GetName () const
Self &	SetFlipAboutOrigin (bool FlipAboutOrigin)
Self &	SetFlipAxes (const std::vector< bool > &FlipAxes)
std::string	ToString () const
virtual	~FlipImageFilter ()
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

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

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

Private Attributes
bool	m_FlipAboutOrigin
std::vector< bool >	m_FlipAxes
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

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::ProcessObject *	GetActiveProcess ()
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::EventObject &	GetITKEventObject (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

Flips an image across user specified axes.

FlipImageFilter flips an image across user specified axes. The flip axes are set via method SetFlipAxes( array ) where the input is a FixedArray<bool,ImageDimension>. The image is flipped across axes for which array[i] is true.

In terms of grid coordinates the image is flipped within the LargestPossibleRegion of the input image. As such, the LargestPossibleRegion of the output image is the same as the input.

In terms of geometric coordinates, the output origin is such that the image is flipped with respect to the coordinate axes.

See also

itk::simple::Flip for the procedural interface

itk::FlipImageFilter for the Doxygen on the original ITK class.

Definition at line 46 of file sitkFlipImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 103 of file sitkFlipImageFilter.h.

typedef NonLabelPixelIDTypeList itk::simple::FlipImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkFlipImageFilter.h.

typedef FlipImageFilter itk::simple::FlipImageFilter::Self

Definition at line 48 of file sitkFlipImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::FlipImageFilter::~FlipImageFilter ( )

virtual

Destructor

itk::simple::FlipImageFilter::FlipImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::FlipImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::FlipImageFilter::Execute	(	const Image &	image1,
		const std::vector< bool > &	flipAxes,
		bool	flipAboutOrigin
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::FlipImageFilter::ExecuteInternal ( const Image &  image1 )

private

Self& itk::simple::FlipImageFilter::FlipAboutOriginOff ( )

inline

Definition at line 79 of file sitkFlipImageFilter.h.

Self& itk::simple::FlipImageFilter::FlipAboutOriginOn ( )

inline

Set the value of FlipAboutOrigin to true or false respectfully.

Definition at line 78 of file sitkFlipImageFilter.h.

bool itk::simple::FlipImageFilter::GetFlipAboutOrigin ( ) const

inline

Controls how the output origin is computed. If FlipAboutOrigin is "On", the flip will occur about the origin of the axis, otherwise, the flip will occur about the center of the axis. Default is "On".

Definition at line 84 of file sitkFlipImageFilter.h.

std::vector<bool> itk::simple::FlipImageFilter::GetFlipAxes ( ) const

inline

Set/Get the axis to be flipped. The image is flipped along axes for which array[i] is true. Default is false.

Definition at line 70 of file sitkFlipImageFilter.h.

std::string itk::simple::FlipImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 86 of file sitkFlipImageFilter.h.

Self& itk::simple::FlipImageFilter::SetFlipAboutOrigin ( bool  FlipAboutOrigin )

inline

Controls how the output origin is computed. If FlipAboutOrigin is "On", the flip will occur about the origin of the axis, otherwise, the flip will occur about the center of the axis. Default is "On".

Definition at line 75 of file sitkFlipImageFilter.h.

Self& itk::simple::FlipImageFilter::SetFlipAxes ( const std::vector< bool > &  FlipAxes )

inline

Set/Get the axis to be flipped. The image is flipped along axes for which array[i] is true. Default is false.

Definition at line 65 of file sitkFlipImageFilter.h.

std::string itk::simple::FlipImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 107 of file sitkFlipImageFilter.h.

Member Data Documentation

bool itk::simple::FlipImageFilter::m_FlipAboutOrigin

private

Definition at line 115 of file sitkFlipImageFilter.h.

std::vector<bool> itk::simple::FlipImageFilter::m_FlipAxes

private

Definition at line 113 of file sitkFlipImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::FlipImageFilter::m_MemberFactory

private

Definition at line 109 of file sitkFlipImageFilter.h.

---

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

• sitkFlipImageFilter.h