VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkStructuredData Class Reference

Singleton class for topologically regular data. More...

#include <vtkStructuredData.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkStructuredDataNewInstance () const
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(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 &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkStructuredDataSafeDownCast (vtkObjectBase *o)
 
static int GetNumberOfNodes (int ext[6], int dataDescription=VTK_EMPTY)
 
static int GetNumberOfCells (int ext[6], int dataDescription=VTK_EMPTY)
 
static void GetPointCells (vtkIdType ptId, vtkIdList *cellIds, int dim[3])
 
static int SetDimensions (int inDim[3], int dim[3])
 
static int SetExtent (int inExt[6], int ext[6])
 
static int GetDataDescription (int dims[3])
 
static int GetDataDescriptionFromExtent (int ext[6])
 
static int GetDataDimension (int dataDescription)
 
static int GetDataDimension (int ext[6])
 
static void GetCellExtentFromNodeExtent (int nodeExtent[6], int cellExtent[6], int dataDescription=VTK_EMPTY)
 
static void GetDimensionsFromExtent (int ext[6], int dims[3], int dataDescription=VTK_EMPTY)
 
static void GetCellDimensionsFromExtent (int ext[6], int celldims[3], int dataDescription=VTK_EMPTY)
 
static void GetCellDimensionsFromNodeDimensions (int nodeDims[3], int cellDims[3])
 
static void GetLocalStructuredCoordinates (int ijk[3], int ext[6], int lijk[3], int dataDescription=VTK_EMPTY)
 
static void GetGlobalStructuredCoordinates (int lijk[3], int ext[6], int ijk[3], int dataDescription=VTK_EMPTY)
 
static void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds, int dataDescription, int dim[3])
 
static void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int dim[3])
 
static vtkIdType ComputePointIdForExtent (int extent[6], int ijk[3], int dataDescription=VTK_EMPTY)
 
static vtkIdType ComputeCellIdForExtent (int extent[6], int ijk[3], int dataDescription=VTK_EMPTY)
 
