Skip to main content
Ctrl+K
PyVista 0.45.2 documentation - Home
  • GitHub
  • Slack Community
  • Support
  • Contributing
  • The Paper
  • Getting Started
    • Why PyVista?
    • Authors & Citation
    • Installation
    • Connections
    • External Examples
  • User Guide
    • What is a Mesh?
    • Basic API Usage
    • PyVista Data Model
    • Transitioning from VTK to PyVista
    • Plotting Themes
    • Jupyter Notebook Plotting
      • Trame Jupyter Backend for PyVista
    • Optional Features
  • Tags
    • filter (45)
      • Boolean Operations
      • Extract Cell Centers
      • Clipping with Planes & Boxes
      • Clipping with a Surface
      • Collision
      • Computing Surface Normals
      • Volumetric Analysis
      • Connectivity
      • Contouring
      • Decimation
      • Distance Between Two Surfaces
      • Extract Cells Inside Surface
      • Extract Edges
      • Extract Surface
      • Extrude Rotation
      • Extrude Trim
      • Marching Cubes
      • Gaussian Smoothing
      • Geodesic Paths
      • Plotting Glyphs (Vectors or PolyData)
      • Table of Glyphs
      • Compute Gradients of a Field
      • Fast Fourier Transform
      • Fast Fourier Transform with Perlin Noise
      • Image Data Representations
      • Integrate Data
      • Detailed Interpolating Points
      • Compare interpolation/sampling methods
      • Computing Mesh Quality
      • Ray Tracing
      • Project to a Plane
      • Reflect Meshes
      • Detailed Resampling
      • Rotations
      • Sample Function: Perlin Noise in 2D
      • Sample Function: Perlin Noise in 3D
      • Slicing
      • Streamlines
      • 2D Streamlines
      • Subdivide Cells
      • Surface Reconstruction
      • Surface Smoothing
      • Using Common Filters
      • Voxelize a Surface Mesh
      • Warping by Vectors
    • lights (7)
      • Light Actors
      • Attenuation
      • Beam Shape
      • Light Types
      • Disabling Mesh Lighting
      • Plotter Lighting Systems
      • Shadows
    • load (29)
      • Creating an Explicit Structured Grid
      • Geometric Objects
      • Create a Kochanek Spline
      • Parametric Geometric Objects
      • Pixel Art of ALIEN MONSTERS
      • Platonic Solids
      • Create Point Cloud
      • Create a PointSet
      • Create PolyData
      • Triangle Strips
      • Unstructured Grid with Polyhedra
      • Create Sphere Mesh Multiple Ways
      • Creating a Spline
      • Creating a Structured Surface
      • Drape 2D Surface From Line
      • Create Triangulated Surface
      • Plot Truss-like FEA Solution with Cylinders
      • Creating a Uniform Grid
      • Creating an Unstructured Grid
      • Linear Cells
      • Working with glTF Files
      • Working with VRML Files
      • Read FEniCS/Dolfin Meshes
      • Load and Plot from a File
      • Read Image Files
      • Parallel Files
      • Load data using a Reader
      • Terrain Following Mesh
      • Wrapping Other Objects
    • medical (2)
      • Volume Rendering
      • Visualize Anatomical Groups
    • plot (57)
      • Anti-Aliasing
      • Setting Backface Properties
      • Background Image
      • Blurring
      • Plotting Bounds
      • Chart Basics
      • Chart Overlays
      • Clearing a Mesh or the Entire Plot
      • Colormap Choices
      • Color Cycling
      • Composite Picking
      • Depth of Field Plotting
      • Depth Peeling
      • Label based on Distance on Line
      • Measuring distance
      • Show Edges
      • Eye Dome Lighting
      • Picking elements of a mesh
      • Plot with Floors
      • Hide Cells with Ghosting
      • Create a GIF Movie
      • Render a depth image
      • Interpolate Before Mapping
      • Moving Isovalue
      • Label Points
      • Legends and glyphs
      • Lighting Properties
      • Linked Views in Subplots
      • Lookup Tables
      • Picking Meshes
      • Create a MP4 Movie
      • Save a Movie Using Glyphs
      • Create a GIF Movie of a Static Object with a Moving Colormap
      • Multi-Window Plot
      • Plot with Opacity
      • Orbiting
      • Orthogonal Slices
      • Physically Based Rendering
      • Plot Scalars Over a Circular Arc
      • Plot Over Line
      • Point Cell Scalars
      • Plotting Point Clouds
      • Picking points on a mesh
      • Scaled Gaussian Points
      • Customize Scalar Bars
      • Saving Screenshots
      • Types of Shading
      • Silhouette Highlight
      • Plot data in spherical coordinates
      • Surface Space Ambient Occlusion
      • Picking a Point on the Surface of a Mesh
      • Applying Textures
      • Control Global and Local Plotting Themes
      • Topographic Map
      • Plot Vector Component
      • Visible Vertices
      • Volume Rendering
    • widgets (10)
      • Animation
      • Box Widget
      • Checkbox Widget
      • Clip Volume Widget
      • Line Widget
      • Multiple Slider Widgets
      • Plane Widget
      • Slider Bar Widget
      • Sphere Widget
      • Spline Widget
  • Examples
    • Mesh Creation
      • Creating an Explicit Structured Grid
      • Geometric Objects
      • Create a Kochanek Spline
      • Parametric Geometric Objects
      • Pixel Art of ALIEN MONSTERS
      • Platonic Solids
      • Create Point Cloud
      • Create a PointSet
      • Create PolyData
      • Triangle Strips
      • Unstructured Grid with Polyhedra
      • Create Sphere Mesh Multiple Ways
      • Creating a Spline
      • Creating a Structured Surface
      • Drape 2D Surface From Line
      • Create Triangulated Surface
      • Plot Truss-like FEA Solution with Cylinders
      • Creating a Uniform Grid
      • Creating an Unstructured Grid
      • Linear Cells
      • Working with glTF Files
      • Working with VRML Files
      • Read FEniCS/Dolfin Meshes
      • Load and Plot from a File
      • Read Image Files
      • Parallel Files
      • Load data using a Reader
      • Terrain Following Mesh
      • Wrapping Other Objects
    • Filtering
      • Boolean Operations
      • Extract Cell Centers
      • Clipping with Planes & Boxes
      • Clipping with a Surface
      • Collision
      • Computing Surface Normals
      • Volumetric Analysis
      • Connectivity
      • Contouring
      • Decimation
      • Distance Between Two Surfaces
      • Extract Cells Inside Surface
      • Extract Edges
      • Extract Surface
      • Extrude Rotation
      • Extrude Trim
      • Marching Cubes
      • Gaussian Smoothing
      • Geodesic Paths
      • Plotting Glyphs (Vectors or PolyData)
      • Table of Glyphs
      • Compute Gradients of a Field
      • Fast Fourier Transform
      • Fast Fourier Transform with Perlin Noise
      • Image Data Representations
      • Integrate Data
      • Detailed Interpolating Points
      • Compare interpolation/sampling methods
      • Computing Mesh Quality
      • Ray Tracing
      • Project to a Plane
      • Reflect Meshes
      • Detailed Resampling
      • Rotations
      • Sample Function: Perlin Noise in 2D
      • Sample Function: Perlin Noise in 3D
      • Slicing
      • Streamlines
      • 2D Streamlines
      • Subdivide Cells
      • Surface Reconstruction
      • Surface Smoothing
      • Using Common Filters
      • Voxelize a Surface Mesh
      • Warping by Vectors
    • Plotting
      • Anti-Aliasing
      • Setting Backface Properties
      • Background Image
      • Blurring
      • Plotting Bounds
      • Chart Basics
      • Chart Overlays
      • Clearing a Mesh or the Entire Plot
      • Colormap Choices
      • Color Cycling
      • Composite Picking
      • Depth of Field Plotting
      • Depth Peeling
      • Label based on Distance on Line
      • Measuring distance
      • Show Edges
      • Eye Dome Lighting
      • Picking elements of a mesh
      • Plot with Floors
      • Hide Cells with Ghosting
      • Create a GIF Movie
      • Render a depth image
      • Interpolate Before Mapping
      • Moving Isovalue
      • Label Points
      • Legends and glyphs
      • Lighting Properties
      • Linked Views in Subplots
      • Lookup Tables
      • Picking Meshes
      • Create a MP4 Movie
      • Save a Movie Using Glyphs
      • Create a GIF Movie of a Static Object with a Moving Colormap
      • Multi-Window Plot
      • Plot with Opacity
      • Orbiting
      • Orthogonal Slices
      • Physically Based Rendering
      • Plot Scalars Over a Circular Arc
      • Plot Over Line
      • Point Cell Scalars
      • Plotting Point Clouds
      • Picking points on a mesh
      • Scaled Gaussian Points
      • Customize Scalar Bars
      • Saving Screenshots
      • Types of Shading
      • Silhouette Highlight
      • Plot data in spherical coordinates
      • Surface Space Ambient Occlusion
      • Picking a Point on the Surface of a Mesh
      • Applying Textures
      • Control Global and Local Plotting Themes
      • Topographic Map
      • Plot Vector Component
      • Visible Vertices
      • Volume Rendering
    • Widgets
      • Animation
      • Box Widget
      • Checkbox Widget
      • Clip Volume Widget
      • Line Widget
      • Multiple Slider Widgets
      • Plane Widget
      • Slider Bar Widget
      • Sphere Widget
      • Spline Widget
    • Lighting
      • Light Actors
      • Attenuation
      • Beam Shape
      • Light Types
      • Disabling Mesh Lighting
      • Plotter Lighting Systems
      • Shadows
    • Common
      • Project points to a plane and Tessellate
    • Advanced
      • Adding a New Gallery Example
      • Visualize Anatomical Groups
      • Compare Field Across Mesh Regions
      • Plot Atomic Orbitals
      • Customize Trame toolbar
      • Extending PyVista
      • Visualize Hertzian Contact Stress
      • Plot a Magnetic Field
      • Electronics Cooling CFD
      • Plot OpenFOAM data
      • Plot CFD Data
      • 3D Earth and Celestial Bodies
      • Plotting with VTK Algorithms
      • Visualize Modal Analysis of a Pump Bracket
      • Visualize the Moeller-Trumbore Algorithm
      • Turning the sphere inside out
      • Display Eigenmodes of Vibration
  • API Reference
    • Core API
      • DataObject
      • Data Sets
      • Point Sets
      • Gridded Data
      • Composite Datasets
      • Filters
      • Cameras
      • Lights
      • Cells
      • Helpers
      • Miscellaneous
      • Typing
      • Partitioned Datasets
      • Validation
    • Plotting
      • Plotting
      • PyVista and PyQt
      • Themes
      • Trame
      • pyvista.Actor
      • pyvista.Axes
      • pyvista.AxesActor
      • pyvista.AxesAssembly
      • pyvista.AxesAssemblySymmetric
      • pyvista.CameraPosition
      • pyvista.CornerAnnotation
      • pyvista.CubeAxesActor
      • pyvista.DataSetMapper
      • pyvista.Label
      • pyvista.LookupTable
      • pyvista.PlanesAssembly
      • pyvista.Plotter
      • pyvista.Prop3D
      • pyvista.Property
      • pyvista.Renderer
      • pyvista.RenderWindowInteractor
      • pyvista.Text
      • pyvista.TextProperty
      • pyvista.Timer
      • pyvista.plotting.mapper._BaseMapper
      • pyvista.plotting.opts.InterpolationType
      • pyvista.plotting.opts.RepresentationType
      • pyvista.plotting.opts.ElementType
      • pyvista.plotting.volume.Volume
      • pyvista.plotting.volume_property.VolumeProperty
      • pyvista.CompositePolyDataMapper
      • pyvista.CompositeAttributes
      • pyvista.BlockAttributes
      • Charts
      • pyvista.plotting.widgets.WidgetHelper
      • pyvista.plotting.widgets.AffineWidget3D
      • pyvista.plotting.picking.PickingHelper
      • Convenience Functions
    • Utilities
      • Geometry
      • Image
      • Parametric Objects
      • General Utilities
    • Readers
      • pyvista.get_reader
      • pyvista.AVSucdReader
      • pyvista.BMPReader
      • pyvista.BYUReader
      • pyvista.BinaryMarchingCubesReader
      • pyvista.CGNSReader
      • pyvista.DEMReader
      • pyvista.DICOMReader
      • pyvista.EnSightReader
      • pyvista.ExodusIIBlockSet
      • pyvista.ExodusIIReader
      • pyvista.FacetReader
      • pyvista.FLUENTCFFReader
      • pyvista.FluentReader
      • pyvista.GambitReader
      • pyvista.GaussianCubeReader
      • pyvista.GESignaReader
      • pyvista.GIFReader
      • pyvista.GLTFReader
      • pyvista.HDFReader
      • pyvista.HDRReader
      • pyvista.JPEGReader
      • pyvista.MFIXReader
      • pyvista.MetaImageReader
      • pyvista.MINCImageReader
      • pyvista.MultiBlockPlot3DReader
      • pyvista.Nek5000Reader
      • pyvista.NIFTIReader
      • pyvista.NRRDReader
      • pyvista.OBJReader
      • pyvista.OpenFOAMReader
      • pyvista.ParticleReader
      • pyvista.PDBReader
      • pyvista.PLYReader
      • pyvista.PNGReader
      • pyvista.PNMReader
      • pyvista.POpenFOAMReader
      • pyvista.PTSReader
      • pyvista.PVDReader
      • pyvista.Plot3DMetaReader
      • pyvista.ProStarReader
      • pyvista.SLCReader
      • pyvista.STLReader
      • pyvista.SegYReader
      • pyvista.TIFFReader
      • pyvista.TecplotReader
      • pyvista.VTKDataSetReader
      • pyvista.VTKPDataSetReader
      • pyvista.XMLImageDataReader
      • pyvista.XMLMultiBlockDataReader
      • pyvista.XMLPImageDataReader
      • pyvista.XMLPRectilinearGridReader
      • pyvista.XMLPUnstructuredGridReader
      • pyvista.XMLPartitionedDataSetReader
      • pyvista.XMLPolyDataReader
      • pyvista.XMLRectilinearGridReader
      • pyvista.XMLStructuredGridReader
      • pyvista.XMLUnstructuredGridReader
      • pyvista.XdmfReader
      • pyvista.BaseReader
      • pyvista.PointCellDataSelection
      • pyvista.TimeReader
      • Reader Enumerations
    • Examples
      • pyvista.examples.examples
      • pyvista.examples.downloads
      • pyvista.demos.demos
      • pyvista.examples.planets
      • pyvista.examples.vrml
      • pyvista.examples.download_3ds
      • pyvista.examples.gltf
      • pyvista.examples.cells
      • Dataset Gallery
  • Extras
    • Building VTK
    • PyVista within a Docker Container
    • Freezing PyVista with PyInstaller
    • Contributing
    • Sphinx PyVista Plot Directive
    • PyVista pytest Plugin
    • Using Local VTK-Data
    • Extending PyVista

Page not found.

Perhaps try the examples page.

By Alex Kaszynski and Bane Sullivan

© Copyright 2017-2025, The PyVista Developers.