get_reader

get_reader(filename, force_ext=None)

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

Supported file types and Readers:

PyVista Readers

Reader	File Extension(s)	Return Type(s)
AVSucdReader	.inp	UnstructuredGrid
BinaryMarchingCubesReader	.tri	PolyData
BMPReader	.bmp	ImageData
BYUReader	.g	PolyData
CGNSReader	.cgns	MultiBlock
DEMReader	.dem	ImageData
DICOMReader	.dcm, .img	ImageData
EnSightReader	.case	MultiBlock
ExodusIIReader	.e, .ex2, .exii, .exo	MultiBlock
FacetReader	.facet	PolyData
FLUENTCFFReader	.h5	MultiBlock
FluentReader	.cas	UnstructuredGrid
FRDReader	.frd	UnstructuredGrid
GambitReader	.neu	UnstructuredGrid
GaussianCubeReader	.cube	ImageData, PolyData
GESignaReader	.mr	ImageData
GIFReader	.gif	ImageData
GLTFReader	.glb, .gltf	MultiBlock
GRDECLReader	.grdecl	ExplicitStructuredGrid
HDFReader	.hdf, .vtkhdf	ImageData, MultiBlock, PartitionedDataSet, PolyData, UnstructuredGrid
HDRReader	.hdr	ImageData
JPEGReader	.jpeg, .jpg	ImageData
MetaImageReader	.mha, .mhd	ImageData
MFIXReader	.res	UnstructuredGrid
MINCImageReader	.mnc	ImageData
Nek5000Reader	.nek5000	UnstructuredGrid
NIFTIReader	.nii, .nii.gz	ImageData
NRRDReader	.nhdr, .nrrd	ImageData
OBJReader	.obj	PolyData
ParticleReader	.raw	PolyData
PDBReader	.pdb	PolyData
PExodusIIReader	.e.N.p, .n.N.p	MultiBlock
Plot3DMetaReader	.p3d	MultiBlock
PLYReader	.ply	PolyData
PNGReader	.png	ImageData
PNMReader	.pnm	ImageData
POpenFOAMReader	.foam	MultiBlock
ProStarReader	.vrt	UnstructuredGrid
PTSReader	.pts	PolyData
PVDReader	.pvd	MultiBlock
SegYReader	.segy, .sgy	ImageData, StructuredGrid
SeriesReader	.series	ExplicitStructuredGrid, ImageData, MultiBlock, PartitionedDataSet, PointSet, PolyData, RectilinearGrid, StructuredGrid, UnstructuredGrid
SLCReader	.slc	ImageData
STLReader	.stl	PolyData
TecplotReader	.dat	MultiBlock
ThreeDSReader	.3ds	MultiBlock
TIFFReader	.tif, .tiff	ImageData
VRMLReader	.vrml, .wrl	MultiBlock
VTKDataSetReader	.vtk	ImageData, PolyData, RectilinearGrid, StructuredGrid, UnstructuredGrid
VTKPDataSetReader	.pvtk	ImageData, PolyData, RectilinearGrid, StructuredGrid, UnstructuredGrid
XdmfReader	.xdmf	MultiBlock, RectilinearGrid, StructuredGrid, UnstructuredGrid
XMLImageDataReader	.vti	ImageData
XMLMultiBlockDataReader	.vtm, .vtmb	MultiBlock
XMLPartitionedDataSetReader	.vtpd	PartitionedDataSet
XMLPImageDataReader	.pvti	ImageData
XMLPolyDataReader	.vtp	PolyData
XMLPRectilinearGridReader	.pvtr	RectilinearGrid
XMLPUnstructuredGridReader	.pvtu	UnstructuredGrid
XMLRectilinearGridReader	.vtr	RectilinearGrid
XMLStructuredGridReader	.vts	StructuredGrid
XMLUnstructuredGridReader	.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')

Static Scene

Interactive Scene