static vtkIdType ComputePointId (int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
 
static vtkIdType ComputeCellId (int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
 
static void ComputeCellStructuredCoordsForExtent (const vtkIdType cellIdx, int ext[6], int ijk[3], int dataDescription=VTK_EMPTY)
 
static void ComputeCellStructuredCoords (const vtkIdType cellId, int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
 
static void ComputePointStructuredCoordsForExtent (const vtkIdType ptId, int ext[6], int ijk[3], int dataDescription=VTK_EMPTY)
 
static void ComputePointStructuredCoords (const vtkIdType ptId, int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *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 Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkStructuredData ()
 
 ~vtkStructuredData ()
 
- 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 &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static vtkIdType GetLinearIndex (const int i, const int j, const int k, const int N1, const int N2)
 
static void GetStructuredCoordinates (const vtkIdType idx, const int N1, const int N2, int &i, int &j, int &k)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Singleton class for topologically regular data.

vtkStructuredData is a singleton class that provides an interface for topologically regular data. Regular data is data that can be accessed in rectangular fashion using an i-j-k index. A finite difference grid, a volume, or a pixmap are all considered regular.

See Also
vtkStructuredGrid vtkUniformGrid vtkRectilinearGrid vtkRectilinearGrid
Tests:
vtkStructuredData (Tests)

Definition at line 50 of file vtkStructuredData.h.

Member Typedef Documentation

Definition at line 53 of file vtkStructuredData.h.

Constructor & Destructor Documentation

vtkStructuredData::vtkStructuredData ( )
inlineprotected

Definition at line 279 of file vtkStructuredData.h.

vtkStructuredData::~vtkStructuredData ( )
inlineprotected

Definition at line 280 of file vtkStructuredData.h.

Member Function Documentation

static int vtkStructuredData::IsTypeOf ( const char *  type)
static
virtual int vtkStructuredData::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.

static vtkStructuredData* vtkStructuredData::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkStructuredData::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkStructuredData* vtkStructuredData::NewInstance ( ) const
static int vtkStructuredData::SetDimensions ( int  inDim[3],
int  dim[3] 
)
static

Specify the dimensions of a regular, rectangular dataset. The input is the new dimensions (inDim) and the current dimensions (dim). The function returns the dimension of the dataset (0-3D). If the dimensions are improperly specified a -1 is returned. If the dimensions are unchanged, a value of 100 is returned.

static int vtkStructuredData::SetExtent ( int  inExt[6],
int  ext[6] 
)
static

Specify the dimensions of a regular, rectangular dataset. The input is the new dimensions (inDim) and the current dimensions (dim). The function returns the dimension of the dataset (0-3D). If the dimensions are improperly specified a -1 is returned. If the dimensions are unchanged, a value of 100 is returned.

static int vtkStructuredData::GetDataDescription ( int  dims[3])
static

Returns the data description given the dimensions (eg. VTK_SINGLE_POINT, VTK_X_LINE, VTK_XY_PLANE etc.)

static int vtkStructuredData::GetDataDescriptionFromExtent ( int  ext[6])
static

Returns the data description given the dimensions (eg. VTK_SINGLE_POINT, VTK_X_LINE, VTK_XY_PLANE etc.)

static int vtkStructuredData::GetDataDimension ( int  dataDescription)
static

Return the topological dimension of the data (e.g., 0, 1, 2, or 3D).

static int vtkStructuredData::GetDataDimension ( int  ext[6])
static

Return the topological dimension of the data (e.g., 0, 1, 2, or 3D).

static int vtkStructuredData::GetNumberOfNodes ( int  ext[6],
int  dataDescription = VTK_EMPTY 
)
static

Given the grid extent, this method returns the total number of nodes within the extent. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static int vtkStructuredData::GetNumberOfCells ( int  ext[6],
int  dataDescription = VTK_EMPTY 
)
static

Given the grid extent, this method returns the total number of cells within the extent. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static void vtkStructuredData::GetCellExtentFromNodeExtent ( int  nodeExtent[6],
int  cellExtent[6],
int  dataDescription = VTK_EMPTY 
)
static

Given the node extent of a grid, this method computes the corresponding cell extent for the grid. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static void vtkStructuredData::GetDimensionsFromExtent ( int  ext[6],
int  dims[3],
int  dataDescription = VTK_EMPTY 
)
static

Computes the structured grid dimensions based on the given extent.

static void vtkStructuredData::GetCellDimensionsFromExtent ( int  ext[6],
int  celldims[3],
int  dataDescription = VTK_EMPTY 
)
static

Returns the cell dimensions, i.e., the number of cells along the i,j,k for the grid with the given grid extent. Note, the grid extent is the number of points.

static void vtkStructuredData::GetCellDimensionsFromNodeDimensions ( int  nodeDims[3],
int  cellDims[3] 
)
static

Given the node dimensions of the grid, in node dims, this method returns the corresponding cell dimensions for the given grid.

static void vtkStructuredData::GetLocalStructuredCoordinates ( int  ijk[3],
int  ext[6],
int  lijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given the global structured coordinates for a point or cell, ijk, w.r.t. as well as, the global sub-grid cell or node extent, this method computes the corresponding local structured coordinates, lijk, starting from 0. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static void vtkStructuredData::GetGlobalStructuredCoordinates ( int  lijk[3],
int  ext[6],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given local structured coordinates, and the corresponding global sub-grid extent, this method computes the global ijk coordinates. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static void vtkStructuredData::GetCellPoints ( vtkIdType  cellId,
vtkIdList ptIds,
int  dataDescription,
int  dim[3] 
)
static

Get the points defining a cell. (See vtkDataSet for more info.)

static void vtkStructuredData::GetPointCells ( vtkIdType  ptId,
vtkIdList cellIds,
int  dim[3] 
)
static

Get the cells using a point. (See vtkDataSet for more info.)

static void vtkStructuredData::GetCellNeighbors ( vtkIdType  cellId,
vtkIdList ptIds,
vtkIdList cellIds,
int  dim[3] 
)
static

Get the cells using the points ptIds, exclusive of the cell cellId. (See vtkDataSet for more info.)

static vtkIdType vtkStructuredData::ComputePointIdForExtent ( int  extent[6],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given a location in structured coordinates (i-j-k), and the extent of the structured dataset, return the point id. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static vtkIdType vtkStructuredData::ComputeCellIdForExtent ( int  extent[6],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given a location in structured coordinates (i-j-k), and the extent of the structured dataset, return the point id.

static vtkIdType vtkStructuredData::ComputePointId ( int  dim[3],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the point id. This method does not adjust for the beginning of the extent. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static vtkIdType vtkStructuredData::ComputeCellId ( int  dim[3],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the cell id. This method does not adjust for the beginning of the extent. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static void vtkStructuredData::ComputeCellStructuredCoordsForExtent ( const vtkIdType  cellIdx,
int  ext[6],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given the global grid extent and the linear index of a cell within the grid extent, this method computes the corresponding structured coordinates of the given cell. This method adjusts for the beginning of the extent. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static void vtkStructuredData::ComputeCellStructuredCoords ( const vtkIdType  cellId,
int  dim[3],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given a cellId and grid dimensions 'dim', get the structured coordinates (i-j-k). This method does not adjust for the beginning of the extent. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static void vtkStructuredData::ComputePointStructuredCoordsForExtent ( const vtkIdType  ptId,
int  ext[6],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given a pointId and the grid extent ext, get the structured coordinates (i-j-k). This method adjusts for the beginning of the extent. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static void vtkStructuredData::ComputePointStructuredCoords ( const vtkIdType  ptId,
int  dim[3],
int  ijk[3],
int  dataDescription = VTK_EMPTY 
)
static

Given a pointId and grid dimensions 'dim', get the structured coordinates (i-j-k). This method does not adjust for the beginning of the extent. The method accepts as an optional parameter the data description of the grid. If a data description is not provided, it will be computed internally. If the method is used within a tight loop it is advised to pre-acquire and pass the data description to the method to avoid any latency associated with computing the data description internally multiple times.

static vtkIdType vtkStructuredData::GetLinearIndex ( const int  i,
const int  j,
const int  k,
const int  N1,
const int  N2 
)
inlinestaticprotected

Computes the linear index for the given i-j-k structured of a grid with of N1 and N2 dimensions along its principal directions. For example, the principal directions of a 3-D grid are Ni and Nj and likewise for a 2-D grid along the XY plane. For a grid in the XZ plane however, the principal directions are Ni and Nk.

Definition at line 288 of file vtkStructuredData.h.

static void vtkStructuredData::GetStructuredCoordinates ( const vtkIdType  idx,
const int  N1,
const int  N2,
int &  i,
int &  j,
int &  k 
)
inlinestaticprotected

Returns the structured coordinates (i,j,k) for the given linear index of a grid with N1 and N2 dimensions along its principal directions. NOTE: i,j,k are relative to the frame of reference of the grid. For example, if the grid is on the XZ-Plane, then i=>i, j=>k, k=>j.

Definition at line 300 of file vtkStructuredData.h.


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