VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkExtentTranslator Class Reference

Generates a structured extent from unstructured. More...

#include <vtkExtentTranslator.h>

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

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
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 int * GetWholeExtent ()
 
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 int * GetExtent ()
 
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 ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkExtentTranslatorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkExtentTranslatorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Types

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

Protected Member Functions

 vtkExtentTranslator ()
 
 ~vtkExtentTranslator ()
 
int SplitExtent (int piece, int numPieces, int *extent, int splitMode)
 
int SplitExtentByPoints (int piece, int numPieces, int *extent, int splitMode)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int Piece
 
int NumberOfPieces
 
int GhostLevel
 
int Extent [6]
 
int WholeExtent [6]
 
int SplitMode
 
int * SplitPath
 
int SplitLen
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 33 of file vtkExtentTranslator.h.

Member Typedef Documentation

Definition at line 38 of file vtkExtentTranslator.h.

Member Enumeration Documentation

Enumerator
X_SLAB_MODE 
Y_SLAB_MODE 
Z_SLAB_MODE 
BLOCK_MODE 

Definition at line 121 of file vtkExtentTranslator.h.

Constructor & Destructor Documentation

vtkExtentTranslator::vtkExtentTranslator ( )
protected
vtkExtentTranslator::~vtkExtentTranslator ( )
protected

Member Function Documentation

static vtkExtentTranslator* vtkExtentTranslator::New ( )
static
virtual const char* vtkExtentTranslator::GetClassName ( )
virtual

Reimplemented from vtkObject.

Reimplemented in vtkTableExtentTranslator, and vtkOnePieceExtentTranslator.

static int vtkExtentTranslator::IsTypeOf ( const char *  type)
static
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, and vtkOnePieceExtentTranslator.

static vtkExtentTranslator* vtkExtentTranslator::SafeDownCast ( vtkObject o)
static
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, and vtkOnePieceExtentTranslator.

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.

virtual int vtkExtentTranslator::GetNumberOfPieces ( )
virtual

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.

virtual int vtkExtentTranslator::PieceToExtentByPoints ( )
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.

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.

void vtkExtentTranslator::SetSplitModeToBlock ( )
inline

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 77 of file vtkExtentTranslator.h.

void vtkExtentTranslator::SetSplitModeToXSlab ( )
inline

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 79 of file vtkExtentTranslator.h.

void vtkExtentTranslator::SetSplitModeToYSlab ( )
inline

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 81 of file vtkExtentTranslator.h.

void vtkExtentTranslator::SetSplitModeToZSlab ( )
inline

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 83 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

int vtkExtentTranslator::Piece
protected

Definition at line 108 of file vtkExtentTranslator.h.

int vtkExtentTranslator::NumberOfPieces
protected

Definition at line 109 of file vtkExtentTranslator.h.

int vtkExtentTranslator::GhostLevel
protected

Definition at line 110 of file vtkExtentTranslator.h.

int vtkExtentTranslator::Extent[6]
protected

Definition at line 111 of file vtkExtentTranslator.h.

int vtkExtentTranslator::WholeExtent[6]
protected

Definition at line 112 of file vtkExtentTranslator.h.

int vtkExtentTranslator::SplitMode
protected

Definition at line 113 of file vtkExtentTranslator.h.

int* vtkExtentTranslator::SplitPath
protected

Definition at line 115 of file vtkExtentTranslator.h.

int vtkExtentTranslator::SplitLen
protected

Definition at line 116 of file vtkExtentTranslator.h.


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