pyvista_zstd.MultiBlockMetadata

class pyvista_zstd.MultiBlockMetadata(uid: str, children: list[str], children_keys: list[str], children_ds: dict[str, ~pyvista_zstd.pyvista_zstd.MultiBlockMetadata | ~pyvista_zstd.pyvista_zstd.DataSetMetadata | None] | None = None, field_data_keys: dict[str, ~pyvista_zstd.pyvista_zstd.ArrayInfo] = <factory>)

Metadata of a stored pyvista.MultiBlock.

Returned by pyvista_zstd.Reader.dataset_metadata for a MultiBlock file, with children_ds filled in down the whole tree. The attributes are the supported interface; the JSON and array conversions serve the file format.

Attributes:

ds_typestr

"MultiBlock".

uidstr

Identifier of this block within the file.

childrenlist[str]

Identifier of each child, in block order.

children_keyslist[str]

Name of each child, in block order.

children_dsdict[str, MultiBlockMetadata | DataSetMetadata | None] | None

Metadata of each child keyed by identifier. None values are empty blocks.

field_data_keysdict[str, ArrayInfo]

Shape and dtype of this MultiBlock’s own field arrays.

Methods

from_array(arr)	Create from a numpy uint8 array.
from_json(s)	Create from JSON.
to_array()	Output as a numpy uint8 array.
to_json()	Convert to JSON.

Methods

MultiBlockMetadata.__init__(uid, children, ...)
MultiBlockMetadata.from_array(arr)	Create from a numpy uint8 array.
MultiBlockMetadata.from_json(s)	Create from JSON.
MultiBlockMetadata.to_array()	Output as a numpy uint8 array.
MultiBlockMetadata.to_json()	Convert to JSON.

Attributes

MultiBlockMetadata.children_ds
MultiBlockMetadata.ds_type
MultiBlockMetadata.uid
MultiBlockMetadata.children
MultiBlockMetadata.children_keys
MultiBlockMetadata.field_data_keys