VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static 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 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...
 
vtkStructuredDataNewInstance () const
 
- 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...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkStructuredDataSafeDownCast (vtkObjectBase *o)
 
static int SetDimensions (int inDim[3], int dim[3])
 Specify the dimensions of a regular, rectangular dataset. More...
 
static int SetExtent (int inExt[6], int ext[6])
 
static int GetDataDescription (int dims[3])
 Returns the data description given the dimensions (eg. More...
 
static int GetDataDescriptionFromExtent (int ext[6])
 
static int GetDataDimension (int dataDescription)
 Return the topological dimension of the data (e.g., 0, 1, 2, or 3D). More...
 
static int GetDataDimension (int ext[6])
 
static vtkIdType GetNumberOfPoints (const int ext[6], int dataDescription=VTK_EMPTY)
 Given the grid extent, this method returns the total number of points within the extent. More...
 
static vtkIdType GetNumberOfCells (const int ext[6], int dataDescription=VTK_EMPTY)
 Given the grid extent, this method returns the total number of cells within the extent. More...
 
static void GetCellExtentFromPointExtent (const int pntExtent[6], int cellExtent[6], int dataDescription=VTK_EMPTY)
 Given the point extent of a grid, this method computes the corresponding cell extent for the grid. More...
 
static void GetDimensionsFromExtent (const int ext[6], int dims[3], int dataDescription=VTK_EMPTY)
 Computes the structured grid dimensions based on the given extent. More...
 
static void GetCellDimensionsFromExtent (const int ext[6], int celldims[3], int dataDescription=VTK_EMPTY)
 Returns the cell dimensions, i.e., the number of cells along the i,j,k for the grid with the given grid extent. More...
 
static void GetCellDimensionsFromPointDimensions (const int pntdims[3], int cellDims[3])
 Given the dimensions of the grid, in pntdims, this method returns the corresponding cell dimensions for the given grid. More...
 
static void GetLocalStructuredCoordinates (const int ijk[3], const int ext[6], int lijk[3], int dataDescription=VTK_EMPTY)
 Given the global structured coordinates for a point or cell, ijk, w.r.t. More...
 
static void GetGlobalStructuredCoordinates (const int lijk[3], const int ext[6], int ijk[3], int dataDescription=VTK_EMPTY)
 Given local structured coordinates, and the corresponding global sub-grid extent, this method computes the global ijk coordinates. More...
 
static void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds, int dataDescription, int dim[3])
 Get the points defining a cell. More...
 
static void GetPointCells (vtkIdType ptId, vtkIdList *cellIds, int dim[3])
 Get the cells using a point. More...
 
static void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int dim[3])
 Get the cells using the points ptIds, exclusive of the cell cellId. More...
 
static void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int dim[3], int seedLoc[3])
 
static vtkIdType ComputePointIdForExtent (const int extent[6], const int ijk[3], int dataDescription=VTK_EMPTY)
 Given a location in structured coordinates (i-j-k), and the extent of the structured dataset, return the point id. More...
 
static vtkIdType ComputeCellIdForExtent (const int extent[6], const int ijk[3], int dataDescription=VTK_EMPTY)
 Given a location in structured coordinates (i-j-k), and the extent of the structured dataset, return the point id. More...
 
static vtkIdType ComputePointId (const int dim[3], const int ijk[3], int dataDescription=VTK_EMPTY)
 Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the point id. More...
 
static vtkIdType ComputeCellId (const int dim[3], const int ijk[3], int dataDescription=VTK_EMPTY)
 Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the cell id. More...
 
static void ComputeCellStructuredCoordsForExtent (const vtkIdType cellIdx, const int ext[6], int ijk[3], int dataDescription=VTK_EMPTY)
 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. More...
 
