BaseReader.read

Contents

BaseReader.read#

BaseReader.read(
*,
validate: bool | None = None,
) _T_Output_co[source]#

Read data in file.

Parameters:
validatebool, optional

Forwarded to pyvista.wrap() as the validate keyword. When True, perform a cheap array-length sanity check on the read dataset and emit a InvalidMeshWarning on a mismatch. When False, skip the check entirely. When None (the default), honor pyvista.core.config.Config.validate_on_wrap.

Added in version 0.48.

Returns:
pyvista.DataObject

PyVista dataset. The concrete subclass is determined by the specific *Reader used; for example, XMLUnstructuredGridReader produces an UnstructuredGrid.