VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkUniformGrid Class Reference

image data with blanking More...

#include <vtkUniformGrid.h>

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

Public Types

typedef vtkImageData Superclass
 
- Public Types inherited from vtkImageData
typedef vtkDataSet Superclass
 
- 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
 

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...
 
vtkUniformGridNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void CopyStructure (vtkDataSet *ds) override
 Copy the geometric and topological structure of an input image data object. More...
 
int GetDataObjectType () override
 Return what type of dataset this is. More...
 
vtkCellGetCell (int i, int j, int k) override
 Standard vtkDataSet API methods. More...
 
vtkCellGetCell (vtkIdType cellId) override
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
void GetCell (vtkIdType cellId, vtkGenericCell *cell) override
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Locate cell based on global coordinate x and tolerance squared. More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 This is a version of the above method that can be used with multithreaded applications. More...
 
vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Locate the cell that contains a point and return the cell. More...
 
int GetCellType (vtkIdType cellId) override
 Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override
 Topological inquiry to get points defining cell. More...
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
 Topological inquiry to get cells using point. More...
 
void Initialize () override
 Restore data object to initial state. More...
 
int GetMaxCellSize () override
 Convenience method returns largest cell size in dataset. More...
 
int GetGridDescription ()
 Returns the data description of this uniform grid instance. More...
 
int Initialize (const vtkAMRBox *def, double *origin, double *spacing)
 Initialize with no ghost cell arrays, from the definition in the given box. More...
 
int Initialize (const vtkAMRBox *def, double *origin, double *spacing, int nGhosts)
 Initialize from the definition in the given box, with ghost cell arrays nGhosts cells thick in all directions. More...
 
int Initialize (const vtkAMRBox *def, double *origin, double *spacing, const int nGhosts[3])
 Initialize from the definition in the given box, with ghost cell arrays of the thickness given in each direction by "nGhosts" array. More...
 
int Initialize (const vtkAMRBox *def, double *origin, double *spacing, int nGhostsI, int nGhostsJ, int nGhostsK)
 Construct a uniform grid, from the definition in the given box "def", with ghost cell arrays of the thickness given in each direction by "nGhosts*". More...
 
virtual void BlankPoint (vtkIdType ptId)
 Methods for supporting blanking of cells. More...
 
virtual void UnBlankPoint (vtkIdType ptId)
 
virtual void BlankPoint (const int i, const int j, const int k)
 
virtual void UnBlankPoint (const int i, const int j, const int k)
 
virtual void BlankCell (vtkIdType ptId)
 Methods for supporting blanking of cells. More...
 
virtual void UnBlankCell (vtkIdType ptId)
 
virtual void BlankCell (const int i, const int j, const int k)
 
virtual void UnBlankCell (const int i, const int j, const int k)
 
bool HasAnyBlankCells () override
 Returns 1 if there is any visibility constraint on the cells, 0 otherwise. More...
 
bool HasAnyBlankPoints () override
 Returns 1 if there is any visibility constraint on the points, 0 otherwise. More...
 
virtual unsigned char IsPointVisible (vtkIdType ptId)
 Return non-zero value if specified point is visible. More...
 
virtual unsigned char IsCellVisible (vtkIdType cellId)
 Return non-zero value if specified cell is visible. More...
 
virtual vtkImageDataNewImageDataCopy ()
 
- Public Member Functions inherited from vtkImageData
vtkImageDataNewInstance () const
 
vtkIdType GetNumberOfCells () override
 Standard vtkDataSet API methods. More...
 
vtkIdType GetNumberOfPoints () override
 Determine the number of points composing the dataset. More...
 
doubleGetPoint (vtkIdType ptId) override
 Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. More...
 
void GetPoint (vtkIdType id, double x[3]) override
 Copy point coordinates into user provided array x[3] for specified point id. More...
 
vtkCellGetCell (int i, int j, int k) override
 
void GetCellBounds (vtkIdType cellId, double bounds[6]) override
 Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. More...
 
virtual vtkIdType FindPoint (double x, double y, double z)
 
vtkIdType FindPoint (double x[3]) override
 
void ComputeBounds () override
 Compute the data bounding box from data points. More...
 
virtual void SetDimensions (int i, int j, int k)
 Same as SetExtent(0, i-1, 0, j-1, 0, k-1) More...
 
