BaseReader.read

BaseReader.read(

*,

validate: bool | None = None,

) → _T_Output_co

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.

Used In

Docstring Examples

• AVSucdReader (1 use)
• BMPReader (1 use)
• BYUReader (1 use)
• BinaryMarchingCubesReader (1 use)
• CGNSReader (1 use)
• 45 more

  • DEMReader (1 use)
  • DICOMReader (1 use)
  • EnSightReader (1 use)
  • ExodusIIReader (1 use)
  • FLUENTCFFReader (1 use)
  • FRDReader (1 use)
  • FacetReader (1 use)
  • GESignaReader (1 use)
  • GIFReader (1 use)
  • GambitReader (1 use)
  • HDFReader (1 use)
  • HDRReader (1 use)
  • JPEGReader (1 use)
  • MINCImageReader (1 use)
  • MetaImageReader (1 use)
  • NIFTIReader (1 use)
  • NRRDReader (1 use)
  • Nek5000Reader (1 use)
  • OBJReader (1 use)
  • PExodusIIReader (1 use)
  • PLYReader (1 use)
  • PNGReader (1 use)
  • PNMReader (1 use)
  • PVDReader (1 use)
  • ParticleReader (1 use)
  • PointCellDataSelection (1 use)
  • ProStarReader (1 use)
  • SLCReader (1 use)
  • STLReader (1 use)
  • SeriesReader (1 use)
  • TIFFReader (1 use)
  • TecplotReader (1 use)
  • ThreeDSReader (1 use)
  • VRMLReader (1 use)
  • VTKDataSetReader (1 use)
  • XMLPolyDataReader (1 use)
  • XMLRectilinearGridReader (1 use)
  • XMLStructuredGridReader (1 use)
  • XMLUnstructuredGridReader (1 use)
  • XdmfReader (1 use)
  • download_caffeine (1 use)
  • download_dual_sphere_animation (1 use)
  • download_particles (1 use)
  • download_single_sphere_animation (1 use)
  • get_reader (1 use)

Gallery Examples

Load Data Using a Reader

Load Data Using a Reader

4 uses

Plot OpenFOAM Data

Plot OpenFOAM Data

3 uses