VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
vtkExtentTranslator Class Reference

Generates a structured extent from unstructured. More...

#include <vtkExtentTranslator.h>

Inheritance diagram for vtkExtentTranslator:
Inheritance graph
[legend]
Collaboration diagram for vtkExtentTranslator:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkExtentTranslatorNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void SetSplitPath (int len, int *splitpath)
virtual void SetWholeExtent (int, int, int, int, int, int)
virtual void SetWholeExtent (int[6])
virtual intGetWholeExtent ()
virtual void GetWholeExtent (int &, int &, int &, int &, int &, int &)
virtual void GetWholeExtent (int[6])
virtual void SetExtent (int, int, int, int, int, int)
virtual void SetExtent (int[6])
virtual intGetExtent ()
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
virtual void GetExtent (int[6])
virtual void SetPiece (int)
virtual int GetPiece ()
virtual void SetNumberOfPieces (int)
virtual int GetNumberOfPieces ()
virtual void SetGhostLevel (int)
virtual int GetGhostLevel ()
virtual int PieceToExtent ()
virtual int PieceToExtentByPoints ()
virtual int PieceToExtentThreadSafe (int piece, int numPieces, int ghostLevel, int *wholeExtent, int *resultExtent, int splitMode, int byPoints)
void SetSplitModeToBlock ()
void SetSplitModeToXSlab ()
void SetSplitModeToYSlab ()
void SetSplitModeToZSlab ()
virtual int GetSplitMode ()

Static Public Member Functions

static vtkExtentTranslatorNew ()
static int IsTypeOf (const char *type)
static vtkExtentTranslatorSafeDownCast (vtkObjectBase *o)

Protected Types

enum  Modes { X_SLAB_MODE = 0, Y_SLAB_MODE = 1, Z_SLAB_MODE = 2, BLOCK_MODE = 3 }

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkExtentTranslator ()
 ~vtkExtentTranslator ()
int SplitExtent (int piece, int numPieces, int *extent, int splitMode)
int SplitExtentByPoints (int piece, int numPieces, int *extent, int splitMode)

Protected Attributes

int Piece
int NumberOfPieces
int GhostLevel
int Extent [6]
int WholeExtent [6]
int SplitMode
intSplitPath
int SplitLen

Detailed Description

Generates a structured extent from unstructured.

vtkExtentTranslator generates a structured extent from an unstructured extent. It uses a recursive scheme that splits the largest axis. A hard coded extent can be used for a starting point.

Warning:
This object is still under development.

Definition at line 34 of file vtkExtentTranslator.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkTableExtentTranslator, vtkOnePieceExtentTranslator, and vtkImageDataLIC2DExtentTranslator.

Definition at line 39 of file vtkExtentTranslator.h.


Member Enumeration Documentation

enum vtkExtentTranslator::Modes [protected]
Enumerator:
X_SLAB_MODE 
Y_SLAB_MODE 
Z_SLAB_MODE 
BLOCK_MODE 

Definition at line 122 of file vtkExtentTranslator.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkObject.

Reimplemented in vtkTableExtentTranslator, vtkOnePieceExtentTranslator, and vtkImageDataLIC2DExtentTranslator.

static int vtkExtentTranslator::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 vtkObject.

Reimplemented in vtkTableExtentTranslator, vtkOnePieceExtentTranslator, and vtkImageDataLIC2DExtentTranslator.

virtual int vtkExtentTranslator::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 vtkObject.

Reimplemented in vtkTableExtentTranslator, vtkOnePieceExtentTranslator, and vtkImageDataLIC2DExtentTranslator.

virtual vtkObjectBase* vtkExtentTranslator::NewInstanceInternal ( ) const [protected, virtual]
void vtkExtentTranslator::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 vtkObject.

Reimplemented in vtkTableExtentTranslator, vtkOnePieceExtentTranslator, and vtkImageDataLIC2DExtentTranslator.

