Abstract API for vtkImageData and vtkRectilinearGrid. More...

#include <vtkCartesianGrid.h>

Inheritance diagram for vtkCartesianGrid:

Collaboration diagram for vtkCartesianGrid:

Public Member Functions
virtual int	ComputeStructuredCoordinates (const double x[3], int ijk[3], double pcoords[3])=0
	Computes the structured coordinates for a point x[3].

virtual vtkIdType	ComputePointId (int ijk[3])=0
	Given a location in structured coordinates (i-j-k), return the point id.

virtual vtkIdType	ComputeCellId (int ijk[3])=0
	Given a location in structured coordinates (i-j-k), return the cell id.

void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds, int *seedLoc)
	Get cell neighbors around cell located at `seedloc`, except cell of id `cellId`.

int	GetDataDimension ()
	Return the dimensionality of the data.

vtkStructuredCellArray *	GetCells ()
	Return the image data connectivity array.

vtkConstantArray< int > *	GetCellTypesArray ()
	Get the array of all cell types in the image data.

void	GetCellDims (int cellDims[3])
	Given the node dimensions of this grid instance, this method computes the node dimensions.

unsigned char	IsPointVisible (vtkIdType ptId)
	Return non-zero value if specified point is visible.

unsigned char	IsCellVisible (vtkIdType cellId)
	Return non-zero value if specified point is visible.

virtual int	GetDataDescription ()
	Get the data description of the rectilinear grid.

int *	GetDimensions ()
	Get dimensions of this structured points dataset.

void	GetDimensions (int dims[3])
	Get dimensions of this structured points dataset.

int	GetExtentType () VTK_FUTURE_CONST override
	Structured extent.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)=0
	Locate cell based on global coordinate x and tolerance squared.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
	This is a version of the above method that can be used with multithreaded applications.

virtual vtkCell *	GetCell (vtkIdType cellId)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkCell *	GetCell (int i, int j, int k)

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual double *	GetPoint (vtkIdType ptId)=0
	Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.

virtual void	GetPoint (vtkIdType id, double x[3])
	Copy point coordinates into user provided array x[3] for specified point id.


vtkPoints *	GetPoints () override
	Standard vtkDataSet API methods.

void	GetPoint (vtkIdType id, double x[3]) override
	Standard vtkDataSet API methods.

double *	GetPoint (vtkIdType ptId) override
	Standard vtkDataSet API methods.

vtkIdType	GetNumberOfCells () override
	Standard vtkDataSet API methods.

vtkIdType	GetNumberOfPoints () override
	Standard vtkDataSet API methods.

int	GetMaxSpatialDimension () override
	Standard vtkDataSet API methods.

int	GetMinSpatialDimension () override
	Standard vtkDataSet API methods.

int	GetCellType (vtkIdType cellId) override
	Standard vtkDataSet API methods.

vtkIdType	GetCellSize (vtkIdType cellId) override
	Standard vtkDataSet API methods.

void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds) override
	Standard vtkDataSet API methods.

void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
	Standard vtkDataSet API methods.

vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
	Standard vtkDataSet API methods.

vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights) override
	Standard vtkDataSet API methods.

void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
	Standard vtkDataSet API methods.

int	GetMaxCellSize () override
	Standard vtkDataSet API methods.

void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds) override
	Standard vtkDataSet API methods.

vtkCell *	GetCell (vtkIdType cellId) override
	Standard vtkDataSet API methods.

vtkCell *	GetCell (int i, int j, int k) override
	Standard vtkDataSet API methods.

bool	HasAnyBlankPoints () override
	Standard vtkDataSet API methods.

bool	HasAnyBlankCells () override
	Standard vtkDataSet API methods.

void	Initialize () override
	Standard vtkDataSet API methods.


virtual void	BlankPoint (vtkIdType ptId)
	Methods for supporting blanking of cells.

virtual void	UnBlankPoint (vtkIdType ptId)
	Methods for supporting blanking of cells.

virtual void	BlankPoint (int i, int j, int k)
	Methods for supporting blanking of cells.

virtual void	UnBlankPoint (int i, int j, int k)
	Methods for supporting blanking of cells.


virtual void	BlankCell (vtkIdType ptId)
	Methods for supporting blanking of cells.

virtual void	UnBlankCell (vtkIdType ptId)
	Methods for supporting blanking of cells.

virtual void	BlankCell (int i, int j, int k)
	Methods for supporting blanking of cells.

