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

abstract class to specify dataset behavior More...

#include <vtkDataSet.h>

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

Public Types

enum  FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }
 
typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
 
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
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void CopyStructure (vtkDataSet *ds)=0
 
virtual void CopyAttributes (vtkDataSet *ds)
 
virtual vtkIdType GetNumberOfPoints ()=0
 
virtual vtkIdType GetNumberOfCells ()=0
 
virtual double * GetPoint (vtkIdType ptId)=0
 
virtual void GetPoint (vtkIdType id, double x[3])
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
 
virtual void GetCellBounds (vtkIdType cellId, double bounds[6])
 
virtual int GetCellType (vtkIdType cellId)=0
 
virtual void GetCellTypes (vtkCellTypes *types)
 
virtual void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0
 
virtual void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0
 
unsigned long int GetMTime ()
 
vtkCellDataGetCellData ()
 
vtkPointData * GetPointData ()
 
virtual void Squeeze ()
 
virtual void ComputeBounds ()
 
double * GetBounds ()
 
void GetBounds (double bounds[6])
 
double * GetCenter ()
 
void GetCenter (double center[3])
 
double GetLength ()
 
void Initialize ()
 
virtual void GetScalarRange (double range[2])
 
double * GetScalarRange ()
 
virtual int GetMaxCellSize ()=0
 
unsigned long GetActualMemorySize ()
 
int CheckAttributes ()
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
 
vtkIdType FindPoint (double x, double y, double z)
 
virtual vtkIdType FindPoint (double x[3])=0
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
 
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
int GetDataObjectType ()
 
void ShallowCopy (vtkDataObject *src)
 
void DeepCopy (vtkDataObject *src)
 
