`vtkmodules.util.data_model`#

This module provides classes that allow numpy style access to VTK datasets. See examples at bottom.

Module Contents#

Classes#

`FieldDataBase`
`FieldData`
`DataSetAttributesBase`
`DataSetAttributes`
`PointData`
`CellData`
`CompositeDataSetAttributesIterator`
`CompositeDataSetAttributes`	This is a python friendly wrapper for vtkDataSetAttributes for composite datasets. Since composite datasets themselves don’t have attribute data, but the attribute data is associated with the leaf nodes in the composite dataset, this class simulates a DataSetAttributes interface by taking a union of DataSetAttributes associated with all leaf nodes.
`DataSet`
`PointSet`
`UnstructuredGrid`
`ImageData`
`PolyData`
`RectilinearGrid`
`CompositeDataIterator`	Wrapper for a vtkCompositeDataIterator class to satisfy the python iterator protocol. This iterator iterates over non-empty leaf nodes. To iterate over empty or non-leaf nodes, use the vtkCompositeDataIterator directly.
`CompositeDataSetBase`	A wrapper for vtkCompositeData and subclasses that makes it easier to access Point/Cell/Field data as VTKCompositeDataArrays. It also provides a Python type iterator.
`PartitionedDataSet`
`PartitionedDataSetCollection`
`OverlappingAMR`
`MultiBlockDataSet`
`StructuredGrid`

Data#

NUMPY_AVAILABLE

API#

vtkmodules.util.data_model.NUMPY_AVAILABLE#: False

class vtkmodules.util.data_model.FieldDataBase#

Bases: object

Initialization

__getitem__(idx)#: Implements the [] operator. Accepts an array name or index.

__setitem__(name, value)#: Implements the [] operator. Accepts an array name or index.

get_array(idx)#: Given an index or name, returns a VTKArray.

__contains__(aname)#: Returns true if the container contains arrays with the given name, false otherwise

keys()#: Returns the names of the arrays as a list.

values()#: Returns the arrays as a tuple.

items()#: Returns a tuple of pairs (name, array)

set_array(name, narray)#: Appends a new array to the dataset attributes.

__eq__(other: object) → bool#: Test dict-like equivalency.

__iter__()#

__len__()#

class vtkmodules.util.data_model.FieldData#

Bases: vtkmodules.util.data_model.FieldDataBase, vtkmodules.vtkCommonDataModel.vtkFieldData

Initialization

class vtkmodules.util.data_model.DataSetAttributesBase#

Bases: vtkmodules.util.data_model.FieldDataBase

Initialization

class vtkmodules.util.data_model.DataSetAttributes#

Bases: vtkmodules.util.data_model.DataSetAttributesBase, vtkmodules.vtkCommonDataModel.vtkDataSetAttributes

Initialization

__eq__(other: object) → bool#: Test dict-like equivalency.

class vtkmodules.util.data_model.PointData#

Bases: vtkmodules.util.data_model.DataSetAttributesBase, vtkmodules.vtkCommonDataModel.vtkPointData

Initialization

class vtkmodules.util.data_model.CellData#

Bases: vtkmodules.util.data_model.DataSetAttributesBase, vtkmodules.vtkCommonDataModel.vtkCellData

Initialization

class vtkmodules.util.data_model.CompositeDataSetAttributesIterator(cdsa)#

Bases: object

Initialization

__iter__()#

__next__()#

next()#

class vtkmodules.util.data_model.CompositeDataSetAttributes(dataset, association)#

Bases: object

This is a python friendly wrapper for vtkDataSetAttributes for composite datasets. Since composite datasets themselves don’t have attribute data, but the attribute data is associated with the leaf nodes in the composite dataset, this class simulates a DataSetAttributes interface by taking a union of DataSetAttributes associated with all leaf nodes.

Initialization

__determine_arraynames()#

modified()#: Rescans the contained dataset to update the internal list of arrays.

__contains__(aname)#: Returns true if the container contains arrays with the given name, false otherwise

keys()#: Returns the names of the arrays as a tuple.

values()#: Returns all the arrays as a tuple.

items()#: Returns (name, array) pairs as a tuple.

__getitem__(idx)#: Implements the [] operator. Accepts an array name.