virtual void SetDimensions (const int dims[3])
 Same as SetExtent(0, dims[0]-1, 0, dims[1]-1, 0, dims[2]-1) More...
 
virtual intGetDimensions ()
 Get dimensions of this structured points dataset. More...
 
virtual void GetDimensions (int dims[3])
 Get dimensions of this structured points dataset. More...
 
virtual int ComputeStructuredCoordinates (const double x[3], int ijk[3], double pcoords[3])
 Convenience function computes the structured coordinates for a point x[3]. More...
 
virtual void GetVoxelGradient (int i, int j, int k, vtkDataArray *s, vtkDataArray *g)
 Given structured coordinates (i,j,k) for a voxel cell, compute the eight gradient values for the voxel corners. More...
 
virtual void GetPointGradient (int i, int j, int k, vtkDataArray *s, double g[3])
 Given structured coordinates (i,j,k) for a point in a structured point dataset, compute the gradient vector from the scalar data at that point. More...
 
virtual int GetDataDimension ()
 Return the dimensionality of the data. More...
 
virtual vtkIdType ComputePointId (int ijk[3])
 Given a location in structured coordinates (i-j-k), return the point id. More...
 
virtual vtkIdType ComputeCellId (int ijk[3])
 Given a location in structured coordinates (i-j-k), return the cell id. More...
 
virtual void SetAxisUpdateExtent (int axis, int min, int max, const int *updateExtent, int *axisUpdateExtent)
 Set / Get the extent on just one axis. More...
 
virtual void GetAxisUpdateExtent (int axis, int &min, int &max, const int *updateExtent)
 
virtual void SetExtent (int extent[6])
 Set/Get the extent. More...
 
virtual void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
 
virtual intGetExtent ()
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetExtent (int[6])
 
virtual double GetScalarTypeMin (vtkInformation *meta_data)
 These returns the minimum and maximum values the ScalarType can hold without overflowing. More...
 
virtual double GetScalarTypeMin ()
 
virtual double GetScalarTypeMax (vtkInformation *meta_data)
 
virtual double GetScalarTypeMax ()
 
virtual int GetScalarSize (vtkInformation *meta_data)
 Get the size of the scalar type in bytes. More...
 
virtual int GetScalarSize ()
 
virtual vtkIdTypeGetIncrements ()
 Different ways to get the increments for moving around the data. More...
 