static void ComputeCellStructuredCoords (const vtkIdType cellId, const int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
 Given a cellId and grid dimensions 'dim', get the structured coordinates (i-j-k). More...
 
static void ComputePointStructuredCoordsForExtent (const vtkIdType ptId, const int ext[6], int ijk[3], int dataDescription=VTK_EMPTY)
 Given a pointId and the grid extent ext, get the structured coordinates (i-j-k). More...
 
static void ComputePointStructuredCoords (const vtkIdType ptId, const int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
 Given a pointId and grid dimensions 'dim', get the structured coordinates (i-j-k). 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
 
 vtkStructuredData ()
 
 ~vtkStructuredData () override
 
- 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 vtkIdType GetLinearIndex (const int i, const int j, const int k, const int N1, const int N2)
 Computes the linear index for the given i-j-k structured of a grid with of N1 and N2 dimensions along its principal directions. More...
 
static void GetStructuredCoordinates (const vtkIdType idx, const int N1, const int N2, int &i, int &j, int &k)
 Returns the structured coordinates (i,j,k) for the given linear index of a grid with N1 and N2 dimensions along its principal directions. More...
 
template<typename T >
static T Max (const T &a, const T &b)
 

Additional Inherited Members

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

Definition at line 48 of file vtkStructuredData.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkStructuredData.h.

Constructor & Destructor Documentation

◆ vtkStructuredData()

vtkStructuredData::vtkStructuredData ( )
inlineprotected

Definition at line 230 of file vtkStructuredData.h.

◆ ~vtkStructuredData()

vtkStructuredData::~vtkStructuredData ( )
inlineoverrideprotected

Definition at line 231 of file vtkStructuredData.h.

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkStructuredData::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkStructuredData* vtkStructuredData::NewInstance ( ) const

◆ SetDimensions()

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.

◆ SetExtent()

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

◆ GetDataDescription()

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.)

◆ GetDataDescriptionFromExtent()

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

◆ GetDataDimension() [1/2]

static int vtkStructuredData::GetDataDimension ( int  dataDescription)
static

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

◆ GetDataDimension() [2/2]

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

◆ GetNumberOfPoints()

vtkIdType vtkStructuredData::GetNumberOfPoints ( const int  ext[6],
int  dataDescription = VTK_EMPTY 
)
inlinestatic

Given the grid extent, this method returns the total number of points within the extent.

The dataDescription field is not used.

Definition at line 296 of file vtkStructuredData.h.

◆ GetNumberOfCells()

vtkIdType vtkStructuredData::GetNumberOfCells ( const int  ext[6],
int  dataDescription = VTK_EMPTY 
)
inlinestatic

Given the grid extent, this method returns the total number of cells within the extent.

The dataDescription field is not used.

Definition at line 303 of file vtkStructuredData.h.

◆ GetCellExtentFromPointExtent()

void vtkStructuredData::GetCellExtentFromPointExtent ( const int  pntExtent[6],
int  cellExtent[6],
int  dataDescription = VTK_EMPTY 
)
inlinestatic

Given the point extent of a grid, this method computes the corresponding cell extent for the grid.

The dataDescription field is not used.

Definition at line 320 of file vtkStructuredData.h.

◆ GetDimensionsFromExtent()

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

Computes the structured grid dimensions based on the given extent.

The dataDescription field is not used.

Definition at line 333 of file vtkStructuredData.h.

◆ GetCellDimensionsFromExtent()

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

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. The dataDescription field is not used.

Definition at line 275 of file vtkStructuredData.h.

◆ GetCellDimensionsFromPointDimensions()

void vtkStructuredData::GetCellDimensionsFromPointDimensions ( const int  pntdims[3],
int  cellDims[3] 
)
inlinestatic

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

The dataDescription field is not used.

Definition at line 341 of file vtkStructuredData.h.

◆ GetLocalStructuredCoordinates()

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

Given the global structured coordinates for a point or cell, ijk, w.r.t.

as well as, the global sub-grid cell or point extent, this method computes the corresponding local structured coordinates, lijk, starting from 0. The dataDescription argument is not used.

Definition at line 350 of file vtkStructuredData.h.

◆ GetGlobalStructuredCoordinates()

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

Given local structured coordinates, and the corresponding global sub-grid extent, this method computes the global ijk coordinates.

The dataDescription parameter is not used.

Definition at line 359 of file vtkStructuredData.h.

◆ GetCellPoints()

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.)

◆ GetPointCells()

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

Get the cells using a point.

(See vtkDataSet for more info.)

◆ GetCellNeighbors() [1/2]

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.)

◆ GetCellNeighbors() [2/2]

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

◆ ComputePointIdForExtent()

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

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

The dataDescription argument is not used.

Definition at line 368 of file vtkStructuredData.h.

◆ ComputeCellIdForExtent()

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

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

The dataDescription argument is not used.

Definition at line 381 of file vtkStructuredData.h.

◆ ComputePointId()

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

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 dataDescription argument is not used.

Definition at line 283 of file vtkStructuredData.h.

◆ ComputeCellId()

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

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 dataDescription argument is not used.

Definition at line 289 of file vtkStructuredData.h.

◆ ComputeCellStructuredCoordsForExtent()

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

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 dataDescription argument is not used.

Definition at line 402 of file vtkStructuredData.h.

◆ ComputeCellStructuredCoords()

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

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 dataDescription argument is not used.

Definition at line 394 of file vtkStructuredData.h.

◆ ComputePointStructuredCoordsForExtent()

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

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 dataDescription argument is not used.

Definition at line 422 of file vtkStructuredData.h.

◆ ComputePointStructuredCoords()

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

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 dataDescription argument is not used.

Definition at line 415 of file vtkStructuredData.h.

◆ GetLinearIndex()

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 240 of file vtkStructuredData.h.

◆ GetStructuredCoordinates()

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 252 of file vtkStructuredData.h.

◆ Max()

template<typename T >
static T vtkStructuredData::Max ( const T &  a,
const T &  b 
)
inlinestaticprotected

Definition at line 264 of file vtkStructuredData.h.


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