ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes

#include <itkFlipImageFilter.h>

+ Inheritance diagram for itk::FlipImageFilter< TImage >:
+ Collaboration diagram for itk::FlipImageFilter< TImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef FixedArray< bool,
itkGetStaticConstMacro(ImageDimension) > 
FlipAxesArrayType
typedef TImage::IndexType IndexType
typedef IndexType::IndexValueType IndexValueType
typedef
Superclass::InputImageConstPointer 
InputImageConstPointer
typedef
Superclass::InputImagePointer 
InputImagePointer
typedef
Superclass::OutputImagePointer 
OutputImagePointer
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
typedef SmartPointer< SelfPointer
typedef FlipImageFilter Self
typedef ImageToImageFilter
< TImage, TImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
virtual const char * GetNameOfClass () const
virtual void SetFlipAxes (FlipAxesArrayType _arg)
virtual FlipAxesArrayType GetFlipAxes () const
virtual void FlipAboutOriginOn ()
virtual void FlipAboutOriginOff ()
virtual bool GetFlipAboutOrigin () const
virtual void SetFlipAboutOrigin (bool _arg)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TImage::ImageDimension

Protected Member Functions

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

Private Member Functions

 FlipImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

bool m_FlipAboutOrigin
FlipAxesArrayType m_FlipAxes

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.

Wiki Examples:

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

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

FlipAxesArray type

Definition at line 83 of file itkFlipImageFilter.h.

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

Index related types

Definition at line 79 of file itkFlipImageFilter.h.

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

Definition at line 80 of file itkFlipImageFilter.h.

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

Definition at line 74 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 73 of file itkFlipImageFilter.h.

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

Reimplemented from itk::ImageSource< TImage >.

Definition at line 75 of file itkFlipImageFilter.h.

Superclass typedefs.

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

Definition at line 76 of file itkFlipImageFilter.h.

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

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

Definition at line 60 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 58 of file itkFlipImageFilter.h.

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

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

Definition at line 59 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 117 of file itkFlipImageFilter.h.

template<class TImage >
itk::FlipImageFilter< TImage >::FlipImageFilter ( const Self ) [private]

Member Function Documentation

template<class TImage >
virtual::itk::LightObject::Pointer itk::FlipImageFilter< 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::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 ( ) const [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 ( ) const [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 >
static Pointer itk::FlipImageFilter< TImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImage >
void itk::FlipImageFilter< 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::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,
ThreadIdType  threadId 
) [protected]

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()

Member Data Documentation

template<class TImage >
const unsigned int itk::FlipImageFilter< TImage >::ImageDimension = TImage::ImageDimension [static]

ImageDimension enumeration

Definition at line 70 of file itkFlipImageFilter.h.

template<class TImage >
bool itk::FlipImageFilter< TImage >::m_FlipAboutOrigin [private]

Definition at line 138 of file itkFlipImageFilter.h.

template<class TImage >
FlipAxesArrayType itk::FlipImageFilter< TImage >::m_FlipAxes [private]

Definition at line 137 of file itkFlipImageFilter.h.


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