ITK  4.4.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 | List of all members

#include <itkFlipImageFilter.h>

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

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.

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 Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TImage > Superclass
 
- Public Types inherited from itk::ImageSource< TImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput (void)
 
const OutputImageTypeGetOutput (void) const
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData ()
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetProgress (float _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float amount)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = TImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TImage, TImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TImage >
static const unsigned int OutputImageDimension
 

Protected Member Functions

 FlipImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
 ~FlipImageFilter ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation ()
 
 ~ImageToImageFilter ()
 
void PushBackInput (const DataObject *input)
 
void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Private Attributes

bool m_FlipAboutOrigin
 
FlipAxesArrayType m_FlipAxes
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 

Member Typedef Documentation

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

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.

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

Definition at line 74 of file itkFlipImageFilter.h.

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

Inherited types

Definition at line 73 of file itkFlipImageFilter.h.

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

Definition at line 75 of file itkFlipImageFilter.h.

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

Definition at line 76 of file itkFlipImageFilter.h.

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

Definition at line 60 of file itkFlipImageFilter.h.

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

Standard class typedefs.

Definition at line 58 of file itkFlipImageFilter.h.

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

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

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.

template<class TImage >
void itk::FlipImageFilter< TImage >::operator= ( const Self )
private
template<class TImage >
void itk::FlipImageFilter< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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: