Singleton class for topologically regular data. More...

#include <vtkStructuredData.h>

Inheritance diagram for vtkStructuredData:

Collaboration diagram for vtkStructuredData:

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.

vtkStructuredData *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkStructuredData *	SafeDownCast (vtkObjectBase *o)

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.

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.

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.

static void	GetDimensionsFromExtent (const int ext[6], int dims[3], int dataDescription=VTK_EMPTY)
	Computes the structured grid dimensions based on the given extent.

static bool	IsPointVisible (vtkIdType cellId, vtkUnsignedCharArray *ghosts)
	Return non-zero value if specified point is visible.

static bool	IsCellVisible (vtkIdType cellId, VTK_FUTURE_CONST int dimensions[3], int dataDescription, vtkUnsignedCharArray cellGhostArray, vtkUnsignedCharArray pointGhostArray=nullptr)
	Return non-zero value if specified cell is visible.

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.

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.

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.

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.

static void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds, int dataDescription, int dim[3])
	Get the points defining a cell.

static void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds, VTK_FUTURE_CONST int dim[3])
	Get the cells using a point.

static void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds, int dim[3])
	Get the cells using the points ptIds, exclusive of the cell cellId.

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.

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.

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.

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.

static void	ComputeCellStructuredCoordsForExtent (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.

static void	ComputeCellStructuredCoords (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).

static void	ComputeCellStructuredMinMaxCoords (vtkIdType cellId, const int dim[3], int ijkMin[3], int ijkMax[3], int dataDescription=VTK_EMPTY)
	Given a cellId and grid dimensions 'dim', get the min and max structured coordinates (i-j-k).

static void	ComputePointStructuredCoordsForExtent (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).

static void	ComputePointStructuredCoords (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).

static vtkSmartPointer< vtkStructuredCellArray >	GetCellArray (int extent[6], bool usePixelVoxelOrientation)
	Get the implicit cell array for structured data.

static vtkSmartPointer< vtkPoints >	GetPoints (vtkDataArray xCoords, vtkDataArray yCoords, vtkDataArray *zCoords, int extent[6], double dirMatrix[9])
	Given 3 arrays describing the xCoords, yCoords, and zCoords, the extent, and the direction matrix, create an implicit vtkPoints object.

static VTK_WRAPEXCLUDE vtkSmartPointer< vtkConstantArray< int > >	GetCellTypesArray (int extent[6], bool usePixelVoxelOrientation)
	Get the implicit cell array types for structured data.


static int	SetDimensions (VTK_FUTURE_CONST int inDim[3], int dim[3])
	Specify the dimensions of a regular, rectangular dataset.

static int	SetExtent (VTK_FUTURE_CONST int inExt[6], int ext[6])
	Specify the dimensions of a regular, rectangular dataset.


static int	GetDataDescription (int dims[3])
	Returns the data description given the dimensions (eg.

static int	GetDataDescriptionFromExtent (int ext[6])
	Returns the data description given the dimensions (eg.


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

static int	GetDataDimension (int ext[6])
	Return the topological dimension of the data (e.g., 0, 1, 2, or 3D).

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkStructuredData ()=default

	~vtkStructuredData () override=default

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	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.

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


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.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

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

Online Examples:

CellIdFromGridCoordinates

IntersectLine

GetLinearPointId

Tests:: vtkStructuredData (Tests)

Definition at line 91 of file vtkStructuredData.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkStructuredData::Superclass

Definition at line 94 of file vtkStructuredData.h.

Constructor & Destructor Documentation

◆ vtkStructuredData()

vtkStructuredData::vtkStructuredData ( )

protecteddefault

◆ ~vtkStructuredData()

vtkStructuredData::~vtkStructuredData ( )

overrideprotecteddefault

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

◆ PrintSelf()

void vtkStructuredData::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.

◆ SetDimensions()

static int vtkStructuredData::SetDimensions	(	VTK_FUTURE_CONST 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	(	VTK_FUTURE_CONST 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.

◆ 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

Returns the data description given the dimensions (eg.

VTK_SINGLE_POINT, VTK_X_LINE, VTK_XY_PLANE etc.)

◆ 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

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

◆ 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 378 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 385 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 402 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 415 of file vtkStructuredData.h.

◆ IsPointVisible()

static bool vtkStructuredData::IsPointVisible	(	vtkIdType	cellId,
		vtkUnsignedCharArray *	ghosts
	)

static

Return non-zero value if specified point is visible.

◆ IsCellVisible()

static bool vtkStructuredData::IsCellVisible	(	vtkIdType	cellId,
		VTK_FUTURE_CONST int	dimensions[3],
		int	dataDescription,
		vtkUnsignedCharArray *	cellGhostArray,
		vtkUnsignedCharArray *	pointGhostArray = `nullptr`
	)

static

Return non-zero value if specified cell is visible.

◆ 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 357 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 423 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 432 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 441 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,
		VTK_FUTURE_CONST 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 450 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 463 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 365 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 371 of file vtkStructuredData.h.

◆ ComputeCellStructuredCoordsForExtent()

void vtkStructuredData::ComputeCellStructuredCoordsForExtent	(	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 484 of file vtkStructuredData.h.

◆ ComputeCellStructuredCoords()

void vtkStructuredData::ComputeCellStructuredCoords	(	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 476 of file vtkStructuredData.h.

◆ ComputeCellStructuredMinMaxCoords()

static void vtkStructuredData::ComputeCellStructuredMinMaxCoords	(	vtkIdType	cellId,
		const int	dim[3],
		int	ijkMin[3],
		int	ijkMax[3],
		int	dataDescription = `VTK_EMPTY`
	)

static

Given a cellId and grid dimensions 'dim', get the min and max structured coordinates (i-j-k).

This method does not adjust for the beginning of the extent.

◆ ComputePointStructuredCoordsForExtent()

void vtkStructuredData::ComputePointStructuredCoordsForExtent	(	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 504 of file vtkStructuredData.h.

◆ ComputePointStructuredCoords()

void vtkStructuredData::ComputePointStructuredCoords	(	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 497 of file vtkStructuredData.h.

◆ GetCellArray()

static vtkSmartPointer< vtkStructuredCellArray > vtkStructuredData::GetCellArray	(	int	extent[6],
		bool	usePixelVoxelOrientation
	)

static

Get the implicit cell array for structured data.

◆ GetPoints()

static vtkSmartPointer< vtkPoints > vtkStructuredData::GetPoints	(	vtkDataArray *	xCoords,
		vtkDataArray *	yCoords,
		vtkDataArray *	zCoords,
		int	extent[6],
		double	dirMatrix[9]
	)

static

Given 3 arrays describing the xCoords, yCoords, and zCoords, the extent, and the direction matrix, create an implicit vtkPoints object.

◆ GetCellTypesArray()

static VTK_WRAPEXCLUDE vtkSmartPointer< vtkConstantArray< int > > vtkStructuredData::GetCellTypesArray	(	int	extent[6],
		bool	usePixelVoxelOrientation
	)

static

Get the implicit cell array types for structured data.

◆ 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 322 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 334 of file vtkStructuredData.h.

◆ Max()

template<typename T >

static T vtkStructuredData::Max	(	const T &	a,
		const T &	b
	)

inlinestaticprotected

Definition at line 346 of file vtkStructuredData.h.

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

Common/DataModel/vtkStructuredData.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkStructuredData()

◆ ~vtkStructuredData()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetDimensions()

◆ SetExtent()

◆ GetDataDescription()

◆ GetDataDescriptionFromExtent()

◆ GetDataDimension() [1/2]

◆ GetDataDimension() [2/2]

◆ GetNumberOfPoints()

◆ GetNumberOfCells()

◆ GetCellExtentFromPointExtent()

◆ GetDimensionsFromExtent()

◆ IsPointVisible()

◆ IsCellVisible()

◆ GetCellDimensionsFromExtent()

◆ GetCellDimensionsFromPointDimensions()

◆ GetLocalStructuredCoordinates()

◆ GetGlobalStructuredCoordinates()

◆ GetCellPoints()

◆ GetPointCells()

◆ GetCellNeighbors() [1/2]

◆ GetCellNeighbors() [2/2]

◆ ComputePointIdForExtent()

◆ ComputeCellIdForExtent()

◆ ComputePointId()

◆ ComputeCellId()

◆ ComputeCellStructuredCoordsForExtent()

◆ ComputeCellStructuredCoords()

◆ ComputeCellStructuredMinMaxCoords()

◆ ComputePointStructuredCoordsForExtent()

◆ ComputePointStructuredCoords()

◆ GetCellArray()

◆ GetPoints()

◆ GetCellTypesArray()

◆ GetLinearIndex()

◆ GetStructuredCoordinates()

◆ Max()