virtual void	UnBlankCell (int i, int j, int k)
	Methods for supporting blanking of cells.


void	SetDimensions (int i, int j, int k)
	Set dimensions of rectilinear grid dataset.

void	SetDimensions (const int dim[3])
	Set dimensions of rectilinear grid dataset.


void	SetExtent (int extent[6])
	Set/Get the extent.

void	SetExtent (int xMin, int xMax, int yMin, int yMax, int zMin, int zMax)
	Set/Get the extent.

virtual int *	GetExtent ()
	Set/Get the extent.

virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
	Set/Get the extent.

virtual void	GetExtent (int[6])
	Set/Get the extent.

Public Member Functions inherited from vtkDataSet
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataSet *	NewInstance () const

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

virtual void	CopyStructure (vtkDataSet *ds)=0
	Copy the geometric and topological structure of an object.

virtual void	CopyAttributes (vtkDataSet *ds)
	Copy the attributes associated with the specified dataset to this instance of vtkDataSet.

virtual vtkIdType	GetNumberOfPoints ()=0
	Determine the number of points composing the dataset.

virtual vtkIdType	GetNumberOfCells ()=0
	Determine the number of cells composing the dataset.

virtual vtkPoints *	GetPoints ()
	If the subclass has (implicit/explicit) points, then return them.

virtual double *	GetPoint (vtkIdType ptId)=0
	Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.

virtual void	GetPoint (vtkIdType id, double x[3])
	Copy point coordinates into user provided array x[3] for specified point id.

virtual vtkCellIterator *	NewCellIterator ()
	Return an iterator that traverses the cells in this data set.

virtual vtkCell *	GetCell (vtkIdType cellId)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkCell *	GetCell (int i, int j, int k)

void	SetCellOrderAndRationalWeights (vtkIdType cellId, vtkGenericCell *cell)

virtual void	GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
	Get cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])
	Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual int	GetCellType (vtkIdType cellId)=0
	Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual vtkIdType	GetCellSize (vtkIdType cellId)
	Get the size of cell with cellId such that: 0 <= cellId < NumberOfCells.

virtual void	GetCellTypes (vtkCellTypes *types)
	Get a list of types of cells in a dataset.

virtual void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0
	Topological inquiry to get points defining cell.

virtual void	GetCellPoints (vtkIdType cellId, vtkIdType &npts, vtkIdType const &pts, vtkIdList ptIds)
	Topological inquiry to get points defining cell.

virtual void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0
	Topological inquiry to get cells using point.

virtual void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)
	Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId).

virtual int	GetCellNumberOfFaces (vtkIdType cellId, unsigned char &cellType, vtkGenericCell *cell)
	Get the number of faces of a cell.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)=0
	Locate cell based on global coordinate x and tolerance squared.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
	This is a version of the above method that can be used with multithreaded applications.

virtual vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)
	Locate the cell that contains a point and return the cell.

vtkMTimeType	GetMTime () override
	Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.

vtkCellData *	GetCellData ()
	Return a pointer to this dataset's cell data.

vtkPointData *	GetPointData ()
	Return a pointer to this dataset's point data.

virtual void	Squeeze ()
	Reclaim any extra memory used to store data.

virtual void	ComputeBounds ()
	Compute the data bounding box from data points.

double *	GetBounds ()
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

void	GetBounds (double bounds[6])
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

double *	GetCenter ()
	Get the center of the bounding box.

void	GetCenter (double center[3])
	Get the center of the bounding box.

double	GetLength ()
	Return the length of the diagonal of the bounding box.

double	GetLength2 ()
	Return the squared length of the diagonal of the bounding box.

void	Initialize () override
	Restore data object to initial state.

virtual void	GetScalarRange (double range[2])
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set.

double *	GetScalarRange ()
	Convenience method to get the range of the first component (and only the first component) of any scalars in the data set.

virtual int	GetMaxCellSize ()=0
	Convenience method returns largest cell size in dataset.

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).

int	GetDataObjectType () VTK_FUTURE_CONST override
	Return the type of data object.

int	CheckAttributes ()
	This method checks to see if the cell and point attributes match the geometry.

vtkFieldData *	GetAttributesAsFieldData (int type) override
	Returns the attributes of the data object as a vtkFieldData.

vtkIdType	GetNumberOfElements (int type) override
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

virtual vtkMTimeType	GetMeshMTime ()
	Abstract method which return the mesh (geometry/topology) modification time.

bool	HasAnyGhostCells ()
	Returns 1 if there are any ghost cells 0 otherwise.

