pyvtk (version 0.4.74) | index /build/buildd/pyvtk-0.4.74/doc/pyvtk/__init__.py

`PyVTK provides tools for manipulating VTK files in Python.
VtkData - create VTK files from Python / read VTK files to Python`

Package Contents

``

ColorScalars Data DataSet DataSetAttr Field | LookupTable Normals PolyData RectilinearGrid Scalars | StructuredGrid StructuredPoints Tensors TextureCoordinates UnstructuredGrid | Vectors __version__ common

Classes

``

pyvtk.Data.Data(pyvtk.common.Common)
  pyvtk.Data.CellData
  pyvtk.Data.PointData
pyvtk.DataSet.DataSet(pyvtk.common.Common)
  pyvtk.PolyData.PolyData
  pyvtk.RectilinearGrid.RectilinearGrid
  pyvtk.StructuredGrid.StructuredGrid
  pyvtk.StructuredPoints.StructuredPoints
  pyvtk.UnstructuredGrid.UnstructuredGrid
pyvtk.DataSetAttr.DataSetAttr(pyvtk.common.Common)
  pyvtk.ColorScalars.ColorScalars
  pyvtk.Field.Field
  pyvtk.LookupTable.LookupTable
  pyvtk.Normals.Normals
  pyvtk.Scalars.Scalars
  pyvtk.Tensors.Tensors
  pyvtk.TextureCoordinates.TextureCoordinates
  pyvtk.Vectors.Vectors
pyvtk.common.Common
  VtkData

class CellData(Data)
`` | `Usage: CellData(<DataSetAttr instances>) Attributes: data - list of DataSetAttr instances Public methods: get_size() to_string(format = 'ascii') append(<DataSetAttr instance>)`

Method resolution order:
  CellData
  Data
  pyvtk.common.Common

Data and other attributes defined here:

data_type = 'CELL_DATA'

Methods inherited from Data:

__init__(self, *args)

append(self, obj)

get_size(self)

to_string(self, format='ascii')

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class ColorScalars(pyvtk.DataSetAttr.DataSetAttr)
`` | `Holds VTK color scalars. Usage: ColorScalars(<sequence of n-sequences> ,name = <string>) Attributes: scalars name Public methods: get_size() to_string(format = 'ascii')`

Method resolution order:
  ColorScalars
  pyvtk.DataSetAttr.DataSetAttr
  pyvtk.common.Common

Methods defined here:

__init__(self, scalars, name=None)

get_size(self)

to_string(self, format='ascii')

Data and other attributes inherited from pyvtk.DataSetAttr.DataSetAttr:

counters = {}

default_value = 0

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class Field(pyvtk.DataSetAttr.DataSetAttr)
`` | `Holds VTK Field. Usage: Field([<name string>,] arrname_1=<sequence of n_1-sequences>, ..., arrname_k=<sequence of n_k-sequences>) Attributes: data - dictionary of arrays name Public methods: get_size() to_string(format = 'ascii')`

Method resolution order:
  Field
  pyvtk.DataSetAttr.DataSetAttr
  pyvtk.common.Common

Methods defined here:

__init__(self, *args, **kws)

get_size(self)

to_string(self, format='ascii')

Data and other attributes inherited from pyvtk.DataSetAttr.DataSetAttr:

counters = {}

default_value = 0

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class LookupTable(pyvtk.DataSetAttr.DataSetAttr)
`` | `Holds VTK LookupTable. Usage: LookupTable(<sequence of 4-sequences> ,name = <string>) Attributes: table name Public methods: get_size() to_string(format = 'ascii')`

Method resolution order:
  LookupTable
  pyvtk.DataSetAttr.DataSetAttr
  pyvtk.common.Common

Methods defined here:

__init__(self, table, name=None)

get_size(self)

to_string(self, format='ascii')

Data and other attributes inherited from pyvtk.DataSetAttr.DataSetAttr:

counters = {}

default_value = 0

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class Normals(pyvtk.DataSetAttr.DataSetAttr)
`` | `Holds VTK Normals. Usage: Normals(<sequence of 3-tuples> ,name = <string>) Attributes: normals name Public methods: get_size() to_string(format = 'ascii')`

Method resolution order:
  Normals
  pyvtk.DataSetAttr.DataSetAttr
  pyvtk.common.Common

Methods defined here:

__init__(self, normals, name=None)

get_size(self)

to_string(self, format='ascii')

Data and other attributes inherited from pyvtk.DataSetAttr.DataSetAttr:

counters = {}

default_value = 0

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class PointData(Data)
`` | `Usage: PointData(<DataSetAttr instances>) Attributes: data - list of DataSetAttr instances Public methods: get_size() to_string(format = 'ascii') append(<DataSetAttr instance>)`