__setitem__(name, narray)#: Implements the [] operator. Accepts an array name.

set_array(name, narray)#: Appends a new array to the composite dataset attributes.

get_array(idx)#: Given a name, returns a VTKCompositeArray.

__iter__()#: Iterators on keys

__len__()#

class vtkmodules.util.data_model.DataSet(**kwargs)#

Bases: object

Initialization

property point_data#

property cell_data#

property field_data#

__eq__(other: object) → bool#: Test equivalency between data objects.

convert_to_unstructured_grid()#

class vtkmodules.util.data_model.PointSet(**kwargs)#

Bases: vtkmodules.util.data_model.DataSet

Initialization

property points#

class vtkmodules.util.data_model.UnstructuredGrid(**kwargs)#

Bases: vtkmodules.util.data_model.PointSet, vtkmodules.vtkCommonDataModel.vtkUnstructuredGrid

Initialization

property cells#

class vtkmodules.util.data_model.ImageData(**kwargs)#

Bases: vtkmodules.util.data_model.DataSet, vtkmodules.vtkCommonDataModel.vtkImageData

Initialization

class vtkmodules.util.data_model.PolyData(**kwargs)#

Bases: vtkmodules.util.data_model.PointSet, vtkmodules.vtkCommonDataModel.vtkPolyData

Initialization

property verts_arrays#

property lines_arrays#

property strips_arrays#

property polys_arrays#

class vtkmodules.util.data_model.RectilinearGrid(**kwargs)#

Bases: vtkmodules.util.data_model.DataSet, vtkmodules.vtkCommonDataModel.vtkRectilinearGrid

Initialization

property x_coordinates#

property y_coordinates#

property z_coordinates#

class vtkmodules.util.data_model.CompositeDataIterator(cds)#

Bases: object

Wrapper for a vtkCompositeDataIterator class to satisfy the python iterator protocol. This iterator iterates over non-empty leaf nodes. To iterate over empty or non-leaf nodes, use the vtkCompositeDataIterator directly.

Initialization

__iter__()#

__next__()#

next()#

__getattr__(name)#: Returns attributes from the vtkCompositeDataIterator.

class vtkmodules.util.data_model.CompositeDataSetBase(**kwargs)#

Bases: object

A wrapper for vtkCompositeData and subclasses that makes it easier to access Point/Cell/Field data as VTKCompositeDataArrays. It also provides a Python type iterator.

Initialization

__iter__()#: Creates an iterator for the contained datasets.

get_attributes(type)#: Returns the attributes specified by the type as a CompositeDataSetAttributes instance.

property point_data#: Returns the point data as a DataSetAttributes instance.

property cell_data#: Returns the cell data as a DataSetAttributes instance.

property field_data#: Returns the field data as a DataSetAttributes instance.

property points#: Returns the points as a VTKCompositeDataArray instance.

class vtkmodules.util.data_model.PartitionedDataSet(**kwargs)#

Bases: vtkmodules.util.data_model.CompositeDataSetBase, vtkmodules.vtkCommonDataModel.vtkPartitionedDataSet

append(dataset)#

class vtkmodules.util.data_model.PartitionedDataSetCollection(**kwargs)#

Bases: vtkmodules.util.data_model.CompositeDataSetBase, vtkmodules.vtkCommonDataModel.vtkPartitionedDataSetCollection

append(dataset)#

class vtkmodules.util.data_model.OverlappingAMR(**kwargs)#: Bases: vtkmodules.util.data_model.CompositeDataSetBase, vtkmodules.vtkCommonDataModel.vtkOverlappingAMR

class vtkmodules.util.data_model.MultiBlockDataSet(**kwargs)#: Bases: vtkmodules.util.data_model.CompositeDataSetBase, vtkmodules.vtkCommonDataModel.vtkMultiBlockDataSet

class vtkmodules.util.data_model.StructuredGrid(**kwargs)#

Bases: vtkmodules.util.data_model.PointSet, vtkmodules.vtkCommonDataModel.vtkStructuredGrid

Initialization

property x_coordinates#

property y_coordinates#

property z_coordinates#

vtkmodules.util.data_model#

Module Contents#

Classes#

Data#

API#

`vtkmodules.util.data_model`#