bool	HasAnyGhostPoints ()
	Returns 1 if there are any ghost points 0 otherwise.

virtual bool	HasAnyBlankCells ()
	Returns 1 if there are any blanking cells 0 otherwise.

virtual bool	HasAnyBlankPoints ()
	Returns 1 if there are any blanking points 0 otherwise.

vtkUnsignedCharArray *	GetPointGhostArray ()
	Gets the array that defines the ghost type of each point.

vtkUnsignedCharArray *	AllocatePointGhostArray ()
	Allocate ghost array for points.

vtkUnsignedCharArray *	GetCellGhostArray ()
	Get the array that defines the ghost type of each cell.

vtkUnsignedCharArray *	AllocateCellGhostArray ()
	Allocate ghost array for cells.

vtkUnsignedCharArray *	GetGhostArray (int type) override
	Returns the ghost array for the given type (point or cell).

bool	SupportsGhostArray (int type) override
	Returns true for POINT or CELL, false otherwise.

vtkIdType	FindPoint (double x, double y, double z)
	Locate the closest point to the global coordinate x.

virtual vtkIdType	FindPoint (double x[3])=0
	Locate the closest point to the global coordinate x.

void	ShallowCopy (vtkDataObject *src) override
	Shallow and Deep copy.

void	DeepCopy (vtkDataObject *src) override
	Shallow and Deep copy.

virtual void	GenerateGhostArray (int zeroExt[6])
	Normally called by pipeline executives or algorithms only.

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)
	Normally called by pipeline executives or algorithms only.

Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataObject *	NewInstance () const

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

vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime.

virtual void	Initialize ()
	Restore data object to initial state,.

void	ReleaseData ()
	Release data back to system to conserve memory resource.

virtual int	GetDataObjectType () VTK_FUTURE_CONST
	Return class name of data type.

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).

virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes).

virtual void	CopyInformationFromPipeline (vtkInformation *info)
	Copy from the pipeline information to the data object's own information.

virtual void	CopyInformationToPipeline (vtkInformation *info)
	Copy information from this data object to the pipeline information.

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data.

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted.

virtual void	ShallowCopy (vtkDataObject *src)
	The goal of the method is to copy the data up to the array pointers only.

virtual void	DeepCopy (vtkDataObject *src)
	The goal of the method is to copy the complete data from src into this object.

virtual int	GetExtentType () VTK_FUTURE_CONST
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent.

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type.

virtual vtkUnsignedCharArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified attribute type.

virtual bool	SupportsGhostArray (int type)
	Returns if this type of data object support ghost array for specified type.

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from.

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object.

virtual vtkTypeBool	GetDataReleased ()
	Get the flag indicating the data has been released.

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object.

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object.

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

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.

Protected Member Functions
	vtkCartesianGrid ()

	~vtkCartesianGrid () override=default

void	SetStructuredPoints (vtkPoints *)
	Set the internally built structured points.

virtual void	BuildPoints ()=0
	Pure abstract method responsible to build and set internal points.

Protected Member Functions inherited from vtkDataSet
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataSet ()

	~vtkDataSet () override

vtkMTimeType	GetGhostCellsTime ()
	Return the MTime of the ghost cells array.

virtual void	ComputeScalarRange ()
	Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).

Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObject ()

	~vtkDataObject () 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.

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

typedef vtkDataSet	Superclass
	Standard vtkObject API methods.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard vtkObject API methods.

static vtkCartesianGrid *	SafeDownCast (vtkObjectBase *o)
	Standard vtkObject API methods.

virtual vtkTypeBool	IsA (const char *type)
	Standard vtkObject API methods.

vtkCartesianGrid *	NewInstance () const
	Standard vtkObject API methods.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard vtkObject API methods.

void	ShallowCopy (vtkDataObject *src) override
	Standard vtkObject API methods.

void	DeepCopy (vtkDataObject *src) override
	Standard vtkObject API methods.

void	CopyStructure (vtkDataSet *ds) override
	Standard vtkObject API methods.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard vtkObject API methods.

static void	SetScalarType (int, vtkInformation *meta_data)
	Set/Get the scalar data type for the points.

static int	GetScalarType (vtkInformation *meta_data)
	Set/Get the scalar data type for the points.

static bool	HasScalarType (vtkInformation *meta_data)
	Set/Get the scalar data type for the points.

int	GetScalarType ()
	Set/Get the scalar data type for the points.

