get_reader

get_reader#

get_reader(filename: str | Path, force_ext: str | None = None) → Any[source]#

Get a reader for fine-grained control of reading data files.

Supported file formats and readers:

PyVista Readers#
Reader	File Format	File Extension(s)	Return Type(s)
`AVSucdReader`	AVS UCD	`.inp`	`UnstructuredGrid`
`BinaryMarchingCubesReader`	Binary Marching Cubes	`.tri`	`PolyData`
`BMPReader`	BMP Image	`.bmp`	`ImageData`
`BYUReader`	MOVIE.BYU	`.g`	`PolyData`
`CGNSReader`	CGNS	`.cgns`	`MultiBlock`
`DEMReader`	Digital Elevation Model	`.dem`	`ImageData`
`DICOMReader`	DICOM	`.dcm`, `.img`	`ImageData`
`EnSightReader`	EnSight	`.case`	`MultiBlock`
`ExodusIIReader`	Exodus II	`.e`, `.ex2`, `.exii`, `.exo`	`MultiBlock`
`FacetReader`	Facet Polygonal Data	`.facet`	`PolyData`
`FLUENTCFFReader`	Fluent CFF Case	`.h5`	`MultiBlock`
`FluentReader`	Fluent Case	`.cas`	`UnstructuredGrid`
`GambitReader`	GAMBIT Neutral	`.neu`	`UnstructuredGrid`
`GaussianCubeReader`	Gaussian Cube	`.cube`	`ImageData`, `PolyData`
`GESignaReader`	GE Signa MR	`.mr`	`ImageData`
`GIFReader`	GIF Image	`.gif`	`ImageData`
`GLTFReader`	glTF 2.0	`.glb`, `.gltf`	`MultiBlock`
`GRDECLReader`	Eclipse GRDECL	`.grdecl`	`ExplicitStructuredGrid`
`HDFReader`	VTKHDF	`.hdf`, `.vtkhdf`	`ImageData`, `MultiBlock`, `PartitionedDataSet`, `PolyData`, `UnstructuredGrid`
`HDRReader`	Radiance HDR	`.hdr`	`ImageData`
`JPEGReader`	JPEG Image	`.jpeg`, `.jpg`	`ImageData`
`MetaImageReader`	MetaImage	`.mha`, `.mhd`	`ImageData`
`MFIXReader`	MFIX	`.res`	`UnstructuredGrid`
`MINCImageReader`	MINC Image	`.mnc`	`ImageData`
`Nek5000Reader`	Nek5000	`.nek5000`	`UnstructuredGrid`
`NIFTIReader`	NIfTI	`.nii`, `.nii.gz`	`ImageData`
`NRRDReader`	NRRD	`.nhdr`, `.nrrd`	`ImageData`
`OBJReader`	Wavefront OBJ	`.obj`	`PolyData`
`ParticleReader`	VTK Particle	`.raw`	`PolyData`
`PDBReader`	Protein Data Bank	`.pdb`	`PolyData`
`PExodusIIReader`	Exodus II (partitioned)	`.e.N.p`, `.n.N.p`	`MultiBlock`
`Plot3DMetaReader`	PLOT3D Meta	`.p3d`	`MultiBlock`
`PLYReader`	Stanford PLY	`.ply`	`PolyData`
`PNGReader`	PNG Image	`.png`	`ImageData`
`PNMReader`	PNM Image	`.pnm`	`ImageData`
`POpenFOAMReader`	OpenFOAM	`.foam`	`MultiBlock`
`ProStarReader`	proSTAR	`.vrt`	`UnstructuredGrid`
`PTSReader`	PTS Point Cloud	`.pts`	`PolyData`
`PVDReader`	ParaView Data	`.pvd`	`MultiBlock`
`SegYReader`	SEG-Y	`.segy`, `.sgy`	`ImageData`, `StructuredGrid`
`SeriesReader`	VTK File Series	`.series`	`ExplicitStructuredGrid`, `ImageData`, `MultiBlock`, `PartitionedDataSet`, `PointSet`, `PolyData`, `RectilinearGrid`, `StructuredGrid`, `UnstructuredGrid`
`SLCReader`	SLC Volume	`.slc`	`ImageData`
`STLReader`	Stereolithography	`.stl`	`PolyData`
`TecplotReader`	Tecplot	`.dat`	`MultiBlock`
`ThreeDSReader`	3D Studio	`.3ds`	`MultiBlock`
`TIFFReader`	TIFF Image	`.tif`, `.tiff`	`ImageData`
`VRMLReader`	VRML 2.0	`.vrml`, `.wrl`	`MultiBlock`
`VTKDataSetReader`	Legacy VTK	`.vtk`	`ImageData`, `PolyData`, `RectilinearGrid`, `StructuredGrid`, `UnstructuredGrid`
`VTKPDataSetReader`	Legacy VTK (partitioned)	`.pvtk`	`ImageData`, `PolyData`, `RectilinearGrid`, `StructuredGrid`, `UnstructuredGrid`
`XdmfReader`	XDMF	`.xdmf`	`MultiBlock`, `RectilinearGrid`, `StructuredGrid`, `UnstructuredGrid`
`XMLImageDataReader`	VTK ImageData	`.vti`	`ImageData`
`XMLMultiBlockDataReader`	VTK MultiBlock	`.vtm`, `.vtmb`	`MultiBlock`
`XMLPartitionedDataSetReader`	VTK PartitionedDataSet	`.vtpd`	`PartitionedDataSet`
`XMLPImageDataReader`	VTK ImageData (partitioned)	`.pvti`	`ImageData`
`XMLPolyDataReader`	VTK PolyData	`.vtp`	`PolyData`
`XMLPRectilinearGridReader`	VTK RectilinearGrid (partitioned)	`.pvtr`	`RectilinearGrid`
`XMLPUnstructuredGridReader`	VTK UnstructuredGrid (partitioned)	`.pvtu`	`UnstructuredGrid`
`XMLRectilinearGridReader`	VTK RectilinearGrid	`.vtr`	`RectilinearGrid`
`XMLStructuredGridReader`	VTK StructuredGrid	`.vts`	`StructuredGrid`
`XMLUnstructuredGridReader`	VTK UnstructuredGrid	`.vtu`	`UnstructuredGrid`

Parameters:

filenamestr, Path: The string path to the file to read.
force_extstr, optional: An extension to force a specific reader to be chosen.

Returns:

pyvista.BaseReader: A subclass of pyvista.BaseReader is returned based on file type.

Examples#

Download Python source code | Download Jupyter notebook

>>> import pyvista as pv
>>> from pyvista import examples
>>> from pathlib import Path
>>> filename = examples.download_human(load=False)
>>> Path(filename).name
'Human.vtp'
>>> reader = pv.get_reader(filename)
>>> reader
XMLPolyDataReader('...Human.vtp')
>>> mesh = reader.read()
>>> mesh
PolyData ...
>>> mesh.plot(color='lightblue')