vtkImageFlip Class Reference

#include <vtkImageFlip.h>

Inheritance diagram for vtkImageFlip:

Inheritance graph
[legend]
Collaboration diagram for vtkImageFlip:

Collaboration graph
[legend]

List of all members.


Detailed Description

This flips an axis of an image. Right becomes left ...

vtkImageFlip will reflect the data along the filtered axis. This filter is actually a thin wrapper around vtkImageReslice.

Tests:
vtkImageFlip (Tests)

Definition at line 31 of file vtkImageFlip.h.


Public Types

typedef vtkImageReslice Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetFilteredAxis (int)
virtual int GetFilteredAxis ()
virtual void SetFlipAboutOrigin (int)
virtual int GetFlipAboutOrigin ()
virtual void FlipAboutOriginOn ()
virtual void FlipAboutOriginOff ()
void SetFilteredAxes (int axis)
int GetFilteredAxes ()
virtual void SetPreserveImageExtent (int)
virtual int GetPreserveImageExtent ()
virtual void PreserveImageExtentOn ()
virtual void PreserveImageExtentOff ()

Static Public Member Functions

static vtkImageFlipNew ()
static int IsTypeOf (const char *type)
static vtkImageFlipSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageFlip ()
 ~vtkImageFlip ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

int FilteredAxis
int FlipAboutOrigin
int PreserveImageExtent

Member Typedef Documentation

Reimplemented from vtkImageReslice.

Definition at line 36 of file vtkImageFlip.h.


Constructor & Destructor Documentation

vtkImageFlip::vtkImageFlip (  )  [protected]

vtkImageFlip::~vtkImageFlip (  )  [inline, protected]

Definition at line 83 of file vtkImageFlip.h.


Member Function Documentation

static vtkImageFlip* vtkImageFlip::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkImageReslice.

virtual const char* vtkImageFlip::GetClassName (  )  [virtual]

Reimplemented from vtkImageReslice.

static int vtkImageFlip::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageReslice.

virtual int vtkImageFlip::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageReslice.

static vtkImageFlip* vtkImageFlip::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkImageReslice.

void vtkImageFlip::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [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 vtkImageReslice.

virtual void vtkImageFlip::SetFilteredAxis ( int   )  [virtual]

Specify which axis will be flipped. This must be an integer between 0 (for x) and 2 (for z). Initial value is 0.

virtual int vtkImageFlip::GetFilteredAxis (  )  [virtual]

Specify which axis will be flipped. This must be an integer between 0 (for x) and 2 (for z). Initial value is 0.

virtual void vtkImageFlip::SetFlipAboutOrigin ( int   )  [virtual]

By default the image will be flipped about its center, and the Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system associated with the image and you want to use the flip to convert +ve values along one axis to -ve values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel values are the same whether or not this method is used. Also note that the Origin in this method name refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is associated with a vtkImageData.

virtual int vtkImageFlip::GetFlipAboutOrigin (  )  [virtual]

By default the image will be flipped about its center, and the Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system associated with the image and you want to use the flip to convert +ve values along one axis to -ve values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel values are the same whether or not this method is used. Also note that the Origin in this method name refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is associated with a vtkImageData.

virtual void vtkImageFlip::FlipAboutOriginOn (  )  [virtual]

By default the image will be flipped about its center, and the Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system associated with the image and you want to use the flip to convert +ve values along one axis to -ve values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel values are the same whether or not this method is used. Also note that the Origin in this method name refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is associated with a vtkImageData.

virtual void vtkImageFlip::FlipAboutOriginOff (  )  [virtual]

By default the image will be flipped about its center, and the Origin, Spacing and Extent of the output will be identical to the input. However, if you have a coordinate system associated with the image and you want to use the flip to convert +ve values along one axis to -ve values (and vice versa) then you actually want to flip the image about coordinate (0,0,0) instead of about the center of the image. This method will adjust the Origin of the output such that the flip occurs about (0,0,0). Note that this method only changes the Origin (and hence the coordinate system) the output data: the actual pixel values are the same whether or not this method is used. Also note that the Origin in this method name refers to (0,0,0) in the coordinate system associated with the image, it does not refer to the Origin ivar that is associated with a vtkImageData.

void vtkImageFlip::SetFilteredAxes ( int  axis  )  [inline]

Keep the mis-named Axes variations around for compatibility with old scripts. Axis is singular, not plural...

Definition at line 68 of file vtkImageFlip.h.

int vtkImageFlip::GetFilteredAxes (  )  [inline]

Keep the mis-named Axes variations around for compatibility with old scripts. Axis is singular, not plural...

Definition at line 69 of file vtkImageFlip.h.

virtual void vtkImageFlip::SetPreserveImageExtent ( int   )  [virtual]

PreserveImageExtentOff wasn't covered by test scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).

virtual int vtkImageFlip::GetPreserveImageExtent (  )  [virtual]

PreserveImageExtentOff wasn't covered by test scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).

virtual void vtkImageFlip::PreserveImageExtentOn (  )  [virtual]

PreserveImageExtentOff wasn't covered by test scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).

virtual void vtkImageFlip::PreserveImageExtentOff (  )  [virtual]

PreserveImageExtentOff wasn't covered by test scripts and its implementation was broken. It is deprecated now and it has no effect (i.e. the ImageExtent is always preserved).

virtual int vtkImageFlip::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageReslice.


Member Data Documentation

int vtkImageFlip::FilteredAxis [protected]

Definition at line 87 of file vtkImageFlip.h.

Definition at line 88 of file vtkImageFlip.h.

Definition at line 89 of file vtkImageFlip.h.


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

Generated on Wed Aug 24 11:40:55 2011 for VTK by  doxygen 1.5.6