const char *	GetScalarTypeAsString ()
	Set/Get the scalar data type for the points.

static void	SetNumberOfScalarComponents (int n, vtkInformation *meta_data)
	Set/Get the number of scalar components for points.

static int	GetNumberOfScalarComponents (vtkInformation *meta_data)
	Set/Get the number of scalar components for points.

static bool	HasNumberOfScalarComponents (vtkInformation *meta_data)
	Set/Get the number of scalar components for points.

int	GetNumberOfScalarComponents ()
	Set/Get the number of scalar components for points.

Additional Inherited Members
Public Types inherited from vtkDataSet
enum	FieldDataType { DATA_OBJECT_FIELD = 0 , POINT_DATA_FIELD = 1 , CELL_DATA_FIELD = 2 }

typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS , FIELD_ASSOCIATION_CELLS , FIELD_ASSOCIATION_NONE , FIELD_ASSOCIATION_POINTS_THEN_CELLS , FIELD_ASSOCIATION_VERTICES , FIELD_ASSOCIATION_EDGES , FIELD_ASSOCIATION_ROWS , NUMBER_OF_ASSOCIATIONS }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT , CELL , FIELD , POINT_THEN_CELL , VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...

typedef vtkObject	Superclass

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

static vtkDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkDataSet *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkDataSet *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array.

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters.

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e.

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e.

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

static void	SetGlobalReleaseDataFlag (vtkTypeBool val)
	Turn on/off flag to control whether every object releases its data after being used by a filter.

static vtkTypeBool	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

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.

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkDataSet
vtkNew< vtkGenericCell >	GenericCell

vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

vtkTypeBool	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

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

Abstract API for vtkImageData and vtkRectilinearGrid.

vtkCartesianGrid is an abstract class that provide a common API for both vtkImageData and vtkRectilinearGrid.

It contains the logic related to the handling of extents, dimensions and data description, As well as many methods that behave the same for image data and rectilinear grid.

Tests:: vtkCartesianGrid (Tests)

Definition at line 26 of file vtkCartesianGrid.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataSet vtkCartesianGrid::Superclass

Standard vtkObject API methods.

See vtkObject for more information.

Definition at line 33 of file vtkCartesianGrid.h.

Constructor & Destructor Documentation

◆ vtkCartesianGrid()

vtkCartesianGrid::vtkCartesianGrid ( )

protected

◆ ~vtkCartesianGrid()

vtkCartesianGrid::~vtkCartesianGrid ( )

overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

static

Standard vtkObject API methods.

See vtkObject for more information.

◆ IsA()

virtual vtkTypeBool vtkCartesianGrid::IsA ( const char * type )

virtual

Standard vtkObject API methods.

See vtkObject for more information.

Reimplemented from vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkStructuredPoints, and vtkUniformGrid.

◆ SafeDownCast()

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

static

Standard vtkObject API methods.

See vtkObject for more information.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCartesianGrid::NewInstanceInternal ( ) const

protectedvirtual

Standard vtkObject API methods.

See vtkObject for more information.

Reimplemented from vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkStructuredPoints, and vtkUniformGrid.

◆ NewInstance()

vtkCartesianGrid * vtkCartesianGrid::NewInstance ( ) const

Standard vtkObject API methods.

See vtkObject for more information.

◆ PrintSelf()

void vtkCartesianGrid::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard vtkObject API methods.

See vtkObject for more information.

Reimplemented from vtkObjectBase.

Reimplemented in vtkImageData, vtkRectilinearGrid, and vtkStructuredPoints.

◆ ShallowCopy()

void vtkCartesianGrid::ShallowCopy ( vtkDataObject * src )

overridevirtual

Standard vtkObject API methods.

See vtkObject for more information.

Reimplemented from vtkDataObject.

Reimplemented in vtkImageData, and vtkRectilinearGrid.

◆ DeepCopy()

void vtkCartesianGrid::DeepCopy ( vtkDataObject * src )

overridevirtual

Standard vtkObject API methods.

See vtkObject for more information.

Reimplemented from vtkDataObject.

Reimplemented in vtkImageData, and vtkRectilinearGrid.

◆ CopyStructure()

void vtkCartesianGrid::CopyStructure ( vtkDataSet * ds )

overridevirtual

Standard vtkObject API methods.

See vtkObject for more information.

Implements vtkDataSet.

Reimplemented in vtkImageData, and vtkRectilinearGrid.

◆ GetPoints()

