zvtk.read

Contents

zvtk.read#

zvtk.read(filename: Path | str, n_threads: int | None = None) DataSet#

Decompress a zvtk file.

This is a convenience function that uses Reader. Use that class to finely tune reading in a file.

Parameters:
filenamepathlib.Path | str

Path to the file.

n_threadsNone | int, optional

Number of threads to use. If omitted, the best number of threads to decompress the file will be used.

Returns:
pyvista.DataSet

Examples

>>> import zvtk
>>> ds = zvtk.read("dataset.zvtk")