VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | 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

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

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkExtentTranslatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetWholeExtent (int, int, int, int, int, int)
 Set the Piece/NumPieces. More...
 
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 ()
 These are the main methods that should be called. More...
 
virtual int PieceToExtentByPoints ()
 
virtual int PieceToExtentThreadSafe (int piece, int numPieces, int ghostLevel, int *wholeExtent, int *resultExtent, int splitMode, int byPoints)
 
void SetSplitModeToBlock ()
 How should the streamer break up extents. More...
 
void SetSplitModeToXSlab ()
 
void SetSplitModeToYSlab ()
 
void SetSplitModeToZSlab ()
 
virtual int GetSplitMode ()
 
void 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. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkExtentTranslatorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExtentTranslatorSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerRequestKeyUPDATE_SPLIT_MODE ()
 Key used to request a particular split mode. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkExtentTranslator ()
 
 ~vtkExtentTranslator () override
 
int SplitExtent (int piece, int numPieces, int *extent, int splitMode)
 Returns 0 if no data exist for a piece. More...
 
int SplitExtentByPoints (int piece, int numPieces, int *extent, int splitMode)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static vtkInformationIntegerKeyDATA_SPLIT_MODE ()
 

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
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkInformationSplitModeRequestKey
 

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.

Definition at line 34 of file vtkExtentTranslator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkExtentTranslator.h.

Member Enumeration Documentation

◆ Modes

Enumerator
X_SLAB_MODE 
Y_SLAB_MODE 
Z_SLAB_MODE 
BLOCK_MODE 

Definition at line 97 of file vtkExtentTranslator.h.

Constructor & Destructor Documentation

◆ vtkExtentTranslator()

vtkExtentTranslator::vtkExtentTranslator ( )
protected

◆ ~vtkExtentTranslator()

vtkExtentTranslator::~vtkExtentTranslator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkExtentTranslator* vtkExtentTranslator::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkExtentTranslator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

static vtkExtentTranslator* vtkExtentTranslator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkExtentTranslator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkExtentTranslator* vtkExtentTranslator::NewInstance ( ) const

◆ PrintSelf()

void vtkExtentTranslator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetWholeExtent() [1/2]

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.

◆ SetWholeExtent() [2/2]

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

◆ GetWholeExtent() [1/3]

virtual int* vtkExtentTranslator::GetWholeExtent ( )
virtual

◆ GetWholeExtent() [2/3]

virtual void vtkExtentTranslator::GetWholeExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

◆ GetWholeExtent() [3/3]

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

◆ SetExtent() [1/2]

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

◆ SetExtent() [2/2]

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

◆ GetExtent() [1/3]

virtual int* vtkExtentTranslator::GetExtent ( )
virtual

◆ GetExtent() [2/3]

virtual void vtkExtentTranslator::GetExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

◆ GetExtent() [3/3]

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

◆ SetPiece()

virtual void vtkExtentTranslator::SetPiece ( int  )
virtual

◆ GetPiece()

virtual int vtkExtentTranslator::GetPiece ( )
virtual

◆ SetNumberOfPieces()

virtual void vtkExtentTranslator::SetNumberOfPieces ( int  )
virtual

◆ GetNumberOfPieces()

virtual int vtkExtentTranslator::GetNumberOfPieces ( )
virtual

◆ SetGhostLevel()

virtual void vtkExtentTranslator::SetGhostLevel ( int  )
virtual

◆ GetGhostLevel()

virtual int vtkExtentTranslator::GetGhostLevel ( )
virtual

◆ PieceToExtent()

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.

◆ PieceToExtentByPoints()

virtual int vtkExtentTranslator::PieceToExtentByPoints ( )
virtual

◆ PieceToExtentThreadSafe()

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

◆ SetSplitModeToBlock()

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

◆ SetSplitModeToXSlab()

void vtkExtentTranslator::SetSplitModeToXSlab ( )
inline

Definition at line 81 of file vtkExtentTranslator.h.

◆ SetSplitModeToYSlab()

void vtkExtentTranslator::SetSplitModeToYSlab ( )
inline

Definition at line 82 of file vtkExtentTranslator.h.

◆ SetSplitModeToZSlab()

void vtkExtentTranslator::SetSplitModeToZSlab ( )
inline

Definition at line 83 of file vtkExtentTranslator.h.

◆ GetSplitMode()

virtual int vtkExtentTranslator::GetSplitMode ( )
virtual

◆ SetSplitPath()

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.

◆ UPDATE_SPLIT_MODE()

static vtkInformationIntegerRequestKey* vtkExtentTranslator::UPDATE_SPLIT_MODE ( )
static

Key used to request a particular split mode.

This is used by vtkStreamingDemandDrivenPipeline.

◆ DATA_SPLIT_MODE()

static vtkInformationIntegerKey* vtkExtentTranslator::DATA_SPLIT_MODE ( )
staticprotected

◆ SplitExtent()

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.

◆ SplitExtentByPoints()

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

Friends And Related Function Documentation

◆ vtkInformationSplitModeRequestKey

friend class vtkInformationSplitModeRequestKey
friend

Definition at line 117 of file vtkExtentTranslator.h.

Member Data Documentation

◆ Piece

int vtkExtentTranslator::Piece
protected

Definition at line 129 of file vtkExtentTranslator.h.

◆ NumberOfPieces

int vtkExtentTranslator::NumberOfPieces
protected

Definition at line 130 of file vtkExtentTranslator.h.

◆ GhostLevel

int vtkExtentTranslator::GhostLevel
protected

Definition at line 131 of file vtkExtentTranslator.h.

◆ Extent

int vtkExtentTranslator::Extent[6]
protected

Definition at line 132 of file vtkExtentTranslator.h.

◆ WholeExtent

int vtkExtentTranslator::WholeExtent[6]
protected

Definition at line 133 of file vtkExtentTranslator.h.

◆ SplitMode

int vtkExtentTranslator::SplitMode
protected

Definition at line 134 of file vtkExtentTranslator.h.

◆ SplitPath

int* vtkExtentTranslator::SplitPath
protected

Definition at line 136 of file vtkExtentTranslator.h.

◆ SplitLen

int vtkExtentTranslator::SplitLen
protected

Definition at line 137 of file vtkExtentTranslator.h.


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