itk::FlipImageFilter< TImage > Class Template Reference
[Geometric Transformation Filters, Multithreaded Filters, Filters supporting Streaming]

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

#include <itkFlipImageFilter.h>

Inheritance diagram for itk::FlipImageFilter< TImage >:

[legend]Collaboration diagram for itk::FlipImageFilter< TImage >:

[legend]List of all members.

Public Types
typedef FlipImageFilter	Self
typedef ImageToImageFilter< TImage, TImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TImage::IndexType	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef FixedArray< bool, itkGetStaticConstMacro(ImageDimension)	FlipAxesArrayType )
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
virtual void	SetFlipAxes (FlipAxesArrayType _arg)
virtual FlipAxesArrayType	GetFlipAxes ()
virtual void	FlipAboutOriginOn ()
virtual void	FlipAboutOriginOff ()
virtual bool	GetFlipAboutOrigin ()
virtual void	SetFlipAboutOrigin (bool _arg)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	FlipImageFilter ()
	~FlipImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

template<class TImage>
class itk::FlipImageFilter< TImage >

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 ouput 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.

Definition at line 48 of file itkFlipImageFilter.h.

---

Member Typedef Documentation

template<class TImage> typedef SmartPointer<const Self> itk::FlipImageFilter< TImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 57 of file itkFlipImageFilter.h.

template<class TImage> typedef FixedArray<bool,itkGetStaticConstMacro(ImageDimension) itk::FlipImageFilter< TImage >::FlipAxesArrayType)

FlipAxesArray type Definition at line 79 of file itkFlipImageFilter.h. Referenced by itk::FlipImageFilter< TImage >::~FlipImageFilter().

template<class TImage> typedef TImage::IndexType itk::FlipImageFilter< TImage >::IndexType

Index related types Definition at line 75 of file itkFlipImageFilter.h.

template<class TImage> typedef IndexType::IndexValueType itk::FlipImageFilter< TImage >::IndexValueType

Definition at line 76 of file itkFlipImageFilter.h.

template<class TImage> typedef Superclass::InputImageConstPointer itk::FlipImageFilter< TImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 70 of file itkFlipImageFilter.h.

template<class TImage> typedef Superclass::InputImagePointer itk::FlipImageFilter< TImage >::InputImagePointer

Inherited types Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 69 of file itkFlipImageFilter.h.

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

Reimplemented from itk::ImageSource< TImage >. Definition at line 71 of file itkFlipImageFilter.h.

template<class TImage> typedef Superclass::OutputImageRegionType itk::FlipImageFilter< TImage >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 72 of file itkFlipImageFilter.h. Referenced by itk::FlipImageFilter< TImage >::~FlipImageFilter().

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 56 of file itkFlipImageFilter.h.

template<class TImage> typedef FlipImageFilter itk::FlipImageFilter< TImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 54 of file itkFlipImageFilter.h. Referenced by itk::FlipImageFilter< TImage >::~FlipImageFilter().

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 55 of file itkFlipImageFilter.h.

---

Constructor & Destructor Documentation

template<class TImage> itk::FlipImageFilter< TImage >::FlipImageFilter (   )  [protected]

template<class TImage> itk::FlipImageFilter< TImage >::~FlipImageFilter (   )  [inline, protected]

Definition at line 113 of file itkFlipImageFilter.h. References itk::FlipImageFilter< TImage >::FlipAxesArrayType, itk::FlipImageFilter< TImage >::OutputImageRegionType, and itk::FlipImageFilter< TImage >::Self.

---

Member Function Documentation

template<class TImage> virtual void itk::FlipImageFilter< TImage >::FlipAboutOriginOff (   )  [virtual]

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.

template<class TImage> virtual void itk::FlipImageFilter< TImage >::FlipAboutOriginOn (   )  [virtual]

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.

template<class TImage> virtual void itk::FlipImageFilter< TImage >::GenerateInputRequestedRegion (   )  [virtual]

FlipImageFilter needs different input requested region than the output requested region. As such, FlipImageFilter 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::FlipImageFilter< TImage >::GenerateOutputInformation (   )  [virtual]

FlipImageFilter produces an image with different origin and direction than the input image. As such, FlipImageFilter 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 bool itk::FlipImageFilter< TImage >::GetFlipAboutOrigin (   )  [virtual]

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.

template<class TImage> virtual FlipAxesArrayType itk::FlipImageFilter< TImage >::GetFlipAxes (   )  [virtual]

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

template<class TImage> virtual const char* itk::FlipImageFilter< TImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage> itk::FlipImageFilter< TImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TImage::ImageDimension  )

ImageDimension enumeration

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

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TImage> void itk::FlipImageFilter< 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> virtual void itk::FlipImageFilter< TImage >::SetFlipAboutOrigin (  bool  _arg  )  [virtual]

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.

template<class TImage> virtual void itk::FlipImageFilter< TImage >::SetFlipAxes (  FlipAxesArrayType  _arg  )  [virtual]

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

template<class TImage> void itk::FlipImageFilter< TImage >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

FlipImageFilter 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:

• itkFlipImageFilter.h

---