virtual void GenerateGhostLevelArray (int update_piece, int update_num_pieces, int update_ghost_level, int *whole_extent, vtkExtentTranslator *translator)
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributesGetAttributes (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldDataGetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static
vtkInformationDataObjectKey
DATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static
vtkInformationIntegerPointerKey
DATA_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_RESOLUTION ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static
vtkInformationInformationVectorKey
POINT_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
CELL_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
VERTEX_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
EDGE_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
vtkInformationDoubleVectorKey
FIELD_RANGE ()
 
static
vtkInformationDoubleVectorKey
PIECE_FIELD_RANGE ()
 
static vtkInformationStringKeyFIELD_ARRAY_NAME ()
 
static
vtkInformationIntegerVectorKey
PIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static
vtkInformationDoubleVectorKey
ORIGIN ()
 
static
vtkInformationDoubleVectorKey
SPACING ()
 
static vtkInformationIntegerKeyDATA_GEOMETRY_UNMODIFIED ()
 
static
vtkInformationDoubleVectorKey
BOUNDING_BOX ()
 
static
vtkInformationDataObjectKey
SIL ()
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 
static vtkDataObjectGetData (vtkInformation *info)
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataSet ()
 
 ~vtkDataSet ()
 
virtual void ComputeScalarRange ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkCellDataCellData
 
vtkPointData * PointData
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkImageAlgorithmToDataSetFriendship
 

Detailed Description

abstract class to specify dataset behavior

vtkDataSet is an abstract class that specifies an interface for dataset objects. vtkDataSet also provides methods to provide informations about the data, such as center, bounding box, and representative length.

In vtk a dataset consists of a structure (geometry and topology) and attribute data. The structure is defined implicitly or explicitly as a collection of cells. The geometry of the structure is contained in point coordinates plus the cell interpolation functions. The topology of the dataset structure is defined by cell types and how the cells share their defining points.

Attribute data in vtk is either point data (data at points) or cell data (data at cells). Typically filters operate on point data, but some may operate on cell data, both cell and point data, either one, or none.

See Also
vtkPointSet vtkStructuredPoints vtkStructuredGrid vtkUnstructuredGrid vtkRectilinearGrid vtkPolyData vtkPointData vtkCellData vtkDataObject vtkFieldData
Examples:
vtkDataSet (Examples)
Tests:
vtkDataSet (Tests)

Definition at line 59 of file vtkDataSet.h.

Member Typedef Documentation

Definition at line 62 of file vtkDataSet.h.

Member Enumeration Documentation

Enumerator
DATA_OBJECT_FIELD 
POINT_DATA_FIELD 
CELL_DATA_FIELD 

Definition at line 284 of file vtkDataSet.h.

Constructor & Destructor Documentation

vtkDataSet::vtkDataSet ( )
protected
vtkDataSet::~vtkDataSet ( )
protected

Member Function Documentation

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

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

Reimplemented from vtkDataObject.

vtkDataSet* vtkDataSet::NewInstance ( ) const
void vtkDataSet::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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

virtual void vtkDataSet::CopyStructure ( vtkDataSet ds)
pure virtual

Copy the geometric and topological structure of an object. Note that the invoking object and the object pointed to by the parameter ds must be of the same type. THIS METHOD IS NOT THREAD SAFE.

virtual void vtkDataSet::CopyAttributes ( vtkDataSet ds)
virtual

Copy the attributes associated with the specified dataset to this instance of vtkDataSet. THIS METHOD IS NOT THREAD SAFE.

virtual vtkIdType vtkDataSet::GetNumberOfPoints ( )
pure virtual

Determine the number of points composing the dataset. THIS METHOD IS THREAD SAFE

virtual vtkIdType vtkDataSet::GetNumberOfCells ( )
pure virtual

Determine the number of cells composing the dataset. THIS METHOD IS THREAD SAFE

virtual double* vtkDataSet::GetPoint ( vtkIdType  ptId)
pure virtual

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.

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

Definition at line 359 of file vtkDataSet.h.

virtual vtkCell* vtkDataSet::GetCell ( vtkIdType  cellId)
pure virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS NOT THREAD SAFE.

virtual void vtkDataSet::GetCell ( vtkIdType  cellId,
vtkGenericCell *  cell 
)
pure 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

virtual void vtkDataSet::GetCellBounds ( vtkIdType  cellId,
double  bounds[6] 
)
virtual

Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. A subclass may be able to determine the bounds of cell without using an expensive GetCell() method. A default implementation is provided that actually uses a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

virtual int vtkDataSet::GetCellType ( vtkIdType  cellId)
pure virtual

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

virtual void vtkDataSet::GetCellTypes ( vtkCellTypes types)
virtual

Get a list of types of cells in a dataset. The list consists of an array of types (not necessarily in any order), with a single entry per type. For example a dataset 5 triangles, 3 lines, and 100 hexahedra would result a list of three entries, corresponding to the types VTK_TRIANGLE, VTK_LINE, and VTK_HEXAHEDRON. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

virtual void vtkDataSet::GetCellPoints ( vtkIdType  cellId,
vtkIdList ptIds 
)
pure virtual

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

virtual void vtkDataSet::GetPointCells ( vtkIdType  ptId,
vtkIdList cellIds 
)
pure virtual

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

virtual void vtkDataSet::GetCellNeighbors ( vtkIdType  cellId,
vtkIdList ptIds,
vtkIdList cellIds 
)
virtual

Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). Note that the list consists of only cells that use ALL the points provided. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

vtkIdType vtkDataSet::FindPoint ( double  x,
double  y,
double  z 
)
inline