vtkPoints * vtkCartesianGrid::GetPoints ( )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ GetPoint() [1/4]

void vtkCartesianGrid::GetPoint	(	vtkIdType	id,
		double	x[3]
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Reimplemented in vtkRectilinearGrid, and vtkRectilinearGrid.

◆ GetPoint() [2/4]

double * vtkCartesianGrid::GetPoint ( vtkIdType ptId )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkRectilinearGrid, and vtkRectilinearGrid.

Definition at line 289 of file vtkCartesianGrid.h.

◆ GetNumberOfCells()

vtkIdType vtkCartesianGrid::GetNumberOfCells ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 302 of file vtkCartesianGrid.h.

◆ GetNumberOfPoints()

vtkIdType vtkCartesianGrid::GetNumberOfPoints ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 296 of file vtkCartesianGrid.h.

◆ GetMaxSpatialDimension()

int vtkCartesianGrid::GetMaxSpatialDimension ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 314 of file vtkCartesianGrid.h.

◆ GetMinSpatialDimension()

int vtkCartesianGrid::GetMinSpatialDimension ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Definition at line 320 of file vtkCartesianGrid.h.

◆ GetCellType()

int vtkCartesianGrid::GetCellType ( vtkIdType cellId )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

◆ GetCellSize()

vtkIdType vtkCartesianGrid::GetCellSize ( vtkIdType cellId )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ GetCellPoints() [1/2]

void vtkCartesianGrid::GetCellPoints	(	vtkIdType	cellId,
		vtkIdType &	npts,
		vtkIdType const *&	pts,
		vtkIdList *	ptIds
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ GetCellPoints() [2/2]

void vtkCartesianGrid::GetCellPoints	(	vtkIdType	cellId,
		vtkIdList *	ptIds
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

◆ FindCell() [1/3]

vtkIdType vtkCartesianGrid::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkGenericCell *	gencell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkImageData, and vtkRectilinearGrid.

◆ FindAndGetCell()

vtkCell * vtkCartesianGrid::FindAndGetCell	(	double	x[3],
		vtkCell *	cell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ GetPointCells()

void vtkCartesianGrid::GetPointCells	(	vtkIdType	ptId,
		vtkIdList *	cellIds
	)

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 64 of file vtkCartesianGrid.h.

◆ GetMaxCellSize()

int vtkCartesianGrid::GetMaxCellSize ( )

inlineoverridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 68 of file vtkCartesianGrid.h.

◆ GetCellNeighbors() [1/2]

void vtkCartesianGrid::GetCellNeighbors	(	vtkIdType	cellId,
		vtkIdList *	ptIds,
		vtkIdList *	cellIds
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ GetCell() [1/5]

vtkCell * vtkCartesianGrid::GetCell ( vtkIdType cellId )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Implements vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkImageData, and vtkRectilinearGrid.

◆ GetCell() [2/5]

vtkCell * vtkCartesianGrid::GetCell	(	int	i,
		int	j,
		int	k
	)

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkImageData, and vtkRectilinearGrid.

◆ HasAnyBlankPoints()

bool vtkCartesianGrid::HasAnyBlankPoints ( )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ HasAnyBlankCells()

bool vtkCartesianGrid::HasAnyBlankCells ( )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataSet.

◆ Initialize()

void vtkCartesianGrid::Initialize ( )

overridevirtual

Standard vtkDataSet API methods.

See vtkDataSet for more information.

Reimplemented from vtkDataObject.

Reimplemented in vtkRectilinearGrid.

◆ ComputeStructuredCoordinates()

virtual int vtkCartesianGrid::ComputeStructuredCoordinates	(	const double	x[3],
		int	ijk[3],
		double	pcoords[3]
	)

pure virtual

Computes the structured coordinates for a point x[3].

The cell is specified by the array ijk[3], and the parametric coordinates in the cell are specified with pcoords[3]. The function returns a 0 if the point x is outside of the grid, and a 1 if inside the grid.

Implemented in vtkImageData, vtkRectilinearGrid, and vtkRectilinearGrid.

◆ ComputePointId()

virtual vtkIdType vtkCartesianGrid::ComputePointId ( int ijk[3] )

pure virtual

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

Implemented in vtkImageData, and vtkRectilinearGrid.

◆ ComputeCellId()

virtual vtkIdType vtkCartesianGrid::ComputeCellId ( int ijk[3] )

pure virtual

Given a location in structured coordinates (i-j-k), return the cell id.

Implemented in vtkImageData, and vtkRectilinearGrid.

◆ GetCellNeighbors() [2/2]

void vtkCartesianGrid::GetCellNeighbors	(	vtkIdType	cellId,
		vtkIdList *	ptIds,
		vtkIdList *	cellIds,
		int *	seedLoc
	)

Get cell neighbors around cell located at seedloc, except cell of id cellId.

Warning: seedloc is the position in the grid with the origin shifted to (0, 0, 0). This is because the backend of this method is shared with vtkRectilinearGrid and vtkStructuredGrid.

◆ GetDataDimension()

int vtkCartesianGrid::GetDataDimension ( )

inline

Return the dimensionality of the data.

Definition at line 308 of file vtkCartesianGrid.h.

◆ GetCells()

vtkStructuredCellArray * vtkCartesianGrid::GetCells ( )

Return the image data connectivity array.

NOTE: the returned object should not be modified.

◆ GetCellTypesArray()

vtkConstantArray< int > * vtkCartesianGrid::GetCellTypesArray ( )

Get the array of all cell types in the image data.

Each single-component integer value is the same. The array is of size GetNumberOfCells().

NOTE: the returned object should not be modified.

◆ GetCellDims()

void vtkCartesianGrid::GetCellDims ( int cellDims[3] )

Given the node dimensions of this grid instance, this method computes the node dimensions.

The value in each dimension can will have a lowest value of "1" such that computing the total number of cells can be achieved by simply by cellDims[0]*cellDims[1]*cellDims[2].

◆ BlankPoint() [1/2]

virtual void vtkCartesianGrid::BlankPoint ( vtkIdType ptId )

virtual

Methods for supporting blanking of cells.

Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankPoint() [1/2]

virtual void vtkCartesianGrid::UnBlankPoint ( vtkIdType ptId )

virtual

Methods for supporting blanking of cells.

Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

◆ BlankPoint() [2/2]

virtual void vtkCartesianGrid::BlankPoint	(	int	i,
		int	j,
		int	k
	)

virtual

Methods for supporting blanking of cells.

Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankPoint() [2/2]

virtual void vtkCartesianGrid::UnBlankPoint	(	int	i,
		int	j,
		int	k
	)

virtual

Methods for supporting blanking of cells.

Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

◆ BlankCell() [1/2]

virtual void vtkCartesianGrid::BlankCell ( vtkIdType ptId )

virtual

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankCell() [1/2]

virtual void vtkCartesianGrid::UnBlankCell ( vtkIdType ptId )

virtual

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ BlankCell() [2/2]

virtual void vtkCartesianGrid::BlankCell	(	int	i,
		int	j,
		int	k
	)

virtual

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ UnBlankCell() [2/2]

virtual void vtkCartesianGrid::UnBlankCell	(	int	i,
		int	j,
		int	k
	)

virtual

Methods for supporting blanking of cells.

Blanking turns on or off cells in the structured grid. These methods should be called only after the dimensions of the grid are set.

◆ IsPointVisible()

unsigned char vtkCartesianGrid::IsPointVisible ( vtkIdType ptId )

Return non-zero value if specified point is visible.

These methods should be called only after the dimensions of the grid are set.

◆ IsCellVisible()

unsigned char vtkCartesianGrid::IsCellVisible ( vtkIdType cellId )

Return non-zero value if specified point is visible.

These methods should be called only after the dimensions of the grid are set.

◆ GetDataDescription()

virtual int vtkCartesianGrid::GetDataDescription ( )

virtual

Get the data description of the rectilinear grid.

◆ SetDimensions() [1/2]

void vtkCartesianGrid::SetDimensions	(	int	i,
		int	j,
		int	k
	)

inline

Set dimensions of rectilinear grid dataset.

This also sets the extent.

Definition at line 182 of file vtkCartesianGrid.h.

◆ SetDimensions() [2/2]

void vtkCartesianGrid::SetDimensions ( const int dim[3] )

inline

Set dimensions of rectilinear grid dataset.

This also sets the extent.

Definition at line 183 of file vtkCartesianGrid.h.

◆ GetDimensions() [1/2]

int * vtkCartesianGrid::GetDimensions ( )

Get dimensions of this structured points dataset.

It is the number of points on each axis. Dimensions are computed from Extents during this call.

Warning: Non thread-safe, use second signature if you want it to be.

◆ GetDimensions() [2/2]

void vtkCartesianGrid::GetDimensions ( int dims[3] )

Get dimensions of this structured points dataset.

It is the number of points on each axis. This method is thread-safe.

Warning: The Dimensions member variable is not updated during this call.

◆ GetExtentType()

int vtkCartesianGrid::GetExtentType ( )

inlineoverridevirtual

Structured extent.

The extent type is a 3D extent

Reimplemented from vtkDataObject.

Definition at line 211 of file vtkCartesianGrid.h.

◆ SetExtent() [1/2]

void vtkCartesianGrid::SetExtent ( int extent[6] )

Set/Get the extent.

On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

◆ SetExtent() [2/2]

void vtkCartesianGrid::SetExtent	(	int	xMin,
		int	xMax,
		int	yMin,
		int	yMax,
		int	zMin,
		int	zMax
	)

Set/Get the extent.

On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

◆ GetExtent() [1/3]

virtual int * vtkCartesianGrid::GetExtent ( )

virtual

Set/Get the extent.

On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

◆ GetExtent() [2/3]

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

virtual

Set/Get the extent.

On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

◆ GetExtent() [3/3]

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

virtual

Set/Get the extent.

On each axis, the extent is defined by the index of the first point and the index of the last point. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z). The dataset extent does not have to start at (0,0,0). (0,0,0) is just the extent of the origin. The first point (the one with Id=0) is at extent (Extent[0],Extent[2],Extent[4]). As for any dataset, a data array on point data starts at Id=0.

◆ SetScalarType()

static void vtkCartesianGrid::SetScalarType	(	int	,
		vtkInformation *	meta_data
	)

static

Set/Get the scalar data type for the points.

This is setting pipeline info. Assume VTK_DOUBLE if not set or empty.

◆ GetScalarType() [1/2]

static int vtkCartesianGrid::GetScalarType ( vtkInformation * meta_data )

static

Set/Get the scalar data type for the points.

This is setting pipeline info. Assume VTK_DOUBLE if not set or empty.

◆ HasScalarType()

static bool vtkCartesianGrid::HasScalarType ( vtkInformation * meta_data )

static

Set/Get the scalar data type for the points.

This is setting pipeline info. Assume VTK_DOUBLE if not set or empty.

◆ GetScalarType() [2/2]

int vtkCartesianGrid::GetScalarType ( )

Set/Get the scalar data type for the points.

This is setting pipeline info. Assume VTK_DOUBLE if not set or empty.

◆ GetScalarTypeAsString()

const char * vtkCartesianGrid::GetScalarTypeAsString ( )

inline

Set/Get the scalar data type for the points.

This is setting pipeline info. Assume VTK_DOUBLE if not set or empty.

Definition at line 239 of file vtkCartesianGrid.h.

◆ SetNumberOfScalarComponents()

static void vtkCartesianGrid::SetNumberOfScalarComponents	(	int	n,
		vtkInformation *	meta_data
	)

static

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info. 1 if not set or empty.

◆ GetNumberOfScalarComponents() [1/2]

static int vtkCartesianGrid::GetNumberOfScalarComponents ( vtkInformation * meta_data )

static

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info. 1 if not set or empty.

◆ HasNumberOfScalarComponents()

static bool vtkCartesianGrid::HasNumberOfScalarComponents ( vtkInformation * meta_data )

static

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info. 1 if not set or empty.

◆ GetNumberOfScalarComponents() [2/2]

int vtkCartesianGrid::GetNumberOfScalarComponents ( )

Set/Get the number of scalar components for points.

As with the SetScalarType method this is setting pipeline info. 1 if not set or empty.

◆ SetStructuredPoints()

void vtkCartesianGrid::SetStructuredPoints ( vtkPoints * )

protected

Set the internally built structured points.

◆ BuildPoints()

virtual void vtkCartesianGrid::BuildPoints ( )

protectedpure virtual

Pure abstract method responsible to build and set internal points.

Implemented in vtkImageData, and vtkRectilinearGrid.

◆ FindCell() [2/3]

virtual vtkIdType vtkDataSet::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

virtual

Locate cell based on global coordinate x and tolerance squared.

If cell and cellId is non-nullptr, then search starts from this cell and looks at immediate neighbors. Returns cellId >= 0 if inside, < 0 otherwise. The parametric coordinates are provided in pcoords[3]. The interpolation weights are returned in weights[]. (The number of weights is equal to the number of points in the found cell). Tolerance is used to control how close the point is to be considered "in" the cell. THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkImageData, and vtkRectilinearGrid.

◆ FindCell() [3/3]

virtual vtkIdType vtkDataSet::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkGenericCell *	gencell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

virtual

This is a version of the above method that can be used with multithreaded applications.

A vtkGenericCell must be passed in to be used in internal calls that might be made to GetCell() THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkImageData, and vtkRectilinearGrid.

◆ GetCell() [3/5]

virtual vtkCell * vtkDataSet::GetCell ( vtkIdType cellId )

virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

The returned vtkCell is an object owned by this instance, hence the return value must not be deleted by the caller.

Warning: Repeat calls to this function for different face ids will change the data stored in the internal member object whose pointer is returned by this function.; THIS METHOD IS NOT THREAD SAFE. For a thread-safe version, please use void GetCell(vtkIdType cellId, vtkGenericCell* cell).

Implements vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkImageData, and vtkRectilinearGrid.

◆ GetCell() [4/5]

virtual vtkCell * vtkDataSet::GetCell	(	int	i,
		int	j,
		int	k
	)

inlinevirtual

Reimplemented from vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkImageData, and vtkRectilinearGrid.

Definition at line 238 of file vtkDataSet.h.

◆ GetCell() [5/5]

virtual void vtkDataSet::GetCell	(	vtkIdType	cellId,
		vtkGenericCell *	cell
	)

virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

Reimplemented in vtkImageData, vtkRectilinearGrid, vtkImageData, and vtkRectilinearGrid.

◆ GetPoint() [3/4]

virtual double * vtkDataSet::GetPoint ( vtkIdType ptId )

virtual

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.

THIS METHOD IS NOT THREAD SAFE.

Implements vtkDataSet.

Reimplemented in vtkRectilinearGrid, and vtkRectilinearGrid.

◆ GetPoint() [4/4]

void vtkDataSet::GetPoint	(	vtkIdType	id,
		double	x[3]
	)

inlinevirtual

Copy point coordinates into user provided array x[3] for specified point id.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkDataSet.

Reimplemented in vtkRectilinearGrid, and vtkRectilinearGrid.

Definition at line 217 of file vtkDataSet.h.

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

Common/DataModel/vtkCartesianGrid.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCartesianGrid()

◆ ~vtkCartesianGrid()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ ShallowCopy()

◆ DeepCopy()

◆ CopyStructure()

◆ GetPoints()

◆ GetPoint() [1/4]

◆ GetPoint() [2/4]

◆ GetNumberOfCells()

◆ GetNumberOfPoints()

◆ GetMaxSpatialDimension()

◆ GetMinSpatialDimension()

◆ GetCellType()

◆ GetCellSize()

◆ GetCellPoints() [1/2]

◆ GetCellPoints() [2/2]

◆ FindCell() [1/3]

◆ FindAndGetCell()

◆ GetPointCells()

◆ GetMaxCellSize()

◆ GetCellNeighbors() [1/2]

◆ GetCell() [1/5]

◆ GetCell() [2/5]

◆ HasAnyBlankPoints()

◆ HasAnyBlankCells()

◆ Initialize()

◆ ComputeStructuredCoordinates()

◆ ComputePointId()

◆ ComputeCellId()

◆ GetCellNeighbors() [2/2]

◆ GetDataDimension()

◆ GetCells()

◆ GetCellTypesArray()

◆ GetCellDims()

◆ BlankPoint() [1/2]

◆ UnBlankPoint() [1/2]

◆ BlankPoint() [2/2]

◆ UnBlankPoint() [2/2]

◆ BlankCell() [1/2]

◆ UnBlankCell() [1/2]

◆ BlankCell() [2/2]

◆ UnBlankCell() [2/2]

◆ IsPointVisible()

◆ IsCellVisible()

◆ GetDataDescription()

◆ SetDimensions() [1/2]

◆ SetDimensions() [2/2]

◆ GetDimensions() [1/2]

◆ GetDimensions() [2/2]

◆ GetExtentType()

◆ SetExtent() [1/2]

◆ SetExtent() [2/2]

◆ GetExtent() [1/3]

◆ GetExtent() [2/3]

◆ GetExtent() [3/3]

◆ SetScalarType()

◆ GetScalarType() [1/2]

◆ HasScalarType()

◆ GetScalarType() [2/2]

◆ GetScalarTypeAsString()

◆ SetNumberOfScalarComponents()

◆ GetNumberOfScalarComponents() [1/2]

◆ HasNumberOfScalarComponents()

◆ GetNumberOfScalarComponents() [2/2]

◆ SetStructuredPoints()

◆ BuildPoints()