Method resolution order:
  PointData
  Data
  pyvtk.common.Common

Data and other attributes defined here:

data_type = 'POINT_DATA'

Methods inherited from Data:

__init__(self, *args)

append(self, obj)

get_size(self)

to_string(self, format='ascii')

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class PolyData(pyvtk.DataSet.DataSet)
`` | `Usage: PolyData(<sequence of 3-tuples of points>, vertices = <sequence of sequences> lines = <sequence of sequences>, polygons = <sequence of sequences> triangle_strips = <sequence of sequences>, ) Attributes: points vertices lines polygons triangle_strips Public methods: get_size() get_cell_size() to_string(format = 'ascii') get_points() <DataSetAttr class>(...)`

Method resolution order:
  PolyData
  pyvtk.DataSet.DataSet
  pyvtk.common.Common

Methods defined here:

__init__(self, points, vertices=[], lines=[], polygons=[], triangle_strips=[])

get_cell_size(self)

get_points(self)

to_string(self, format='ascii')

Methods inherited from pyvtk.DataSet.DataSet:

ColorScalars(self, func, name=None)

Field(self, func, name=None, **kws)

LookupTable(self, func, name=None)

Normals(self, func, name=None)

Scalars(self, func, name=None, lookup_table=None)

Tensors(self, func, name=None)

TextureCoordinates(self, func, name=None)

Vectors(self, func, name=None)

get_size(self)

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class RectilinearGrid(pyvtk.DataSet.DataSet)
`` | `Usage: RectilinearGrid(x = <sequence>, y = <sequence>, z = <sequence>) Attributes: x y z dimensions Public methods: get_size() get_cell_size() to_string(format = 'ascii') get_points() <DataSetAttr class>(...)`

Method resolution order:
  RectilinearGrid
  pyvtk.DataSet.DataSet
  pyvtk.common.Common

Methods defined here:

__init__(self, x=None, y=None, z=None)

get_points(self)

to_string(self, format='ascii')

Methods inherited from pyvtk.DataSet.DataSet:

ColorScalars(self, func, name=None)

Field(self, func, name=None, **kws)

LookupTable(self, func, name=None)

Normals(self, func, name=None)

Scalars(self, func, name=None, lookup_table=None)

Tensors(self, func, name=None)

TextureCoordinates(self, func, name=None)

Vectors(self, func, name=None)

get_cell_size(self)

get_size(self)

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class Scalars(pyvtk.DataSetAttr.DataSetAttr)
`` | `Holds VTK scalars. Usage: Scalars(<sequence> ,name = <string>, lookup_table = 'default') Attributes: scalars name lookup_table Public methods: get_size() to_string(format = 'ascii')`

Method resolution order:
  Scalars
  pyvtk.DataSetAttr.DataSetAttr
  pyvtk.common.Common

Methods defined here:

__init__(self, scalars, name=None, lookup_table=None)

get_size(self)

to_string(self, format='ascii')

Data and other attributes inherited from pyvtk.DataSetAttr.DataSetAttr:

counters = {}

default_value = 0

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class StructuredGrid(pyvtk.DataSet.DataSet)
`` | `Usage: StructuredGrid(<3-tuple of dimensions>, <sequence of 3-tuples of points>) Attributes: dimensions points Public methods: get_points() get_size() get_cell_size() to_string(format = 'ascii') get_points() <DataSetAttr class>(...)`

Method resolution order:
  StructuredGrid
  pyvtk.DataSet.DataSet
  pyvtk.common.Common

Methods defined here:

__init__(self, dimensions, points)

get_cell_size(self)

get_points(self)

to_string(self, format='ascii')

Methods inherited from pyvtk.DataSet.DataSet:

ColorScalars(self, func, name=None)

Field(self, func, name=None, **kws)

LookupTable(self, func, name=None)

Normals(self, func, name=None)

Scalars(self, func, name=None, lookup_table=None)

Tensors(self, func, name=None)

TextureCoordinates(self, func, name=None)

Vectors(self, func, name=None)

get_size(self)

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class StructuredPoints(pyvtk.DataSet.DataSet)
`` | `Usage: StructuredPoints(<3-tuple of dimensions>, origin = <3-tuple>, spacing = <3-tuple>) Attributes: dimensions origin spacing Public methods: get_size() get_cell_size() to_string(format = 'ascii') get_points() <DataSetAttr class>(...)`

Method resolution order:
  StructuredPoints
  pyvtk.DataSet.DataSet
  pyvtk.common.Common

Methods defined here:

__init__(self, dimensions, origin=(0, 0, 0), spacing=(1, 1, 1))