Locate the closest point to the global coordinate x. Return the point id. If point id < 0; then no point found. (This may arise when point is outside of dataset.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Definition at line 149 of file vtkDataSet.h.

virtual vtkIdType vtkDataSet::FindPoint ( double  x[3])
pure virtual

Locate the closest point to the global coordinate x. Return the point id. If point id < 0; then no point found. (This may arise when point is outside of dataset.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

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

Locate cell based on global coordinate x and tolerance squared. If cell and cellId is non-NULL, 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.

virtual vtkIdType vtkDataSet::FindCell ( double  x[3],
vtkCell cell,
vtkGenericCell *  gencell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  weights 
)
pure 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

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

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.

unsigned long int vtkDataSet::GetMTime ( )
virtual

Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE

Reimplemented from vtkDataObject.

vtkCellData* vtkDataSet::GetCellData ( )
inline

Return a pointer to this dataset's cell data. THIS METHOD IS THREAD SAFE

Definition at line 202 of file vtkDataSet.h.

vtkPointData* vtkDataSet::GetPointData ( )
inline

Return a pointer to this dataset's point data. THIS METHOD IS THREAD SAFE

Definition at line 206 of file vtkDataSet.h.

virtual void vtkDataSet::Squeeze ( )
virtual

Reclaim any extra memory used to store data. THIS METHOD IS NOT THREAD SAFE.

virtual void vtkDataSet::ComputeBounds ( )
virtual

Compute the data bounding box from data points. THIS METHOD IS NOT THREAD SAFE.

double* vtkDataSet::GetBounds ( )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). THIS METHOD IS NOT THREAD SAFE.

void vtkDataSet::GetBounds ( double  bounds[6])

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

double* vtkDataSet::GetCenter ( )

Get the center of the bounding box. THIS METHOD IS NOT THREAD SAFE.

void vtkDataSet::GetCenter ( double  center[3])

Get the center of the bounding box. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

double vtkDataSet::GetLength ( )

Return the length of the diagonal of the bounding box. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

void vtkDataSet::Initialize ( )
virtual

Restore data object to initial state. THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataObject.

virtual void vtkDataSet::GetScalarRange ( double  range[2])
virtual

Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. If the data has both point data and cell data, it returns the (min/max) range of combined point and cell data. If there are no point or cell scalars the method will return (0,1). Note: It might be necessary to call Update to create or refresh the scalars before calling this method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

double* vtkDataSet::GetScalarRange ( )

Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. If the data has both point data and cell data, it returns the (min/max) range of combined point and cell data. If there are no point or cell scalars the method will return (0,1). Note: It might be necessary to call Update to create or refresh the scalars before calling this method. THIS METHOD IS NOT THREAD SAFE.

virtual int vtkDataSet::GetMaxCellSize ( )
pure virtual

Convenience method returns largest cell size in dataset. This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE

unsigned long vtkDataSet::GetActualMemorySize ( )
virtual

Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value). THIS METHOD IS THREAD SAFE.

Reimplemented from vtkDataObject.

int vtkDataSet::GetDataObjectType ( )
inlinevirtual

Return the type of data object.

Reimplemented from vtkDataObject.

Definition at line 273 of file vtkDataSet.h.

void vtkDataSet::ShallowCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

void vtkDataSet::DeepCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

int vtkDataSet::CheckAttributes ( )

This method checks to see if the cell and point attributes match the geometry. Many filters will crash if the number of tupples in an array is less than the number of points/cells. This method returns 1 if there is a mismatch, and 0 if everything is ok. It prints an error if an array is too short, and a warning if an array is too long.

virtual void vtkDataSet::GenerateGhostLevelArray ( int  update_piece,
int  update_num_pieces,
int  update_ghost_level,
int *  whole_extent,
vtkExtentTranslator translator 
)
virtual

Normally called by pipeline executives or algoritgms only. This method computes the ghost arrays for a given dataset.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

virtual vtkFieldData* vtkDataSet::GetAttributesAsFieldData ( int  type)
virtual

Returns the attributes of the data object as a vtkFieldData. This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.

Reimplemented from vtkDataObject.

virtual vtkIdType vtkDataSet::GetNumberOfElements ( int  type)
virtual

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

Reimplemented from vtkDataObject.

virtual void vtkDataSet::ComputeScalarRange ( )
protectedvirtual

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

Friends And Related Function Documentation

friend class vtkImageAlgorithmToDataSetFriendship
friend

Definition at line 352 of file vtkDataSet.h.

Member Data Documentation

vtkCellData* vtkDataSet::CellData
protected

Definition at line 337 of file vtkDataSet.h.

vtkPointData* vtkDataSet::PointData
protected

Definition at line 338 of file vtkDataSet.h.

vtkTimeStamp vtkDataSet::ComputeTime
protected

Definition at line 339 of file vtkDataSet.h.

double vtkDataSet::Bounds[6]
protected

Definition at line 340 of file vtkDataSet.h.

double vtkDataSet::Center[3]
protected

Definition at line 341 of file vtkDataSet.h.

double vtkDataSet::ScalarRange[2]
protected

Definition at line 344 of file vtkDataSet.h.

vtkTimeStamp vtkDataSet::ScalarRangeComputeTime
protected

Definition at line 347 of file vtkDataSet.h.


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