vtkImageRectilinearWipe Class Reference

#include <vtkImageRectilinearWipe.h>

Inheritance diagram for vtkImageRectilinearWipe:

[legend]Collaboration diagram for vtkImageRectilinearWipe:

[legend]List of all members.

Detailed Description

make a rectilinear combination of two images.

vtkImageRectilinearWipe makes a rectilinear combination of two images. The two input images must correspond in size, scalar type and number of components. The resulting image has four possible configurations called: Quad - alternate input 0 and input 1 horizontally and vertically. Select this with SetWipeModeToQuad. The Position specifies the location of the quad intersection. Corner - 3 of one input and 1 of the other. Select the location of input 0 with with SetWipeModeToLowerLeft, SetWipeModeToLowerRight, SetWipeModeToUpperLeft and SetWipeModeToUpperRight. The Position selects the location of the corner. Horizontal - alternate input 0 and input 1 with a vertical split. Select this with SetWipeModeToHorizontal. Position[0] specifies the location of the vertical transition between input 0 and input 1. Vertical - alternate input 0 and input 1 with a horizontal split. Only the y The intersection point of the rectilinear points is controlled with the Point ivar.

Thanks:: This work was supported by PHS Research Grant No. 1 P41 RR13218-01 from the National Center for Research Resources.

See also:: vtkImageCheckerboard

Created by:

Lorensen, Bill

CVS contributions (if > 5%):

Lorensen, Bill (100%)

CVS logs (CVSweb):

.h (/Imaging/vtkImageRectilinearWipe.h)
.cxx (/Imaging/vtkImageRectilinearWipe.cxx)

Tests:: vtkImageRectilinearWipe (Tests)

Definition at line 72 of file vtkImageRectilinearWipe.h.

Public Types

typedef vtkImageTwoInputFilter Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual void SetPosition (int, int)

void SetPosition (int[2])

virtual int * GetPosition ()

virtual void GetPosition (int data[2])

virtual void SetWipe (int)

virtual int GetWipe ()

void SetWipeToQuad ()

void SetWipeToHorizontal ()

void SetWipeToVertical ()

void SetWipeToLowerLeft ()

void SetWipeToLowerRight ()

void SetWipeToUpperLeft ()

void SetWipeToUpperRight ()

Static Public Member Functions

vtkImageRectilinearWipe * New ()

int IsTypeOf (const char *type)

vtkImageRectilinearWipe * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkImageRectilinearWipe ()

~vtkImageRectilinearWipe ()

void ThreadedExecute (vtkImageData **inDatas, vtkImageData *outData, int extent[6], int id)

Protected Attributes

int Position [2]

int Wipe

Member Typedef Documentation

typedef vtkImageTwoInputFilter vtkImageRectilinearWipe::Superclass

Reimplemented from vtkImageTwoInputFilter.
Definition at line 76 of file vtkImageRectilinearWipe.h.

Constructor & Destructor Documentation

vtkImageRectilinearWipe::vtkImageRectilinearWipe ( ) [protected]

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

Definition at line 121 of file vtkImageRectilinearWipe.h.

Member Function Documentation

vtkImageRectilinearWipe* vtkImageRectilinearWipe::New ( ) [static]

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

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

Reimplemented from vtkImageTwoInputFilter.

int vtkImageRectilinearWipe::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImageTwoInputFilter.

virtual int vtkImageRectilinearWipe::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImageTwoInputFilter.

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

Reimplemented from vtkImageTwoInputFilter.

void vtkImageRectilinearWipe::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 vtkImageTwoInputFilter.

virtual void vtkImageRectilinearWipe::SetPosition ( int ,

int

) [virtual]

Set/Get the location of the image transition.

void vtkImageRectilinearWipe::SetPosition ( int [2] )

Set/Get the location of the image transition.

virtual int* vtkImageRectilinearWipe::GetPosition ( ) [virtual]

Set/Get the location of the image transition.

virtual void vtkImageRectilinearWipe::GetPosition ( int data[2] ) [virtual]

Set/Get the location of the image transition.