get_points(self)

to_string(self, format='ascii')

Methods inherited from pyvtk.DataSet.DataSet:

ColorScalars(self, func, name=None)

Field(self, func, name=None, **kws)

LookupTable(self, func, name=None)

Normals(self, func, name=None)

Scalars(self, func, name=None, lookup_table=None)

Tensors(self, func, name=None)

TextureCoordinates(self, func, name=None)

Vectors(self, func, name=None)

get_cell_size(self)

get_size(self)

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class Tensors(pyvtk.DataSetAttr.DataSetAttr)
`` | `Holds VTK Tensors. Usage: Tensors(<sequence of 3x3-tuples> , name = <string>) Attributes: tensors name Public methods: get_size() to_string(format = 'ascii')`

Method resolution order:
  Tensors
  pyvtk.DataSetAttr.DataSetAttr
  pyvtk.common.Common

Methods defined here:

__init__(self, tensors, name=None)

get_size(self)

to_string(self, format='ascii')

Data and other attributes inherited from pyvtk.DataSetAttr.DataSetAttr:

counters = {}

default_value = 0

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class TextureCoordinates(pyvtk.DataSetAttr.DataSetAttr)
`` | `Holds VTK Texture Coordinates. Usage: TextureCoordinates(<sequence of (1,2, or 3)-sequences> ,name = <string>) Attributes: coords name Public methods: get_size() to_string(format = 'ascii')`

Method resolution order:
  TextureCoordinates
  pyvtk.DataSetAttr.DataSetAttr
  pyvtk.common.Common

Methods defined here:

__init__(self, scalars, name=None)

get_size(self)

to_string(self, format='ascii')

Data and other attributes inherited from pyvtk.DataSetAttr.DataSetAttr:

counters = {}

default_value = 0

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class UnstructuredGrid(pyvtk.DataSet.DataSet)

``

`Usage:
UnstructuredGrid(<sequence of 3-tuples of points>,
vertex = <sequence [of 1-sequences]>
poly_vertex = <sequence of n-sequences>,
line = <sequence of 2-sequences>,
poly_line = <sequence of n-sequences>,
triangle = <sequence of 3-sequences>,
triangle_strip = <sequence of n-sequences>,
polygon = <sequence of n-sequences>,
pixel = <sequence of 4-sequences>,
quad = <sequence of 4-sequences>,
tetra = <sequence of 4-sequences>,
voxel = <sequence of 8-sequences>,
hexahedron = <sequence of 8-sequences>,
wedge = <sequence of 6-sequences>,
pyramid = <sequence of 5-sequences>
)
Attributes:
points
vertex
poly_vertex, line, poly_line, triangle, triangle_strip,
polygon, pixel, quad, tetra, voxel, hexahedron, wedge, pyramid
Public methods:
get_size()
get_cell_size()
to_string(format = 'ascii')
get_points()
<DataSetAttr class>(...)
`

Method resolution order:
  UnstructuredGrid
  pyvtk.DataSet.DataSet
  pyvtk.common.Common

Methods defined here:

__init__(self, points, vertex=[], poly_vertex=[], line=[], poly_line=[], triangle=[], triangle_strip=[], polygon=[], pixel=[], quad=[], tetra=[], voxel=[], hexahedron=[], wedge=[], pyramid=[])

get_cell_size(self)

get_points(self)

to_string(self, format='ascii')

Methods inherited from pyvtk.DataSet.DataSet:

ColorScalars(self, func, name=None)

Field(self, func, name=None, **kws)

LookupTable(self, func, name=None)

Normals(self, func, name=None)

Scalars(self, func, name=None, lookup_table=None)

Tensors(self, func, name=None)

TextureCoordinates(self, func, name=None)

Vectors(self, func, name=None)

get_size(self)

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class Vectors(pyvtk.DataSetAttr.DataSetAttr)
`` | `Holds VTK Vectors. Usage: Vectors(<sequence of 3-tuples> ,name = <string>) Attributes: vectors name Public methods: get_size() to_string(format = 'ascii')`

Method resolution order:
  Vectors
  pyvtk.DataSetAttr.DataSetAttr
  pyvtk.common.Common

Methods defined here:

__init__(self, vectors, name=None)

get_size(self)

to_string(self, format='ascii')

Data and other attributes inherited from pyvtk.DataSetAttr.DataSetAttr:

counters = {}

default_value = 0

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

class VtkData(pyvtk.common.Common)

``