virtual void GetIncrements (vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 
virtual void GetIncrements (vtkIdType inc[3])
 
virtual vtkIdTypeGetIncrements (vtkDataArray *scalars)
 
virtual void GetIncrements (vtkDataArray *scalars, vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 
virtual void GetIncrements (vtkDataArray *scalars, vtkIdType inc[3])
 
virtual void GetContinuousIncrements (int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 Different ways to get the increments for moving around the data. More...
 
virtual void GetContinuousIncrements (vtkDataArray *scalars, int extent[6], vtkIdType &incX, vtkIdType &incY, vtkIdType &incZ)
 
virtual void * GetScalarPointerForExtent (int extent[6])
 Access the native pointer for the scalar data. More...
 
virtual void * GetScalarPointer (int coordinates[3])
 
virtual void * GetScalarPointer (int x, int y, int z)
 
virtual void * GetScalarPointer ()
 
virtual float GetScalarComponentAsFloat (int x, int y, int z, int component)
 For access to data from wrappers. More...
 
virtual void SetScalarComponentFromFloat (int x, int y, int z, int component, float v)
 
virtual double GetScalarComponentAsDouble (int x, int y, int z, int component)
 
virtual void SetScalarComponentFromDouble (int x, int y, int z, int component, double v)
 
virtual void AllocateScalars (int dataType, int numComponents)
 Allocate the point scalars for this dataset. More...
 
virtual void AllocateScalars (vtkInformation *pipeline_info)
 Allocate the point scalars for this dataset. More...
 
virtual void CopyAndCastFrom (vtkImageData *inData, int extent[6])
 This method is passed a input and output region, and executes the filter algorithm to fill the output from the input. More...
 
virtual void CopyAndCastFrom (vtkImageData *inData, int x0, int x1, int y0, int y1, int z0, int z1)
 
void Crop (const int *updateExtent) override
 Reallocates and copies to set the Extent to updateExtent. More...
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
virtual doubleGetSpacing ()
 Set the spacing (width,height,length) of the cubical cells that compose the data set. More...
 
virtual void GetSpacing (double &, double &, double &)
 
virtual void GetSpacing (double[3])
 
virtual void SetSpacing (double i, double j, double k)
 
virtual void SetSpacing (const double ijk[3])
 
virtual doubleGetOrigin ()
 Set/Get the origin of the dataset. More...
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
virtual void SetOrigin (double i, double j, double k)
 
virtual void SetOrigin (const double ijk[3])
 
virtual vtkMatrix3x3GetDirectionMatrix ()
 Set/Get the direction transform of the dataset. More...
 
virtual void SetDirectionMatrix (vtkMatrix3x3 *m)
 
virtual void SetDirectionMatrix (const double elements[9])
 
virtual void SetDirectionMatrix (double e00, double e01, double e02, double e10, double e11, double e12, double e20, double e21, double e22)
 
virtual vtkMatrix4x4GetIndexToPhysicalMatrix ()
 Get the transformation matrix from the index space to the physical space coordinate system of the dataset. More...
 
virtual void TransformContinuousIndexToPhysicalPoint (double i, double j, double k, double xyz[3])
 Convert coordinates from index space (ijk) to physical space (xyz) More...
 
virtual void TransformContinuousIndexToPhysicalPoint (const double ijk[3], double xyz[3])
 
virtual void TransformIndexToPhysicalPoint (int i, int j, int k, double xyz[3])
 
virtual void TransformIndexToPhysicalPoint (const int ijk[3], double xyz[3])
 
virtual vtkMatrix4x4GetPhysicalToIndexMatrix ()
 Get the transformation matrix from the physical space to the index space coordinate system of the dataset. More...
 
virtual void TransformPhysicalPointToContinuousIndex (double x, double y, double z, double ijk[3])
 Convert coordinates from physical space (xyz) to index space (ijk) More...
 
virtual void TransformPhysicalPointToContinuousIndex (const double xyz[3], double ijk[3])
 
virtual void TransformPhysicalNormalToContinuousIndex (const double xyz[3], double ijk[3])
 Convert normal from physical space (xyz) to index space (ijk) More...
 
virtual void TransformPhysicalPlaneToContinuousIndex (double const pplane[4], double iplane[4])
 Convert a plane form physical to continuous index. More...
 
int GetScalarType ()
 
const char * GetScalarTypeAsString ()
 
int GetNumberOfScalarComponents ()
 
void CopyInformationFromPipeline (vtkInformation *information) override
 Override these to handle origin, spacing, scalar type, and scalar number of components. More...
 
void CopyInformationToPipeline (vtkInformation *information) override
 Copy information from this data object to the pipeline information. More...
 
void PrepareForNewData () override
 make the output data ready for new data to be inserted. More...
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void DeepCopy (vtkDataObject *src) override
 
void * GetArrayPointerForExtent (vtkDataArray *array, int extent[6])
 These are convenience methods for getting a pointer from any filed array. More...
 
void * GetArrayPointer (vtkDataArray *array, int coordinates[3])
 
void GetArrayIncrements (vtkDataArray *array, vtkIdType increments[3])
 Since various arrays have different number of components, the will have different increments. More...
 
void ComputeInternalExtent (int *intExt, int *tgtExt, int *bnds)
 Given how many pixel are required on a side for bounrary conditions (in bnds), the target extent to traverse, compute the internal extent (the extent for this ImageData that does not suffer from any boundary conditions) and place it in intExt. More...
 
int GetExtentType () override
 The extent type is a 3D extent. More...
 
- Public Member Functions inherited from vtkDataSet
vtkDataSetNewInstance () const
 
virtual void CopyAttributes (vtkDataSet *ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet. More...
 
virtual vtkCellIteratorNewCellIterator ()
 Return an iterator that traverses the cells in this data set. More...
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCellTypes (vtkCellTypes *types)
 Get a list of types of cells in a dataset. More...
 
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). More...
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x. More...
 
vtkMTimeType GetMTime () override
 Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE. More...
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data. More...
 
vtkPointDataGetPointData ()
 Return a pointer to this dataset's point data. More...
 
virtual void Squeeze ()
 Reclaim any extra memory used to store data. More...
 
doubleGetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
doubleGetCenter ()
 Get the center of the bounding box. More...
 
void GetCenter (double center[3])
 Get the center of the bounding box. More...
 
double GetLength ()
 Return the length of the diagonal of the bounding box. More...
 
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. More...
 
doubleGetScalarRange ()
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. More...
 
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry. More...
 
virtual void GenerateGhostArray (int zeroExt[6])
 Normally called by pipeline executives or algorithms only. More...
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData. More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
 
bool HasAnyGhostCells ()
 Returns 1 if there are any ghost cells 0 otherwise. More...
 
bool HasAnyGhostPoints ()
 Returns 1 if there are any ghost points 0 otherwise. More...
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point. More...
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array. More...
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points. More...
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell. More...
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array. More...
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells. More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object. More...
 
virtual void SetInformation (vtkInformation *)
 
void ReleaseData ()
 Release data back to system to conserve memory resource. More...
 
virtual int GetDataReleased ()
 Get the flag indicating the data has been released. More...
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object. More...
 
virtual vtkFieldDataGetFieldData ()
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information. More...
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information. More...
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data. More...
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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 vtkUniformGridNew ()
 Construct an empty uniform grid. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUniformGridSafeDownCast (vtkObjectBase *o)
 
static vtkUniformGridGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkUniformGridGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkImageData
static vtkImageDataNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageDataSafeDownCast (vtkObjectBase *o)
 
static void TransformContinuousIndexToPhysicalPoint (double i, double j, double k, double const origin[3], double const spacing[3], double const direction[9], double xyz[3])
 
static void ComputeIndexToPhysicalMatrix (double const origin[3], double const spacing[3], double const direction[9], double result[16])
 
static void SetScalarType (int, vtkInformation *meta_data)
 
static int GetScalarType (vtkInformation *meta_data)
 
static bool HasScalarType (vtkInformation *meta_data)
 
static void SetNumberOfScalarComponents (int n, vtkInformation *meta_data)
 Set/Get the number of scalar components for points. More...
 
static int GetNumberOfScalarComponents (vtkInformation *meta_data)
 
static bool HasNumberOfScalarComponents (vtkInformation *meta_data)
 
static vtkImageDataGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkImageDataGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
static int GetGlobalReleaseDataFlag ()
 
static vtkInformationGetActiveFieldInformation (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) More...
 
static vtkInformationGetNamedFieldInformation (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. More...
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array. More...
 
static vtkInformationSetActiveAttribute (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). More...
 
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). More...
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. More...
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static int GetAssociationTypeFromString (const char *associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
- 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
 
 vtkUniformGrid ()
 
 ~vtkUniformGrid () override
 
void GetCellDims (int cellDims[3])
 Returns the cell dimensions for this vtkUniformGrid instance. More...
 
void ComputeScalarRange () override
 Override this method because of blanking. More...
 
vtkEmptyCellGetEmptyCell ()
 
- Protected Member Functions inherited from vtkImageData
 vtkImageData ()
 
 ~vtkImageData () override
 
void ComputeIncrements ()
 
void ComputeIncrements (int numberOfComponents)
 
void ComputeIncrements (vtkDataArray *scalars)
 
void ComputeIncrements (vtkIdType inc[3])
 
void ComputeIncrements (int numberOfComponents, vtkIdType inc[3])
 
void ComputeIncrements (vtkDataArray *scalars, vtkIdType inc[3])
 
void ComputeTransforms ()
 
vtkCellGetCellTemplateForDataDescription ()
 
bool GetCellTemplateForDataDescription (vtkGenericCell *cell)
 
bool GetIJKMinForCellId (vtkIdType cellId, int ijkMin[3])
 
bool GetIJKMaxForIJKMin (int ijkMin[3], int ijkMax[3])
 
void AddPointsToCellTemplate (vtkCell *cell, int ijkMin[3], int ijkMax[3])
 
void SetDataDescription (int desc)
 
int GetDataDescription ()
 
- Protected Member Functions inherited from vtkDataSet
 vtkDataSet ()
 
 ~vtkDataSet () override
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 Helper function that tests if any of the values in 'a' have bitFlag set. More...
 
- Protected Member Functions inherited from vtkDataObject
 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. 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkImageData
int Dimensions [3]
 
vtkIdType Increments [3]
 
double Origin [3]
 
double Spacing [3]
 
vtkMatrix3x3DirectionMatrix
 
vtkMatrix4x4IndexToPhysicalMatrix
 
vtkMatrix4x4PhysicalToIndexMatrix
 
int Extent [6]
 
vtkTimeStamp ExtentComputeTime
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) More...
 
vtkUnsignedCharArrayCellGhostArray
 
bool PointGhostArrayCached
 
bool CellGhostArrayCached
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

image data with blanking

vtkUniformGrid is a subclass of vtkImageData. In addition to all the image data functionality, it supports blanking.

Examples:
vtkUniformGrid (Examples)
Tests:
vtkUniformGrid (Tests)

Definition at line 40 of file vtkUniformGrid.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkUniformGrid.h.

Constructor & Destructor Documentation

◆ vtkUniformGrid()

vtkUniformGrid::vtkUniformGrid ( )
protected

◆ ~vtkUniformGrid()

vtkUniformGrid::~vtkUniformGrid ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkUniformGrid* vtkUniformGrid::New ( )
static

Construct an empty uniform grid.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkUniformGrid::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 vtkImageData.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkUniformGrid::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageData.

◆ NewInstance()

vtkUniformGrid* vtkUniformGrid::NewInstance ( ) const

◆ PrintSelf()

void vtkUniformGrid::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 vtkImageData.

◆ CopyStructure()

void vtkUniformGrid::CopyStructure ( vtkDataSet ds)
overridevirtual

Copy the geometric and topological structure of an input image data object.

Reimplemented from vtkImageData.

◆ GetDataObjectType()

int vtkUniformGrid::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkImageData.

Definition at line 61 of file vtkUniformGrid.h.

◆ GetCell() [1/3]

vtkCell* vtkUniformGrid::GetCell ( int  i,
int  j,
int  k 
)
override

Standard vtkDataSet API methods.

See vtkDataSet for more information.

◆ GetCell() [2/3]

vtkCell* vtkUniformGrid::GetCell ( vtkIdType  cellId)
overridevirtual

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

THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkImageData.

◆ GetCell() [3/3]

void vtkUniformGrid::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
overridevirtual

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

Reimplemented from vtkImageData.

◆ FindCell() [1/2]

vtkIdType vtkUniformGrid::FindCell ( double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int subId,
double  pcoords[3],
double weights 
)
overridevirtual

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.

Reimplemented from vtkImageData.

◆ FindCell() [2/2]

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

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

Reimplemented from vtkImageData.

◆ FindAndGetCell()

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

Locate the cell that contains a point and return the cell.

Also returns the subcell id, parametric coordinates and weights for subsequent interpolation. This method combines the derived class methods int FindCell and vtkCell *GetCell. Derived classes may provide a more efficient implementation. See for example vtkStructuredPoints. THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkImageData.

◆ GetCellType()

int vtkUniformGrid::GetCellType ( vtkIdType  cellId)
overridevirtual

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

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

Reimplemented from vtkImageData.

◆ GetCellPoints()

void vtkUniformGrid::GetCellPoints ( vtkIdType  cellId,
vtkIdList ptIds 
)
inlineoverridevirtual

Topological inquiry to get points defining cell.

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

Reimplemented from vtkImageData.

Definition at line 82 of file vtkUniformGrid.h.

◆ GetPointCells()

void vtkUniformGrid::GetPointCells ( vtkIdType  ptId,
vtkIdList cellIds 
)
inlineoverridevirtual

Topological inquiry to get cells using point.

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

Reimplemented from vtkImageData.

Definition at line 85 of file vtkUniformGrid.h.

◆ Initialize() [1/5]

void vtkUniformGrid::Initialize ( )
overridevirtual

Restore data object to initial state.

Reimplemented from vtkImageData.

◆ GetMaxCellSize()

int vtkUniformGrid::GetMaxCellSize ( )
inlineoverridevirtual

Convenience method returns largest cell size in dataset.

This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE

Reimplemented from vtkImageData.

Definition at line 88 of file vtkUniformGrid.h.

◆ GetGridDescription()

int vtkUniformGrid::GetGridDescription ( )

Returns the data description of this uniform grid instance.

◆ Initialize() [2/5]

int vtkUniformGrid::Initialize ( const vtkAMRBox def,
double origin,
double spacing 
)

Initialize with no ghost cell arrays, from the definition in the given box.

The box is expetced to be 3D, if you have 2D data the set the third dimensions 0. eg. (X,X,0)(X,X,0) Returns 0 if the initialization failed.

◆ Initialize() [3/5]

int vtkUniformGrid::Initialize ( const vtkAMRBox def,
double origin,
double spacing,
int  nGhosts 
)

Initialize from the definition in the given box, with ghost cell arrays nGhosts cells thick in all directions.

The box is expetced to be 3D, if you have 2D data the set the third dimensions 0. eg. (X,X,0)(X,X,0) Returns 0 if the initialization failed.

◆ Initialize() [4/5]

int vtkUniformGrid::Initialize ( const vtkAMRBox def,
double origin,
double spacing,
const int  nGhosts[3] 
)

Initialize from the definition in the given box, with ghost cell arrays of the thickness given in each direction by "nGhosts" array.

The box and ghost array are expected to be 3D, if you have 2D data the set the third dimensions 0. eg. (X,X,0)(X,X,0) Returns 0 if the initialization failed.

◆ Initialize() [5/5]

int vtkUniformGrid::Initialize ( const vtkAMRBox def,
double origin,
double spacing,
int  nGhostsI,
int  nGhostsJ,
int  nGhostsK 
)

Construct a uniform grid, from the definition in the given box "def", with ghost cell arrays of the thickness given in each direction by "nGhosts*".

The box and ghost array are expected to be 3D, if you have 2D data the set the third dimensions 0. eg. (X,X,0)(X,X,0) Returns 0 if the initialization failed.

◆ BlankPoint() [1/2]

virtual void vtkUniformGrid::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 vtkUniformGrid::UnBlankPoint ( vtkIdType  ptId)
virtual

◆ BlankPoint() [2/2]

virtual void vtkUniformGrid::BlankPoint ( const int  i,
const int  j,
const int  k 
)
virtual

◆ UnBlankPoint() [2/2]

virtual void vtkUniformGrid::UnBlankPoint ( const int  i,
const int  j,
const int  k 
)
virtual

◆ BlankCell() [1/2]

virtual void vtkUniformGrid::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 vtkUniformGrid::UnBlankCell ( vtkIdType  ptId)
virtual

◆ BlankCell() [2/2]

virtual void vtkUniformGrid::BlankCell ( const int  i,
const int  j,
const int  k 
)
virtual

◆ UnBlankCell() [2/2]

virtual void vtkUniformGrid::UnBlankCell ( const int  i,
const int  j,
const int  k 
)
virtual

◆ HasAnyBlankCells()

bool vtkUniformGrid::HasAnyBlankCells ( )
overridevirtual

Returns 1 if there is any visibility constraint on the cells, 0 otherwise.

Reimplemented from vtkDataSet.

◆ HasAnyBlankPoints()

bool vtkUniformGrid::HasAnyBlankPoints ( )
overridevirtual

Returns 1 if there is any visibility constraint on the points, 0 otherwise.

Reimplemented from vtkDataSet.

◆ IsPointVisible()

virtual unsigned char vtkUniformGrid::IsPointVisible ( vtkIdType  ptId)
virtual

Return non-zero value if specified point is visible.

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

◆ IsCellVisible()

virtual unsigned char vtkUniformGrid::IsCellVisible ( vtkIdType  cellId)
virtual

Return non-zero value if specified cell is visible.

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

◆ NewImageDataCopy()

virtual vtkImageData* vtkUniformGrid::NewImageDataCopy ( )
virtual

◆ GetData() [1/2]

static vtkUniformGrid* vtkUniformGrid::GetData ( vtkInformation info)
static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

static vtkUniformGrid* vtkUniformGrid::GetData ( vtkInformationVector v,
int  i = 0 
)
static

◆ GetCellDims()

void vtkUniformGrid::GetCellDims ( int  cellDims[3])
protected

Returns the cell dimensions for this vtkUniformGrid instance.

◆ ComputeScalarRange()

void vtkUniformGrid::ComputeScalarRange ( )
overrideprotectedvirtual

Override this method because of blanking.

Reimplemented from vtkDataSet.

◆ GetEmptyCell()

vtkEmptyCell* vtkUniformGrid::GetEmptyCell ( )
protected

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