virtual void vtkImageRectilinearWipe::SetWipe ( int ) [virtual]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.

virtual int vtkImageRectilinearWipe::GetWipe ( ) [virtual]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.

void vtkImageRectilinearWipe::SetWipeToQuad ( ) [inline]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.
Definition at line 103 of file vtkImageRectilinearWipe.h.
References VTK_WIPE_QUAD.

void vtkImageRectilinearWipe::SetWipeToHorizontal ( ) [inline]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.
Definition at line 105 of file vtkImageRectilinearWipe.h.
References VTK_WIPE_HORIZONTAL.

void vtkImageRectilinearWipe::SetWipeToVertical ( ) [inline]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.
Definition at line 107 of file vtkImageRectilinearWipe.h.
References VTK_WIPE_VERTICAL.

void vtkImageRectilinearWipe::SetWipeToLowerLeft ( ) [inline]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.
Definition at line 109 of file vtkImageRectilinearWipe.h.
References VTK_WIPE_LOWER_LEFT.

void vtkImageRectilinearWipe::SetWipeToLowerRight ( ) [inline]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.
Definition at line 111 of file vtkImageRectilinearWipe.h.
References VTK_WIPE_LOWER_RIGHT.

void vtkImageRectilinearWipe::SetWipeToUpperLeft ( ) [inline]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.
Definition at line 113 of file vtkImageRectilinearWipe.h.
References VTK_WIPE_UPPER_LEFT.

void vtkImageRectilinearWipe::SetWipeToUpperRight ( ) [inline]

Specify the wipe mode. This mode determnis how input 0 and input 1 are combined to produce the output. Each mode uses one or both of the values stored in Position. SetWipeToQuad - alternate input 0 and input 1 horizontally and vertically. The Position specifies the location of the quad intersection. SetWipeToLowerLeft{LowerRight,UpperLeft.UpperRight} - 3 of one input and 1 of the other. Select the location of input 0 to the LowerLeft{LowerRight,UpperLeft,UpperRight}. Position selects the location of the corner. SetWipeToHorizontal - alternate input 0 and input 1 with a vertical split. Position[0] specifies the location of the vertical transition between input 0 and input 1. SetWipeToVertical - alternate input 0 and input 1 with a horizontal split. Position[1] specifies the location of the horizonal transition between input 0 and input 1.
Definition at line 115 of file vtkImageRectilinearWipe.h.
References VTK_WIPE_UPPER_RIGHT.

void vtkImageRectilinearWipe::ThreadedExecute ( vtkImageData ** inDatas,

vtkImageData * outData,

int extent[6],

int id

) [protected, virtual]

The execute method created by the subclass. This is kept public instead of protected since it is called from a non-member thread function.
Reimplemented from vtkImageMultipleInputFilter.

Member Data Documentation

int vtkImageRectilinearWipe::Position[2] [protected]

Definition at line 125 of file vtkImageRectilinearWipe.h.

int vtkImageRectilinearWipe::Wipe [protected]

Definition at line 126 of file vtkImageRectilinearWipe.h.

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

dox/Imaging/vtkImageRectilinearWipe.h


Public Types
typedef vtkImageTwoInputFilter	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetPosition (int, int)
void	SetPosition (int[2])
virtual int *	GetPosition ()
virtual void	GetPosition (int data[2])

virtual void	SetWipe (int)
virtual int	GetWipe ()
void	SetWipeToQuad ()
void	SetWipeToHorizontal ()
void	SetWipeToVertical ()
void	SetWipeToLowerLeft ()
void	SetWipeToLowerRight ()
void	SetWipeToUpperLeft ()
void	SetWipeToUpperRight ()
Static Public Member Functions
vtkImageRectilinearWipe *	New ()
int	IsTypeOf (const char *type)
vtkImageRectilinearWipe *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageRectilinearWipe ()
	~vtkImageRectilinearWipe ()
void	ThreadedExecute (vtkImageData *inDatas, vtkImageData outData, int extent[6], int id)
Protected Attributes
int	Position [2]
int	Wipe