virtual void vtkExtentTranslator::SetWholeExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::SetWholeExtent ( int  [6]) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual int* vtkExtentTranslator::GetWholeExtent ( ) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::GetWholeExtent ( int ,
int ,
int ,
int ,
int ,
int  
) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::GetWholeExtent ( int  [6]) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::SetExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::SetExtent ( int  [6]) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual int* vtkExtentTranslator::GetExtent ( ) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::GetExtent ( int ,
int ,
int ,
int ,
int ,
int  
) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::GetExtent ( int  [6]) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::SetPiece ( int  ) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual int vtkExtentTranslator::GetPiece ( ) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::SetNumberOfPieces ( int  ) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

Reimplemented in vtkTableExtentTranslator.

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual void vtkExtentTranslator::SetGhostLevel ( int  ) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual int vtkExtentTranslator::GetGhostLevel ( ) [virtual]

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

virtual int vtkExtentTranslator::PieceToExtent ( ) [virtual]

These are the main methods that should be called. These methods are responsible for converting a piece to an extent. The signatures without arguments are only thread safe when each thread accesses a different instance. The signatures with arguments are fully thread safe.

Reimplemented in vtkTableExtentTranslator.

These are the main methods that should be called. These methods are responsible for converting a piece to an extent. The signatures without arguments are only thread safe when each thread accesses a different instance. The signatures with arguments are fully thread safe.

Reimplemented in vtkTableExtentTranslator.

virtual int vtkExtentTranslator::PieceToExtentThreadSafe ( int  piece,
int  numPieces,
int  ghostLevel,
int wholeExtent,
int resultExtent,
int  splitMode,
int  byPoints 
) [virtual]

These are the main methods that should be called. These methods are responsible for converting a piece to an extent. The signatures without arguments are only thread safe when each thread accesses a different instance. The signatures with arguments are fully thread safe.

Reimplemented in vtkTableExtentTranslator, and vtkImageDataLIC2DExtentTranslator.

How should the streamer break up extents. Block mode tries to break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the Z axis. If it gets to one slice, then it starts breaking up other axes.

Definition at line 78 of file vtkExtentTranslator.h.

How should the streamer break up extents. Block mode tries to break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the Z axis. If it gets to one slice, then it starts breaking up other axes.

Definition at line 80 of file vtkExtentTranslator.h.

How should the streamer break up extents. Block mode tries to break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the Z axis. If it gets to one slice, then it starts breaking up other axes.

Definition at line 82 of file vtkExtentTranslator.h.

How should the streamer break up extents. Block mode tries to break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the Z axis. If it gets to one slice, then it starts breaking up other axes.

Definition at line 84 of file vtkExtentTranslator.h.

virtual int vtkExtentTranslator::GetSplitMode ( ) [virtual]

How should the streamer break up extents. Block mode tries to break an extent up into cube blocks. It always chooses the largest axis to split. Slab mode first breaks up the Z axis. If it gets to one slice, then it starts breaking up other axes.

void vtkExtentTranslator::SetSplitPath ( int  len,
int splitpath 
)

By default the translator creates N structured subextents by repeatedly splitting the largest current dimension until there are N pieces. If you do not want it always split the largest dimension, for instance when the shortest dimension is the slowest changing and thus least coherent in memory, use this to tell the translator which dimensions to split.

int vtkExtentTranslator::SplitExtent ( int  piece,
int  numPieces,
int extent,
int  splitMode 
) [protected]

Returns 0 if no data exist for a piece. The whole extent Should be passed in as the extent. It is modified to return the result.

int vtkExtentTranslator::SplitExtentByPoints ( int  piece,
int  numPieces,
int extent,
int  splitMode 
) [protected]

Returns 0 if no data exist for a piece. The whole extent Should be passed in as the extent. It is modified to return the result.


Member Data Documentation

Definition at line 109 of file vtkExtentTranslator.h.

Definition at line 110 of file vtkExtentTranslator.h.

Definition at line 111 of file vtkExtentTranslator.h.

Definition at line 112 of file vtkExtentTranslator.h.

Definition at line 113 of file vtkExtentTranslator.h.

Definition at line 114 of file vtkExtentTranslator.h.

Definition at line 116 of file vtkExtentTranslator.h.

Definition at line 117 of file vtkExtentTranslator.h.


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