SeriesReader#

class SeriesReader(*args, **kwargs)[source]#

Class for reading .series file supported by ParaView.

Added in version 0.47.0.

Examples#

Download Python source code | Download Jupyter notebook

>>> import pyvista as pv
>>> from pyvista import examples
>>> from pathlib import Path
>>> filename = examples.download_file('vtu_series/wavy.zip')
>>> Path(filename[0]).name
'mesh.vtu.series'
>>> reader = pv.get_reader(filename[0])
>>> reader.time_values
[0.0, 1.0, 2.0, 3.0, ... 12.0, 13.0, 14.0]
>>> reader.set_active_time_point(5)
>>> reader.active_time_value
5.0
>>> mesh = reader.read()
>>> mesh.plot(scalars='z')
../../../_images/pyvista-SeriesReader-1d8d04614b7b6051_00_00.png

Inheritance#

Inherited members are documented on BaseReader, _FileIOBase, TimeReader.

See them all under Inherited Attributes and Inherited Methods.

Attributes#

SeriesReader.active_dataset

Return the active dataset.

SeriesReader.active_reader

Return the active reader.

SeriesReader.active_time_value

Active time or iteration value.

SeriesReader.datasets

Return all datasets.

SeriesReader.number_time_points

Return number of time points or iterations available to read.

SeriesReader.time_values

All time or iteration values.

Inherited Attributes#

_FileIOBase.extension_patterns

Return mapping from regex pattern matching associated with this class.

_FileIOBase.extensions

Return the file extensions associated with this class.

BaseReader.path

Return or set the filename or directory of the reader.

BaseReader.reader

Return the vtk Reader object.

Methods#

SeriesReader.set_active_time_point(time_point)

Set active time or iteration by index.

SeriesReader.set_active_time_value(time_value)

Set active time or iteration value.

SeriesReader.time_point_value(time_point)

Value of time point or iteration by index.

Inherited Methods#

BaseReader.hide_progress

Hide the progress bar when loading the file.

BaseReader.read

Read data in file.

BaseReader.show_progress

Show a progress bar when loading the file.