`VtkData
=======
Represents VTK file that has four relevant parts:
header - string up to length 255
format - string: ascii | binary
DataSet - StructuredPoints | StructuredGrid | UnstructuredGrid
| RectilinearGrid | PolyData
Data - PointData | CellData
Usage:
------
v = VtkData(<DataSet instance> [,<header string>,<Data instances>,..])
v = VtkData(<filename>, only_structure = 0) - read VTK data from file.
v.tofile(filename, format = 'ascii') - save VTK data to file.
Attributes:
header
structure
point_data
cell_data
Public methods:
to_string(format = 'ascii')
tofile(filename, format = 'ascii')
DataSet
=======
StructuredPoints(<3-sequence of dimensions>
[,<3-sequence of origin> [, <3-sequence of spacing>]])
StructuredGrid(<3-sequence of dimensions>,
<sequence of 3-sequences of points>)
UnstructuredGrid(<sequence of 3-sequences of points>
[,<cell> = <sequence of (sequences of) integers>])
cell - vertex | poly_vertex | line | poly_line | triangle
| triangle_strip | polygon | pixel | quad | tetra
| voxel | hexahedron | wedge | pyramid
RectilinearGrid([x = <sequence of x-coordinates>],
[y = <sequence of y-coordinates>],
[z = <sequence of z-coordinates>])
PolyData(<sequence of 3-sequences of points>,
[vertices = <sequence of (sequences of) integers>],
[lines = <sequence of (sequences of) integers>],
[polygons = <sequence of (sequences of) integers>],
[triangle_strips = <sequence of (sequences of) integers>])
Data
====
PointData | CellData ([<DataSetAttr instances>]) - construct Data instance
DataSetAttr
===========
DataSetAttr - Scalars | ColorScalars | LookupTable | Vectors
| Normals | TextureCoordinates | Tensors | Field
Scalars(<sequence of scalars> [,name[, lookup_table]])
ColorScalars(<sequence of scalar sequences> [,name])
LookupTable(<sequence of 4-sequences> [,name])
Vectors(<sequence of 3-sequences> [,name])
Normals(<sequence of 3-sequences> [,name])
TextureCoordinates(<sequence of (1,2, or 3)-sequences> [,name])
Tensors(<sequence of (3x3)-sequences> [,name])
Field([name,] [arrayname_1 = sequence of n_1-sequences, ...
arrayname_m = sequence of n_m-sequences,])
where len(array_1) == .. == len(array_m) must hold.
`

Methods defined here:

__init__(self, *args, **kws)

fromfile(self, filename, only_structure=0)

to_string(self, format='ascii')

tofile(self, filename, format='ascii')
  `Save VTK data to file.`

Data and other attributes defined here:

cell_data = None

header = None

point_data = None

Methods inherited from pyvtk.common.Common:

__str__(self)

error(self, m='')

float01_to_int255(self, seq)

get_3_3_tuple(self, obj, default=None)
  `Return tuple of 3-tuples`

get_3_3_tuple_list(self, obj, default=None)
  `Return list of 3x3-tuples.`

get_3_tuple(self, obj, default=None)
  `Return 3-tuple from
  number -> (obj,default[1],default[2])
  0-sequence|None -> default
  1-sequence -> (obj[0],default[1],default[2])
  2-sequence -> (obj[0],obj[1],default[2])
  (3 or more)-sequence -> (obj[0],obj[1],obj[2])`

get_3_tuple_list(self, obj, default=None)
  `Return list of 3-tuples from
  sequence of a sequence,
  sequence - it is mapped to sequence of 3-sequences if possible
  number`

get_datatype(self, obj)

get_n_seq_seq(self, obj, default)

get_seq(self, obj, default=None)
  `Return sequence.`

get_seq_seq(self, obj, default=None)
  `Return sequence of sequences.`

int255_to_float01(self, seq)

message(self, m='')

seq_to_string(self, seq, format, datatype)

skipping(self, m='')

warning(self, m='')

Data and other attributes inherited from pyvtk.common.Common:

default_float = 'float'

default_int = 'int'

struct_fmt_map = {'char': 'c', 'double': 'd', 'float': 'f', 'int': 'i', 'long': 'l', 'unsigned char': 'B'}

Data
`` |  | __all__ = ['StructuredPoints', 'StructuredGrid', 'UnstructuredGrid', 'RectilinearGrid', 'PolyData', 'Scalars', 'ColorScalars', 'LookupTable', 'Vectors', 'Normals', 'TextureCoordinates', 'Tensors', 'Field', 'PointData', 'CellData', 'VtkData'] __author__ = 'Pearu Peterson <pearu@cens.ioc.ee>' __license__ = 'LGPL (see http://www.fsf.org)' __version__ = '0.4.74'

Author
`` |  | Pearu Peterson <pearu@cens.ioc.ee>