Skip to main content
Ctrl+K
PyVista 0.49.0 documentation - Home PyVista 0.49.0 documentation - Home
  • GitHub
  • Slack Community
  • Support
  • The Paper
  • PyPI
  • Getting Started
    • Why PyVista?
    • Authors & Citation
    • Installation
    • Connections
    • External Examples
  • User Guide
    • What Is a Mesh?
    • Basic API Usage
    • Interactive Plotting
    • PyVista Data Model
    • Transitioning From VTK to PyVista
    • Plotting Themes
    • Global Configuration
    • Jupyter Notebook Plotting
      • Trame Jupyter Backend for PyVista
    • Optional Features
  • Tags
    • advanced (1)
      • Plot a Gyroid Surface
    • filter (53)
      • Boolean Operations
      • Extract Cell Centers
      • Clip and Cap a Closed Surface
      • Clipping With Planes & Boxes
      • Clipping With a Surface
      • Collision
      • Computing Surface Normals
      • Connectivity
      • Contouring
      • Wrap a Point Cloud in a Convex Hull
      • Decimation
      • Distance Between Two Surfaces
      • Extract Cells Inside Surface
      • Extract Edges
      • Extract Surface
      • Extrude Rotation
      • Extrude Trim
      • Farthest Point Sampling
      • Repair a Surface With fill_holes
      • Gaussian Smoothing
      • Geodesic Paths
      • Plotting Glyphs (Vectors or PolyData)
      • Table of Glyphs
      • Compute Gradients of a Field
      • Register a Surface With ICP
      • Fast Fourier Transform
      • Fast Fourier Transform With Perlin Noise
      • Image Data Representations
      • Integrate Data
      • Detailed Interpolating Points
      • Compare Interpolation/Sampling Methods
      • Marching Cubes
      • Computing Mesh Quality
      • Sample Function: Perlin Noise in 2D
      • Sample Function: Perlin Noise in 3D
      • Measure Distance Between Point Clouds
      • Analyze the Orientation of a Point Cloud
      • Project to a Plane
      • Ray Tracing
      • Reflect Meshes
      • Remove Cells
      • Detailed Resampling
      • Rotations
      • Slicing
      • Streamlines
      • 2D Streamlines
      • Subdivide Cells
      • Surface Reconstruction
      • Surface Smoothing
      • Using Common Filters
      • Volumetric Analysis
      • Voxelize a Surface Mesh
      • Warping by Vectors
    • lights (7)
      • Attenuation
      • Beam Shape
      • Light Actors
      • Light Types
      • Disabling Mesh Lighting
      • Plotter Lighting Systems
      • Shadows
    • load (33)
      • Create Circular Arcs
      • Drape 2D Surface From Line
      • Creating an Explicit Structured Grid
      • Geometric Objects
      • Create a Kochanek Spline
      • Create Connected Lines From Points
      • 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
      • Create 3D Text
      • 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
      • Compare Threshold Filters
    • medical (2)
      • Volume Rendering
      • Visualize Anatomical Groups
    • plot (65)
      • Anti-Aliasing
      • Axes Objects
      • Setting Backface Properties
      • Background Image
      • Blurring
      • Plotting Bounds
      • Camera Distortion
      • Chart Basics
      • Chart Overlays
      • Build a Ball-and-Stick Molecule
      • Clearing a Mesh or the Entire Plot
      • Color Cycling
      • Color Several Lines
      • Colormap Choices
      • Composite Picking
      • Depth of Field Plotting
      • Depth Peeling
      • Label Based on Distance on Line
      • Measuring Distance
      • Eye Dome Lighting
      • Picking Elements of a Mesh
      • Plot Curved Flight Paths on a Globe
      • Plot With Floors
      • Create a GIF Movie
      • Plot a 3D Graph Network
      • Render a Depth Image
      • Interpolate Before Mapping
      • Legends and Glyphs
      • Lighting Properties
      • Linked Views in Subplots
      • Lookup Tables
      • Plot a Lorenz Attractor
      • Picking Meshes
      • Create a MP4 Movie
      • Save a Movie Using Glyphs
      • Create a GIF Movie of a Static Object With a Moving Colormap
      • Moving Isovalue
      • Multi-Window Plot
      • Plot With Opacity
      • Orbiting
      • Physically Based Rendering
      • Plot Scalars Over a Circular Arc
      • Plot Over Line
      • Point Cell Scalars
      • Highlight Nearest Neighbors in a Point Cloud
      • Plotting Point Clouds
      • Label Points
      • Picking Points on a Mesh
      • Scaled Gaussian Points
      • Customize Scalar Bars
      • Saving Screenshots
      • Types of Shading
      • Sharing Scalar Bars
      • Show Edges
      • Silhouette Highlight
      • Orthogonal Slices
      • 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
      • Create Circular Arcs
      • Drape 2D Surface From Line
      • Creating an Explicit Structured Grid
      • Geometric Objects
      • Create a Kochanek Spline
      • Create Connected Lines From Points
      • 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
      • Create 3D Text
      • 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
      • Clip and Cap a Closed Surface
      • Clipping With Planes & Boxes
      • Clipping With a Surface
      • Collision
      • Compare Threshold Filters
      • Computing Surface Normals
      • Connectivity
      • Contouring
      • Wrap a Point Cloud in a Convex Hull
      • Crop Labeled ImageData
      • Decimation
      • Distance Between Two Surfaces
      • Extract Cells Inside Surface
      • Extract Edges
      • Extract Surface
      • Extrude Rotation
      • Extrude Trim
      • Farthest Point Sampling
      • Repair a Surface With fill_holes
      • Gaussian Smoothing
      • Geodesic Paths
      • Plotting Glyphs (Vectors or PolyData)
      • Table of Glyphs
      • Compute Gradients of a Field
      • Register a Surface With ICP
      • Fast Fourier Transform
      • Fast Fourier Transform With Perlin Noise
      • Image Data Representations
      • Integrate Data
      • Detailed Interpolating Points
      • Compare Interpolation/Sampling Methods
      • Marching Cubes
      • Computing Mesh Quality
      • Sample Function: Perlin Noise in 2D
      • Sample Function: Perlin Noise in 3D
      • Measure Distance Between Point Clouds
      • Analyze the Orientation of a Point Cloud
      • Project to a Plane
      • Ray Tracing
      • Reflect Meshes
      • Remove Cells
      • Detailed Resampling
      • Rotations
      • Slicing
      • Streamlines
      • 2D Streamlines
      • Subdivide Cells
      • Surface Reconstruction
      • Surface Smoothing
      • Using Common Filters
      • Volumetric Analysis
      • Voxelize a Surface Mesh
      • Warping by Vectors
    • Plotting
      • Anti-Aliasing
      • Axes Objects
      • Setting Backface Properties
      • Background Image
      • Blurring
      • Plotting Bounds
      • Camera Distortion
      • Chart Basics
      • Chart Overlays
      • Build a Ball-and-Stick Molecule
      • Clearing a Mesh or the Entire Plot
      • Color Cycling
      • Color Several Lines
      • Colormap Choices
      • Composite Picking
      • Depth of Field Plotting
      • Depth Peeling
      • Label Based on Distance on Line
      • Measuring Distance
      • Eye Dome Lighting
      • Picking Elements of a Mesh
      • Plot Curved Flight Paths on a Globe
      • Plot With Floors
      • Create a GIF Movie
      • Plot a 3D Graph Network
      • Render a Depth Image
      • Interpolate Before Mapping
      • Legends and Glyphs
      • Lighting Properties
      • Linked Views in Subplots
      • Lookup Tables
      • Plot a Lorenz Attractor
      • Maximum Intensity Projection
      • Picking Meshes
      • Create a MP4 Movie
      • Save a Movie Using Glyphs
      • Create a GIF Movie of a Static Object With a Moving Colormap
      • Moving Isovalue
      • Multi-Window Plot
      • Plot With Opacity
      • Orbiting
      • Physically Based Rendering
      • Plot Scalars Over a Circular Arc
      • Plot Over Line
      • Point Cell Scalars
      • Highlight Nearest Neighbors in a Point Cloud
      • Plotting Point Clouds
      • Label Points
      • Picking Points on a Mesh
      • Point Sprite Shapes
      • Scaled Gaussian Points
      • Customize Scalar Bars
      • Saving Screenshots
      • Types of Shading
      • Sharing Scalar Bars
      • Show Edges
      • Silhouette Highlight
      • Orthogonal Slices
      • 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
      • Attenuation
      • Beam Shape
      • Light Actors
      • Light Types
      • Disabling Mesh Lighting
      • Plotter Lighting Systems
      • Shadows
    • Common
      • Export Mesh Data to a DataFrame
      • 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 Gyroid Surface
      • Plot a Magnetic Field
      • Mesh Validation
      • Plot OpenFOAM Data
      • Electronics Cooling CFD
      • 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
        • DataObject
        • Table
        • Texture
        • cubemap
        • cubemap_from_filenames
        • image_to_texture
        • numpy_to_texture
      • Data Sets
        • DataSet
        • DataSetAttributes
        • ActiveArrayInfoTuple
        • FieldAssociation
        • _BoundsSizeMixin
      • Point Sets
        • PointSet
        • PolyData
        • UnstructuredGrid
        • StructuredGrid
        • ExplicitStructuredGrid
        • PointGrid
        • _PointSetBase
      • Gridded Data
        • RectilinearGrid
        • ImageData
        • Grid
      • Composite Datasets
        • MultiBlock
      • Partitioned Datasets
        • PartitionedDataSet
      • Filters
        • DataObjectFilters
        • DataSetFilters
        • PolyDataFilters
        • UnstructuredGridFilters
        • ImageDataFilters
        • CompositeFilters
      • Dataset Accessors
        • register_dataset_accessor
        • unregister_dataset_accessor
        • registered_accessors
        • AccessorRegistration
        • DataSetAccessor
      • Cells
        • Cell
        • CellArray
        • CellStatus
        • CellType
        • cell_quality_info
      • Typing
    • Plotting
      • Cameras
        • Camera
      • Lights
        • Light
      • Themes
        • Theme
        • DarkTheme
        • DocumentTheme
        • ParaViewTheme
        • _AxesConfig
        • _CameraConfig
        • _ColorbarConfig
        • _ConfigBase
        • _DepthPeelingConfig
        • _Font
        • _LightingConfig
        • _SilhouetteConfig
        • _SliderConfig
        • _SliderStyleConfig
        • _TrameConfig
        • ThemeRegistration
        • load_theme
        • registered_themes
        • set_plot_theme
      • PyVista and PyQt
      • Trame
      • Plotter Components
        • register_plotter_component
        • unregister_plotter_component
        • registered_plotter_components
        • ComponentRegistration
        • PlotterComponent
      • close_all
      • plot
      • plot_arrows
      • plot_compare
      • plot_compare_four
      • Plotter
        • Plotter.actors
        • Plotter.background_color
        • Plotter.bounds
        • Plotter.box_clipped_meshes
        • Plotter.box_widgets
        • Plotter.button_widgets
        • Plotter.camera
        • Plotter.camera3d_widgets
        • Plotter.camera_position
        • Plotter.camera_set
        • Plotter.camera_widgets
        • Plotter.center
        • Plotter.click_position
        • Plotter.distance_widgets
        • Plotter.image
        • Plotter.image_depth
        • Plotter.image_scale
        • Plotter.isovalue_meshes
        • Plotter.last_update_time
        • Plotter.legend
        • Plotter.length
        • Plotter.line_widgets
        • Plotter.logo_widgets
        • Plotter.meshes
        • Plotter.mouse_position
        • Plotter.parallel_projection
        • Plotter.parallel_scale
        • Plotter.pickable_actors
        • Plotter.picked_actor
        • Plotter.picked_block_index
        • Plotter.picked_cells
        • Plotter.picked_geodesic
        • Plotter.picked_horizon
        • Plotter.picked_mesh
        • Plotter.picked_path
        • Plotter.picked_point
        • Plotter.plane_clipped_meshes
        • Plotter.plane_sliced_meshes
        • Plotter.plane_widgets
        • Plotter.radio_button_title_dict
        • Plotter.radio_button_widget_dict
        • Plotter.render_window
        • Plotter.renderer
        • Plotter.scalar_bar
        • Plotter.scale
        • Plotter.shape
        • Plotter.slider_widgets
        • Plotter.sphere_widgets
        • Plotter.spline_sliced_meshes
        • Plotter.spline_widgets
        • Plotter.suppress_rendering
        • Plotter.theme
        • Plotter.threshold_meshes
        • Plotter.window_size
        • Plotter.add_actor
        • Plotter.add_affine_transform_widget
        • Plotter.add_arrows
        • Plotter.add_axes
        • Plotter.add_axes_at_origin
        • Plotter.add_background_image
        • Plotter.add_blurring
        • Plotter.add_bounding_box
        • Plotter.add_box_axes
        • Plotter.add_box_widget
        • Plotter.add_camera3d_widget
        • Plotter.add_camera_orientation_widget
        • Plotter.add_chart
        • Plotter.add_checkbox_button_widget
        • Plotter.add_composite
        • Plotter.add_cursor
        • Plotter.add_floor
        • Plotter.add_key_event
        • Plotter.add_legend
        • Plotter.add_legend_scale
        • Plotter.add_light
        • Plotter.add_line_widget
        • Plotter.add_lines
        • Plotter.add_logo_widget
        • Plotter.add_measurement_widget
        • Plotter.add_mesh
        • Plotter.add_mesh_clip_box
        • Plotter.add_mesh_clip_plane
        • Plotter.add_mesh_isovalue
        • Plotter.add_mesh_slice
        • Plotter.add_mesh_slice_orthogonal
        • Plotter.add_mesh_slice_spline
        • Plotter.add_mesh_threshold
        • Plotter.add_north_arrow_widget
        • Plotter.add_on_render_callback
        • Plotter.add_orientation_widget
        • Plotter.add_plane_widget
        • Plotter.add_point_labels
        • Plotter.add_point_scalar_labels
        • Plotter.add_points
        • Plotter.add_radio_button_widget
        • Plotter.add_ruler
        • Plotter.add_scalar_bar
        • Plotter.add_silhouette
        • Plotter.add_slider_widget
        • Plotter.add_sphere_widget
        • Plotter.add_spline_widget
        • Plotter.add_text
        • Plotter.add_text_slider_widget
        • Plotter.add_timer_event
        • Plotter.add_title
        • Plotter.add_volume
        • Plotter.add_volume_clip_plane
        • Plotter.clear
        • Plotter.clear_actors
        • Plotter.clear_box_widgets
        • Plotter.clear_button_widgets
        • Plotter.clear_camera3d_widgets
        • Plotter.clear_camera_widgets
        • Plotter.clear_events_for_key
        • Plotter.clear_line_widgets
        • Plotter.clear_logo_widgets
        • Plotter.clear_measure_widgets
        • Plotter.clear_on_render_callbacks
        • Plotter.clear_plane_widgets
        • Plotter.clear_radio_button_widgets
        • Plotter.clear_slider_widgets
        • Plotter.clear_sphere_widgets
        • Plotter.clear_spline_widgets
        • Plotter.close
        • Plotter.compute_bounds
        • Plotter.deep_clean
        • Plotter.disable
        • Plotter.disable_3_lights
        • Plotter.disable_anti_aliasing
        • Plotter.disable_camera_distortion
        • Plotter.disable_depth_of_field
        • Plotter.disable_depth_peeling
        • Plotter.disable_eye_dome_lighting
        • Plotter.disable_hidden_line_removal
        • Plotter.disable_parallel_projection
        • Plotter.disable_picking
        • Plotter.disable_shadows
        • Plotter.disable_ssao
        • Plotter.disable_stereo_render
        • Plotter.enable
        • Plotter.enable_2d_style
        • Plotter.enable_3_lights
        • Plotter.enable_anti_aliasing
        • Plotter.enable_block_picking
        • Plotter.enable_camera_distortion
        • Plotter.enable_cell_picking
        • Plotter.enable_custom_trackball_style
        • Plotter.enable_depth_of_field
        • Plotter.enable_depth_peeling
        • Plotter.enable_element_picking
        • Plotter.enable_eye_dome_lighting
        • Plotter.enable_fly_to_right_click
        • Plotter.enable_geodesic_picking
        • Plotter.enable_hidden_line_removal
        • Plotter.enable_horizon_picking
        • Plotter.enable_image_style
        • Plotter.enable_interactor_style
        • Plotter.enable_joystick_actor_style
        • Plotter.enable_joystick_style
        • Plotter.enable_lightkit
        • Plotter.enable_mesh_picking
        • Plotter.enable_parallel_projection
        • Plotter.enable_path_picking
        • Plotter.enable_point_picking
        • Plotter.enable_rectangle_picking
        • Plotter.enable_rectangle_through_picking
        • Plotter.enable_rectangle_visible_picking
        • Plotter.enable_rubber_band_2d_style
        • Plotter.enable_rubber_band_style
        • Plotter.enable_shadows
        • Plotter.enable_ssao
        • Plotter.enable_stereo_render
        • Plotter.enable_surface_point_picking
        • Plotter.enable_terrain_style
        • Plotter.enable_trackball_actor_style
        • Plotter.enable_trackball_style
        • Plotter.enable_zoom_style
        • Plotter.export_gltf
        • Plotter.export_html
        • Plotter.export_obj
        • Plotter.export_vrml
        • Plotter.export_vtksz
        • Plotter.fly_to
        • Plotter.fly_to_mouse_position
        • Plotter.generate_orbital_path
        • Plotter.get_default_cam_pos
        • Plotter.get_image_depth
        • Plotter.get_pick_position
        • Plotter.hide_axes
        • Plotter.hide_axes_all
        • Plotter.image_scale_context
        • Plotter.import_3ds
        • Plotter.import_gltf
        • Plotter.import_obj
        • Plotter.import_vrml
        • Plotter.increment_point_size_and_line_width
        • Plotter.isometric_view
        • Plotter.isometric_view_interactive
        • Plotter.key_press_event
        • Plotter.left_button_down
        • Plotter.link_views
        • Plotter.open_gif
        • Plotter.open_movie
        • Plotter.orbit_on_path
        • Plotter.pick_click_position
        • Plotter.pick_mouse_position
        • Plotter.remove_actor
        • Plotter.remove_all_lights
        • Plotter.remove_background_image
        • Plotter.remove_blurring
        • Plotter.remove_bounding_box
        • Plotter.remove_bounds_axes
        • Plotter.remove_chart
        • Plotter.remove_environment_texture
        • Plotter.remove_floors
        • Plotter.remove_legend
        • Plotter.remove_scalar_bar
        • Plotter.render
        • Plotter.reset_camera
        • Plotter.reset_camera_clipping_range
        • Plotter.reset_key_events
        • Plotter.save_graphic
        • Plotter.screenshot
        • Plotter.set_background
        • Plotter.set_chart_interaction
        • Plotter.set_color_cycler
        • Plotter.set_environment_texture
        • Plotter.set_focus
        • Plotter.set_position
        • Plotter.set_scale
        • Plotter.set_viewup
        • Plotter.show
        • Plotter.show_axes
        • Plotter.show_axes_all
        • Plotter.show_bounds
        • Plotter.show_grid
        • Plotter.store_click_position
        • Plotter.store_mouse_position
        • Plotter.subplot
        • Plotter.track_click_position
        • Plotter.track_mouse_position
        • Plotter.unlink_views
        • Plotter.untrack_click_position
        • Plotter.untrack_mouse_position
        • Plotter.update
        • Plotter.update_bounds_axes
        • Plotter.update_scalar_bar_range
        • Plotter.view_isometric
        • Plotter.view_vector
        • Plotter.view_xy
        • Plotter.view_xz
        • Plotter.view_yx
        • Plotter.view_yz
        • Plotter.view_zx
        • Plotter.view_zy
        • Plotter.where_is
        • Plotter.window_size_context
        • Plotter.write_frame
        • Plotter.zoom_camera
      • CameraPosition
        • CameraPosition.focal_point
        • CameraPosition.position
        • CameraPosition.viewup
        • CameraPosition.to_list
      • Renderer
        • Renderer.actors
        • Renderer.axes_enabled
        • Renderer.background_color
        • Renderer.border_color
        • Renderer.border_width
        • Renderer.bounds
        • Renderer.camera
        • Renderer.camera_position
        • Renderer.camera_set
        • Renderer.center
        • Renderer.has_border
        • Renderer.has_charts
        • Renderer.height
        • Renderer.layer
        • Renderer.legend
        • Renderer.length
        • Renderer.lights
        • Renderer.next_color
        • Renderer.parallel_projection
        • Renderer.parallel_scale
        • Renderer.viewport
        • Renderer.width
        • Renderer.add_actor
        • Renderer.add_axes
        • Renderer.add_axes_at_origin
        • Renderer.add_blurring
        • Renderer.add_border
        • Renderer.add_bounding_box
        • Renderer.add_box_axes
        • Renderer.add_chart
        • Renderer.add_floor
        • Renderer.add_legend
        • Renderer.add_legend_scale
        • Renderer.add_light
        • Renderer.add_north_arrow_widget
        • Renderer.add_orientation_widget
        • Renderer.add_ruler
        • Renderer.clear
        • Renderer.clear_actors
        • Renderer.close
        • Renderer.compute_bounds
        • Renderer.deep_clean
        • Renderer.disable
        • Renderer.disable_anti_aliasing
        • Renderer.disable_depth_of_field
        • Renderer.disable_depth_peeling
        • Renderer.disable_eye_dome_lighting
        • Renderer.disable_hidden_line_removal
        • Renderer.disable_parallel_projection
        • Renderer.disable_shadows
        • Renderer.disable_ssao
        • Renderer.enable
        • Renderer.enable_anti_aliasing
        • Renderer.enable_depth_of_field
        • Renderer.enable_depth_peeling
        • Renderer.enable_eye_dome_lighting
        • Renderer.enable_hidden_line_removal
        • Renderer.enable_parallel_projection
        • Renderer.enable_shadows
        • Renderer.enable_ssao
        • Renderer.get_charts
        • Renderer.get_default_cam_pos
        • Renderer.get_pick_position
        • Renderer.hide_axes
        • Renderer.isometric_view
        • Renderer.on_plotter_render
        • Renderer.remove_actor
        • Renderer.remove_all_lights
        • Renderer.remove_blurring
        • Renderer.remove_bounding_box
        • Renderer.remove_bounds_axes
        • Renderer.remove_chart
        • Renderer.remove_environment_texture
        • Renderer.remove_floors
        • Renderer.remove_legend
        • Renderer.reset_camera
        • Renderer.reset_camera_clipping_range
        • Renderer.set_background
        • Renderer.set_chart_interaction
        • Renderer.set_color_cycler
        • Renderer.set_environment_texture
        • Renderer.set_focus
        • Renderer.set_position
        • Renderer.set_scale
        • Renderer.set_viewup
        • Renderer.show_axes
        • Renderer.show_bounds
        • Renderer.show_grid
        • Renderer.update_bounds_axes
        • Renderer.view_isometric
        • Renderer.view_vector
        • Renderer.view_xy
        • Renderer.view_xz
        • Renderer.view_yx
        • Renderer.view_yz
        • Renderer.view_zx
        • Renderer.view_zy
      • RenderWindowInteractor
        • RenderWindowInteractor.initialized
        • RenderWindowInteractor.picker
        • RenderWindowInteractor.style
        • RenderWindowInteractor.add_key_event
        • RenderWindowInteractor.add_observer
        • RenderWindowInteractor.add_pick_observer
        • RenderWindowInteractor.add_timer_event
        • RenderWindowInteractor.clear_events_for_key
        • RenderWindowInteractor.clear_key_event_callbacks
        • RenderWindowInteractor.close
        • RenderWindowInteractor.create_timer
        • RenderWindowInteractor.destroy_timer
        • RenderWindowInteractor.enable_2d_style
        • RenderWindowInteractor.enable_custom_trackball_style
        • RenderWindowInteractor.enable_image_style
        • RenderWindowInteractor.enable_interactor_style
        • RenderWindowInteractor.enable_joystick_actor_style
        • RenderWindowInteractor.enable_joystick_style
        • RenderWindowInteractor.enable_rubber_band_2d_style
        • RenderWindowInteractor.enable_rubber_band_style
        • RenderWindowInteractor.enable_terrain_style
        • RenderWindowInteractor.enable_trackball_actor_style
        • RenderWindowInteractor.enable_trackball_style
        • RenderWindowInteractor.enable_zoom_style
        • RenderWindowInteractor.fly_to
        • RenderWindowInteractor.get_desired_update_rate
        • RenderWindowInteractor.get_event_position
        • RenderWindowInteractor.get_event_subplot_loc
        • RenderWindowInteractor.get_interactor_style
        • RenderWindowInteractor.get_poked_renderer
        • RenderWindowInteractor.initialize
        • RenderWindowInteractor.key_press_event
        • RenderWindowInteractor.poked_subplot
        • RenderWindowInteractor.process_events
        • RenderWindowInteractor.remove_observer
        • RenderWindowInteractor.remove_observers
        • RenderWindowInteractor.reset_picker
        • RenderWindowInteractor.set_render_window
        • RenderWindowInteractor.start
        • RenderWindowInteractor.terminate_app
        • RenderWindowInteractor.track_click_position
        • RenderWindowInteractor.track_mouse_position
        • RenderWindowInteractor.untrack_click_position
        • RenderWindowInteractor.untrack_mouse_position
        • RenderWindowInteractor.update_style
      • Timer
        • Timer.execute
      • Actor
        • Actor.backface_prop
        • Actor.force_opaque
        • Actor.mapper
        • Actor.memory_address
        • Actor.pickable
        • Actor.point_sprite_shape
        • Actor.prop
        • Actor.texture
        • Actor.use_bounds
        • Actor.visibility
        • Actor.add_shader_replacement
        • Actor.clear_point_sprite_shape
        • Actor.clear_shader_replacements
        • Actor.copy
        • Actor.disable_maximum_intensity_projection
        • Actor.enable_maximum_intensity_projection
        • Actor.plot
        • Actor.set_point_sprite_shape
      • DataSetMapper
      • Follower
        • Follower.camera
      • PointGaussianMapper
        • PointGaussianMapper.emissive
        • PointGaussianMapper.scale_array
        • PointGaussianMapper.scale_factor
        • PointGaussianMapper.use_circular_splat
        • PointGaussianMapper.use_default_splat
      • Prop3D
        • Prop3D.bounds
        • Prop3D.center
        • Prop3D.length
        • Prop3D.orientation
        • Prop3D.origin
        • Prop3D.position
        • Prop3D.scale
        • Prop3D.user_matrix
        • Prop3D.copy
        • Prop3D.rotate_x
        • Prop3D.rotate_y
        • Prop3D.rotate_z
        • Prop3D.rotation_from
        • Prop3D.transform
      • Property
        • Property.ambient
        • Property.ambient_color
        • Property.anisotropy
        • Property.anisotropy_rotation
        • Property.color
        • Property.culling
        • Property.diffuse
        • Property.diffuse_color
        • Property.edge_color
        • Property.edge_opacity
        • Property.index_of_refraction
        • Property.interpolation
        • Property.lighting
        • Property.line_width
        • Property.metallic
        • Property.opacity
        • Property.point_shape
        • Property.point_size
        • Property.render_lines_as_tubes
        • Property.render_points_as_spheres
        • Property.representation
        • Property.roughness
        • Property.show_edges
        • Property.specular
        • Property.specular_color
        • Property.specular_power
        • Property.style
        • Property.copy
        • Property.plot
      • Volume
        • Volume.mapper
        • Volume.prop
        • Volume.copy
      • FixedPointVolumeRayCastMapper
      • GPUVolumeRayCastMapper
      • OpenGLGPUVolumeRayCastMapper
      • SmartVolumeMapper
      • UnstructuredGridVolumeRayCastMapper
      • VolumeProperty
        • VolumeProperty.ambient
        • VolumeProperty.diffuse
        • VolumeProperty.independent_components
        • VolumeProperty.interpolation_type
        • VolumeProperty.opacity_unit_distance
        • VolumeProperty.shade
        • VolumeProperty.specular
        • VolumeProperty.specular_power
        • VolumeProperty.apply_lookup_table
        • VolumeProperty.copy
        • VolumeProperty.reapply_lookup_table
      • opacity_transfer_function
      • CornerAnnotation
        • CornerAnnotation.linear_font_scale_factor
        • CornerAnnotation.prop
        • CornerAnnotation.get_text
        • CornerAnnotation.set_text
      • Label
        • Label.relative_position
        • Label.size
      • Text
        • Text.input
        • Text.position
        • Text.prop
      • TextProperty
        • TextProperty.background_color
        • TextProperty.background_opacity
        • TextProperty.bold
        • TextProperty.color
        • TextProperty.font_family
        • TextProperty.font_size
        • TextProperty.frame_color
        • TextProperty.frame_width
        • TextProperty.italic
        • TextProperty.justification_horizontal
        • TextProperty.justification_vertical
        • TextProperty.opacity
        • TextProperty.orientation
        • TextProperty.show_frame
        • TextProperty.enable_shadow
        • TextProperty.set_font_file
        • TextProperty.shallow_copy
      • Axes
        • Axes.origin
        • Axes.hide_actor
        • Axes.hide_symmetric
        • Axes.show_actor
        • Axes.show_symmetric
      • AxesActor
        • AxesActor.bounds
        • AxesActor.center
        • AxesActor.cone_radius
        • AxesActor.cone_resolution
        • AxesActor.cylinder_radius
        • AxesActor.cylinder_resolution
        • AxesActor.label_position
        • AxesActor.labels
        • AxesActor.shaft_length
        • AxesActor.shaft_type
        • AxesActor.sphere_radius
        • AxesActor.sphere_resolution
        • AxesActor.tip_length
        • AxesActor.tip_type
        • AxesActor.total_length
        • AxesActor.visibility
        • AxesActor.x_axis_shaft_properties
        • AxesActor.x_axis_tip_properties
        • AxesActor.x_label
        • AxesActor.y_axis_shaft_properties
        • AxesActor.y_axis_tip_properties
        • AxesActor.y_label
        • AxesActor.z_axis_shaft_properties
        • AxesActor.z_axis_tip_properties
        • AxesActor.z_label
      • AxesAssembly
        • AxesAssembly.label_position
        • AxesAssembly.label_size
        • AxesAssembly.labels
        • AxesAssembly.scale
        • AxesAssembly.scale_mode
        • AxesAssembly.shaft_length
        • AxesAssembly.shaft_radius
        • AxesAssembly.shaft_type
        • AxesAssembly.tip_length
        • AxesAssembly.tip_radius
        • AxesAssembly.tip_type
        • AxesAssembly.user_matrix
        • AxesAssembly.x_color
        • AxesAssembly.x_label
        • AxesAssembly.y_color
        • AxesAssembly.y_label
        • AxesAssembly.z_color
        • AxesAssembly.z_label
        • AxesAssembly.get_actor_prop
        • AxesAssembly.set_actor_prop
      • AxesAssemblySymmetric
        • AxesAssemblySymmetric.labels
        • AxesAssemblySymmetric.x_label
        • AxesAssemblySymmetric.y_label
        • AxesAssemblySymmetric.z_label
      • CubeAxesActor
        • CubeAxesActor.bounds
        • CubeAxesActor.camera
        • CubeAxesActor.center
        • CubeAxesActor.label_offset
        • CubeAxesActor.n_xlabels
        • CubeAxesActor.n_ylabels
        • CubeAxesActor.n_zlabels
        • CubeAxesActor.tick_location
        • CubeAxesActor.title_offset
        • CubeAxesActor.use_2d_mode
        • CubeAxesActor.x_axis_minor_tick_visibility
        • CubeAxesActor.x_axis_range
        • CubeAxesActor.x_axis_visibility
        • CubeAxesActor.x_label_format
        • CubeAxesActor.x_label_visibility
        • CubeAxesActor.x_labels
        • CubeAxesActor.x_title
        • CubeAxesActor.y_axis_minor_tick_visibility
        • CubeAxesActor.y_axis_range
        • CubeAxesActor.y_axis_visibility
        • CubeAxesActor.y_label_format
        • CubeAxesActor.y_label_visibility
        • CubeAxesActor.y_labels
        • CubeAxesActor.y_title
        • CubeAxesActor.z_axis_minor_tick_visibility
        • CubeAxesActor.z_axis_range
        • CubeAxesActor.z_axis_visibility
        • CubeAxesActor.z_label_format
        • CubeAxesActor.z_label_visibility
        • CubeAxesActor.z_labels
        • CubeAxesActor.z_title
        • CubeAxesActor.update_bounds
      • PlanesAssembly
        • PlanesAssembly.camera
        • PlanesAssembly.label_edge
        • PlanesAssembly.label_mode
        • PlanesAssembly.label_offset
        • PlanesAssembly.label_position
        • PlanesAssembly.label_size
        • PlanesAssembly.labels
        • PlanesAssembly.opacity
        • PlanesAssembly.planes
        • PlanesAssembly.x_color
        • PlanesAssembly.x_label
        • PlanesAssembly.y_color
        • PlanesAssembly.y_label
        • PlanesAssembly.z_color
        • PlanesAssembly.z_label
      • create_axes_marker
      • create_axes_orientation_box
      • LookupTable
        • LookupTable.above_range_color
        • LookupTable.above_range_opacity
        • LookupTable.alpha_range
        • LookupTable.annotations
        • LookupTable.below_range_color
        • LookupTable.below_range_opacity
        • LookupTable.cmap
        • LookupTable.hue_range
        • LookupTable.log_scale
        • LookupTable.n_values
        • LookupTable.nan_color
        • LookupTable.nan_opacity
        • LookupTable.ramp
        • LookupTable.saturation_range
        • LookupTable.scalar_range
        • LookupTable.value_range
        • LookupTable.values
        • LookupTable.apply_cmap
        • LookupTable.apply_opacity
        • LookupTable.map_value
        • LookupTable.plot
        • LookupTable.rebuild
        • LookupTable.to_color_tf
        • LookupTable.to_opacity_tf
      • ElementType
      • InterpolationType
      • PointSpriteShape
      • RepresentationType
      • ShaderType
      • BlockAttributes
        • BlockAttributes.color
        • BlockAttributes.opacity
        • BlockAttributes.pickable
        • BlockAttributes.visible
      • CompositeAttributes
        • CompositeAttributes.get_block
        • CompositeAttributes.reset_colors
        • CompositeAttributes.reset_opacities
        • CompositeAttributes.reset_pickabilities
        • CompositeAttributes.reset_visibilities
      • CompositePolyDataMapper
        • CompositePolyDataMapper.block_attr
        • CompositePolyDataMapper.color_missing_with_nan
        • CompositePolyDataMapper.dataset
        • CompositePolyDataMapper.set_scalars
        • CompositePolyDataMapper.set_unique_colors
      • Charts
        • Chart2D
        • ChartBox
        • ChartPie
        • ChartMPL
        • Pen
        • Brush
        • Axis
        • LinePlot2D
        • ScatterPlot2D
        • BarPlot
        • AreaPlot
        • StackPlot
        • BoxPlot
        • PiePlot
      • AffineWidget3D
        • AffineWidget3D.axes
        • AffineWidget3D.origin
        • AffineWidget3D.disable
        • AffineWidget3D.enable
        • AffineWidget3D.remove
      • WidgetComponent
        • WidgetComponent.add_affine_transform_widget
        • WidgetComponent.add_box_widget
        • WidgetComponent.add_camera3d_widget
        • WidgetComponent.add_camera_orientation_widget
        • WidgetComponent.add_checkbox_button_widget
        • WidgetComponent.add_line_widget
        • WidgetComponent.add_logo_widget
        • WidgetComponent.add_measurement_widget
        • WidgetComponent.add_mesh_clip_box
        • WidgetComponent.add_mesh_clip_plane
        • WidgetComponent.add_mesh_isovalue
        • WidgetComponent.add_mesh_slice
        • WidgetComponent.add_mesh_slice_orthogonal
        • WidgetComponent.add_mesh_slice_spline
        • WidgetComponent.add_mesh_threshold
        • WidgetComponent.add_plane_widget
        • WidgetComponent.add_radio_button_widget
        • WidgetComponent.add_slider_widget
        • WidgetComponent.add_sphere_widget
        • WidgetComponent.add_spline_widget
        • WidgetComponent.add_text_slider_widget
        • WidgetComponent.add_volume_clip_plane
        • WidgetComponent.clear_box_widgets
        • WidgetComponent.clear_button_widgets
        • WidgetComponent.clear_camera3d_widgets
        • WidgetComponent.clear_camera_widgets
        • WidgetComponent.clear_line_widgets
        • WidgetComponent.clear_logo_widgets
        • WidgetComponent.clear_measure_widgets
        • WidgetComponent.clear_plane_widgets
        • WidgetComponent.clear_radio_button_widgets
        • WidgetComponent.clear_slider_widgets
        • WidgetComponent.clear_sphere_widgets
        • WidgetComponent.clear_spline_widgets
      • PickingComponent
        • PickingComponent.picked_actor
        • PickingComponent.picked_block_index
        • PickingComponent.picked_cells
        • PickingComponent.picked_mesh
        • PickingComponent.picked_point
        • PickingComponent.disable_picking
        • PickingComponent.enable_block_picking
        • PickingComponent.enable_cell_picking
        • PickingComponent.enable_element_picking
        • PickingComponent.enable_fly_to_right_click
        • PickingComponent.enable_geodesic_picking
        • PickingComponent.enable_horizon_picking
        • PickingComponent.enable_mesh_picking
        • PickingComponent.enable_path_picking
        • PickingComponent.enable_point_picking
        • PickingComponent.enable_rectangle_picking
        • PickingComponent.enable_rectangle_through_picking
        • PickingComponent.enable_rectangle_visible_picking
        • PickingComponent.enable_surface_point_picking
        • PickingComponent.fly_to_mouse_position
        • PickingComponent.get_pick_position
        • PickingComponent.pick_click_position
        • PickingComponent.pick_mouse_position
      • InteractorStyleCaptureMixin
        • InteractorStyleCaptureMixin.add_observer
        • InteractorStyleCaptureMixin.remove_observers
      • InteractorStyleImage
      • InteractorStyleJoystickActor
      • InteractorStyleJoystickCamera
      • InteractorStyleRubberBand2D
      • InteractorStyleRubberBandPick
      • InteractorStyleTerrain
      • InteractorStyleTrackballActor
      • InteractorStyleTrackballCamera
      • InteractorStyleZoom
      • active_scalars_algorithm
      • add_ids_algorithm
      • algorithm_to_mesh_handler
      • callback_algorithm
      • cell_data_to_point_data_algorithm
      • crinkle_algorithm
      • decimation_algorithm
      • extract_surface_algorithm
      • outline_algorithm
      • point_data_to_cell_data_algorithm
      • pointset_to_polydata_algorithm
      • set_algorithm_input
      • smooth_shading_algorithm
      • source_algorithm
      • triangulate_algorithm
      • JupyterBackendRegistration
        • JupyterBackendRegistration.handler
        • JupyterBackendRegistration.name
        • JupyterBackendRegistration.source
      • register_jupyter_backend
      • registered_jupyter_backends
      • set_jupyter_backend
      • _BaseDataSetMapper
        • _BaseDataSetMapper.array_name
        • _BaseDataSetMapper.cmap
        • _BaseDataSetMapper.dataset
        • _BaseDataSetMapper.resolve
        • _BaseDataSetMapper.scalar_range
        • _BaseDataSetMapper.as_rgba
        • _BaseDataSetMapper.clear_active_scalars
        • _BaseDataSetMapper.copy
        • _BaseDataSetMapper.set_active_scalars
        • _BaseDataSetMapper.set_custom_opacity
        • _BaseDataSetMapper.set_scalars
      • _BaseMapper
        • _BaseMapper.array_name
        • _BaseMapper.bounds
        • _BaseMapper.center
        • _BaseMapper.color_mode
        • _BaseMapper.interpolate_before_map
        • _BaseMapper.lookup_table
        • _BaseMapper.scalar_map_mode
        • _BaseMapper.scalar_range
        • _BaseMapper.scalar_visibility
        • _BaseMapper.static
        • _BaseMapper.copy
        • _BaseMapper.update
      • _BaseVolumeMapper
        • _BaseVolumeMapper.blend_mode
        • _BaseVolumeMapper.dataset
        • _BaseVolumeMapper.interpolate_before_map
        • _BaseVolumeMapper.lookup_table
        • _BaseVolumeMapper.scalar_range
      • _NameMixin
        • _NameMixin.name
      • _Prop3DMixin
        • _Prop3DMixin.bounds
        • _Prop3DMixin.center
        • _Prop3DMixin.length
        • _Prop3DMixin.orientation
        • _Prop3DMixin.origin
        • _Prop3DMixin.position
        • _Prop3DMixin.scale
        • _Prop3DMixin.user_matrix
      • _XYZAssembly
        • _XYZAssembly.label_color
        • _XYZAssembly.label_position
        • _XYZAssembly.label_size
        • _XYZAssembly.labels
        • _XYZAssembly.parts
        • _XYZAssembly.show_labels
        • _XYZAssembly.x_color
        • _XYZAssembly.x_label
        • _XYZAssembly.y_color
        • _XYZAssembly.y_label
        • _XYZAssembly.z_color
        • _XYZAssembly.z_label
    • Utilities
      • Geometry
        • Arrow
        • Box
        • Capsule
        • Circle
        • CircularArc
        • CircularArcFromNormal
        • Cone
        • Cube
        • Cylinder
        • CylinderStructured
        • Disc
        • Dodecahedron
        • Ellipse
        • Icosahedron
        • Icosphere
        • KochanekSpline
        • Line
        • MultipleLines
        • Octahedron
        • Plane
        • PlatonicSolid
        • Polygon
        • Pyramid
        • Quadrilateral
        • Rectangle
        • SolidSphere
        • SolidSphereGeneric
        • Sphere
        • Spline
        • StructuredSphere
        • Superquadric
        • Tetrahedron
        • Text3D
        • Triangle
        • Tube
        • Wavelet
        • ArrowSource
        • AxesGeometrySource
        • BoxSource
        • ConeSource
        • CubeFacesSource
        • CubeSource
        • CylinderSource
        • DiscSource
        • LineSource
        • MultipleLinesSource
        • OrthogonalPlanesSource
        • PlaneSource
        • PlatonicSolidSource
        • PolygonSource
        • SphereSource
        • SuperquadricSource
        • Text3DSource
      • Parametric Objects
        • ParametricBohemianDome
        • ParametricBour
        • ParametricBoy
        • ParametricCatalanMinimal
        • ParametricConicSpiral
        • ParametricCrossCap
        • ParametricDini
        • ParametricEllipsoid
        • ParametricEnneper
        • ParametricFigure8Klein
        • ParametricHenneberg
        • ParametricKlein
        • ParametricKuen
        • ParametricMobius
        • ParametricPluckerConoid
        • ParametricPseudosphere
        • ParametricRandomHills
        • ParametricRoman
        • ParametricSuperEllipsoid
        • ParametricSuperToroid
        • ParametricTorus
        • parametric_keywords
        • surface_from_para
      • Mesh Operations
        • create_grid
        • line_segments_from_points
        • lines_from_points
        • make_tri_mesh
        • merge
        • vector_poly_data
        • fit_line_to_points
        • fit_plane_to_points
        • is_inside_bounds
        • principal_axes
        • generate_plane
        • perlin_noise
        • sample_function
      • Image
        • ImageEllipsoidSource
        • ImageGaussianSource
        • ImageGridSource
        • ImageMandelbrotSource
        • ImageNoiseSource
        • ImageSinusoidSource
        • compare_images
      • Transformations
        • Transform
        • axis_rotation
        • cartesian_to_spherical
        • grid_from_sph_coords
        • spherical_to_cartesian
        • transform_vectors_sph_to_cart
      • Arrays
        • cell_array
        • field_array
        • get_array
        • get_array_association
        • point_array
        • set_default_active_scalars
        • set_default_active_vectors
        • array_from_vtkmatrix
        • convert_array
        • pyvista_ndarray
        • vtk_points
        • vtkmatrix_from_array
      • Conversions
        • is_pyvista_dataset
        • wrap
        • from_meshio
        • is_meshio_mesh
        • read_meshio
        • save_meshio
        • to_meshio
        • from_trimesh
        • is_trimesh_mesh
        • to_trimesh
      • Colors
        • Color
        • ColorLike
        • get_cmap_safe
        • Named Colors
        • Named Colormaps
      • Errors and Warnings
        • AmbiguousDataError
        • DeprecationError
        • InvalidCameraError
        • InvalidMeshError
        • InvalidMeshWarning
        • MissingDataError
        • NotAllTrianglesError
        • PointSetCellOperationError
        • PointSetDimensionReductionError
        • PointSetNotSupported
        • PrecisionWarning
        • PyVistaAttributeError
        • PyVistaDeprecationWarning
        • PyVistaEfficiencyWarning
        • PyVistaFutureWarning
        • PyVistaPipelineError
        • RenderWindowUnavailable
        • VTKExecutionError
        • VTKExecutionWarning
        • VTKVersionError
        • Observer
        • ProgressMonitor
        • VtkErrorCatcher
        • send_errors_to_logging
        • set_error_output_file
      • Environment
        • vtk_backend
        • GPUInfo
        • Report
        • get_gpu_info
        • allow_new_attributes
        • enable_smp_tools
        • set_new_attribute
        • set_pickle_format
        • vtk_snake_case
        • vtk_verbosity
    • Readers and Writers
      • get_reader
      • get_ext
      • read
      • read_exodus
      • read_grdecl
      • read_texture
      • AVSucdReader
      • BinaryMarchingCubesReader
      • BMPReader
      • BYUReader
      • CGNSReader
        • CGNSReader.base_array_names
        • CGNSReader.distribute_blocks
        • CGNSReader.family_array_names
        • CGNSReader.load_boundary_patch
        • CGNSReader.number_base_arrays
        • CGNSReader.number_family_arrays
        • CGNSReader.unsteady_pattern
        • CGNSReader.vector_3d
        • CGNSReader.base_array_status
        • CGNSReader.disable_all_bases
        • CGNSReader.disable_all_families
        • CGNSReader.enable_all_bases
        • CGNSReader.enable_all_families
        • CGNSReader.family_array_status
      • DEMReader
      • DICOMReader
      • EnSightReader
        • EnSightReader.active_time_set
        • EnSightReader.active_time_value
        • EnSightReader.number_time_points
        • EnSightReader.set_active_time_point
        • EnSightReader.set_active_time_set
        • EnSightReader.set_active_time_value
        • EnSightReader.time_point_value
      • ExodusIIBlockSet
        • ExodusIIBlockSet.array_names
        • ExodusIIBlockSet.names
        • ExodusIIBlockSet.number
        • ExodusIIBlockSet.number_arrays
        • ExodusIIBlockSet.array_status
        • ExodusIIBlockSet.disable
        • ExodusIIBlockSet.disable_all
        • ExodusIIBlockSet.disable_all_arrays
        • ExodusIIBlockSet.disable_array
        • ExodusIIBlockSet.enable
        • ExodusIIBlockSet.enable_all
        • ExodusIIBlockSet.enable_all_arrays
        • ExodusIIBlockSet.enable_array
        • ExodusIIBlockSet.status
      • ExodusIIReader
        • ExodusIIReader.active_time_value
        • ExodusIIReader.animate_mode_shapes
        • ExodusIIReader.cell_array_names
        • ExodusIIReader.edge_blocks
        • ExodusIIReader.element_blocks
        • ExodusIIReader.element_sets
        • ExodusIIReader.face_blocks
        • ExodusIIReader.face_sets
        • ExodusIIReader.global_array_names
        • ExodusIIReader.node_sets
        • ExodusIIReader.number_cell_arrays
        • ExodusIIReader.number_global_arrays
        • ExodusIIReader.number_point_arrays
        • ExodusIIReader.number_side_set_arrays
        • ExodusIIReader.number_time_points
        • ExodusIIReader.point_array_names
        • ExodusIIReader.side_set_array_names
        • ExodusIIReader.side_sets
        • ExodusIIReader.time_values
        • ExodusIIReader.cell_array_status
        • ExodusIIReader.disable_all_global_arrays
        • ExodusIIReader.disable_all_side_set_arrays
        • ExodusIIReader.disable_cell_array
        • ExodusIIReader.disable_displacements
        • ExodusIIReader.disable_global_array
        • ExodusIIReader.disable_point_array
        • ExodusIIReader.disable_side_set_array
        • ExodusIIReader.enable_all_global_arrays
        • ExodusIIReader.enable_all_side_set_arrays
        • ExodusIIReader.enable_cell_array
        • ExodusIIReader.enable_displacements
        • ExodusIIReader.enable_global_array
        • ExodusIIReader.enable_point_array
        • ExodusIIReader.enable_side_set_array
        • ExodusIIReader.global_array_status
        • ExodusIIReader.point_array_status
        • ExodusIIReader.read_global
        • ExodusIIReader.set_active_time_point
        • ExodusIIReader.set_active_time_value
        • ExodusIIReader.side_set_array_status
        • ExodusIIReader.time_point_value
      • FacetReader
      • FLUENTCFFReader
      • FluentReader
      • GambitReader
      • GaussianCubeReader
        • GaussianCubeReader.b_scale
        • GaussianCubeReader.hb_scale
        • GaussianCubeReader.read
      • GESignaReader
      • GIFReader
      • GLTFReader
      • GRDECLReader
        • GRDECLReader.elevation
        • GRDECLReader.other_keywords
      • HDFReader
      • HDRReader
      • JPEGReader
      • MetaImageReader
      • MFIXReader
      • MINCImageReader
      • MultiBlockPlot3DReader
        • MultiBlockPlot3DReader.auto_detect_format
        • MultiBlockPlot3DReader.gamma
        • MultiBlockPlot3DReader.preserve_intermediate_functions
        • MultiBlockPlot3DReader.r_gas_constant
        • MultiBlockPlot3DReader.add_function
        • MultiBlockPlot3DReader.add_q_files
        • MultiBlockPlot3DReader.remove_all_functions
        • MultiBlockPlot3DReader.remove_function
      • Nek5000Reader
        • Nek5000Reader.active_time_point
        • Nek5000Reader.active_time_value
        • Nek5000Reader.cell_array_names
        • Nek5000Reader.number_cell_arrays
        • Nek5000Reader.number_time_points
        • Nek5000Reader.time_values
        • Nek5000Reader.cell_array_status
        • Nek5000Reader.disable_all_cell_arrays
        • Nek5000Reader.disable_cell_array
        • Nek5000Reader.disable_merge_points
        • Nek5000Reader.disable_spectral_element_ids
        • Nek5000Reader.enable_all_cell_arrays
        • Nek5000Reader.enable_cell_array
        • Nek5000Reader.enable_merge_points
        • Nek5000Reader.enable_spectral_element_ids
        • Nek5000Reader.set_active_time_point
        • Nek5000Reader.set_active_time_value
        • Nek5000Reader.time_point_value
      • NIFTIReader
      • NRRDReader
      • OBJReader
      • OpenFOAMReader
        • OpenFOAMReader.active_time_value
        • OpenFOAMReader.all_patch_arrays_status
        • OpenFOAMReader.cell_to_point_creation
        • OpenFOAMReader.decompose_polyhedra
        • OpenFOAMReader.number_patch_arrays
        • OpenFOAMReader.number_time_points
        • OpenFOAMReader.patch_array_names
        • OpenFOAMReader.skip_zero_time
        • OpenFOAMReader.disable_all_patch_arrays
        • OpenFOAMReader.disable_patch_array
        • OpenFOAMReader.enable_all_patch_arrays
        • OpenFOAMReader.enable_patch_array
        • OpenFOAMReader.patch_array_status
        • OpenFOAMReader.set_active_time_point
        • OpenFOAMReader.set_active_time_value
        • OpenFOAMReader.time_point_value
      • ParticleReader
        • ParticleReader.endian
      • PDBReader
      • PExodusIIReader
      • Plot3DMetaReader
      • PLYReader
      • PNGReader
      • PNMReader
      • POpenFOAMReader
        • POpenFOAMReader.case_type
      • ProStarReader
      • PTSReader
      • PVDReader
        • PVDReader.active_datasets
        • PVDReader.active_readers
        • PVDReader.active_time_value
        • PVDReader.datasets
        • PVDReader.number_time_points
        • PVDReader.time_values
        • PVDReader.set_active_time_point
        • PVDReader.set_active_time_value
        • PVDReader.time_point_value
      • SegYReader
      • SeriesReader
        • SeriesReader.active_dataset
        • SeriesReader.active_reader
        • SeriesReader.active_time_value
        • SeriesReader.datasets
        • SeriesReader.number_time_points
        • SeriesReader.time_values
        • SeriesReader.set_active_time_point
        • SeriesReader.set_active_time_value
        • SeriesReader.time_point_value
      • SLCReader
      • STLReader
      • TecplotReader
      • ThreeDSReader
      • TIFFReader
      • VRMLReader
      • VTKDataSetReader
      • VTKPDataSetReader
      • XdmfReader
        • XdmfReader.active_time_value
        • XdmfReader.number_grids
        • XdmfReader.number_time_points
        • XdmfReader.time_values
        • XdmfReader.set_active_time_point
        • XdmfReader.set_active_time_value
        • XdmfReader.time_point_value
      • XMLImageDataReader
      • XMLMultiBlockDataReader
      • XMLPartitionedDataSetReader
      • XMLPImageDataReader
      • XMLPolyDataReader
      • XMLPRectilinearGridReader
      • XMLPUnstructuredGridReader
      • XMLRectilinearGridReader
      • XMLStructuredGridReader
      • XMLUnstructuredGridReader
      • BaseWriter
        • BaseWriter.data_object
        • BaseWriter.path
        • BaseWriter.writer
        • BaseWriter.written_path
        • BaseWriter.write
      • BMPWriter
      • DataSetWriter
      • EnSightWriter
        • EnSightWriter.path
      • HDFWriter
      • HoudiniPolyDataWriter
      • IVWriter
      • JPEGWriter
      • NIFTIImageWriter
      • OBJWriter
      • PLYWriter
        • PLYWriter.texture
      • PNGWriter
      • PNMWriter
      • PolyDataWriter
      • RectilinearGridWriter
      • SimplePointsWriter
      • STLWriter
      • StructuredGridWriter
      • TIFFWriter
      • UnstructuredGridWriter
      • XMLImageDataWriter
      • XMLMultiBlockDataWriter
      • XMLPartitionedDataSetWriter
      • XMLPolyDataWriter
      • XMLRectilinearGridWriter
      • XMLStructuredGridWriter
      • XMLUnstructuredGridWriter
      • BaseReader
        • BaseReader.path
        • BaseReader.reader
        • BaseReader.hide_progress
        • BaseReader.read
        • BaseReader.show_progress
      • BaseVTKReader
      • _DataFormatMixin
        • _DataFormatMixin.data_format
        • _DataFormatMixin.writer
      • _FileIOBase
        • _FileIOBase.extension_patterns
        • _FileIOBase.extensions
        • _FileIOBase.path
      • PointCellDataSelection
        • PointCellDataSelection.all_cell_arrays_status
        • PointCellDataSelection.all_point_arrays_status
        • PointCellDataSelection.cell_array_names
        • PointCellDataSelection.number_cell_arrays
        • PointCellDataSelection.number_point_arrays
        • PointCellDataSelection.point_array_names
        • PointCellDataSelection.cell_array_status
        • PointCellDataSelection.disable_all_cell_arrays
        • PointCellDataSelection.disable_all_point_arrays
        • PointCellDataSelection.disable_cell_array
        • PointCellDataSelection.disable_point_array
        • PointCellDataSelection.enable_all_cell_arrays
        • PointCellDataSelection.enable_all_point_arrays
        • PointCellDataSelection.enable_cell_array
        • PointCellDataSelection.enable_point_array
        • PointCellDataSelection.point_array_status
      • PVDDataSet
        • PVDDataSet.time
        • PVDDataSet.part
        • PVDDataSet.path
        • PVDDataSet.group
      • SeriesDataSet
        • SeriesDataSet.name
        • SeriesDataSet.time
      • TimeReader
        • TimeReader.active_time_value
        • TimeReader.number_time_points
        • TimeReader.time_values
        • TimeReader.set_active_time_point
        • TimeReader.set_active_time_value
        • TimeReader.time_point_value
      • _XMLWriter
        • _XMLWriter.compression
      • Reader Enumerations
    • Examples & Datasets
      • examples
        • load_airplane
        • load_ant
        • load_channels
        • load_explicit_structured
        • load_frog_tissues
        • load_globe
        • load_globe_texture
        • load_hexbeam
        • load_hydrogen_orbital
        • load_logo
        • load_nut
        • load_random_hills
        • load_rectilinear
        • load_sphere
        • load_sphere_vectors
        • load_spline
        • load_structured
        • load_tetbeam
        • load_uniform
      • downloads
        • delete_downloads
        • download_3gqp
        • download_action_figure
        • download_aero_bracket
        • download_angular_sector
        • download_antarctica_velocity
        • download_armadillo
        • download_avocado
        • download_backward_facing_step
        • download_beach
        • download_biplane
        • download_bird
        • download_bird_bath
        • download_bird_texture
        • download_black_vase
        • download_blood_vessels
        • download_blow
        • download_bolt_nut
        • download_brain
        • download_brain_atlas_with_sides
        • download_bunny
        • download_bunny_coarse
        • download_cad_model
        • download_cad_model_case
        • download_caffeine
        • download_cake_easy
        • download_cake_easy_texture
        • download_can_crushed_hdf
        • download_can_crushed_vtu
        • download_carburetor
        • download_carotid
        • download_cavity
        • download_cells_nd
        • download_cgns_multi
        • download_cgns_structured
        • download_chest
        • download_cloud_dark_matter
        • download_cloud_dark_matter_dense
        • download_clown
        • download_coastlines
        • download_coil_magnetic_field
        • download_cow
        • download_cow_head
        • download_crater_imagery
        • download_crater_topo
        • download_cubemap_park
        • download_cubemap_space_16k
        • download_cubemap_space_4k
        • download_cylinder_crossflow
        • download_damaged_helmet
        • download_damavand_volcano
        • download_delaunay_example
        • download_dicom_stack
        • download_dikhololo_night
        • download_disc_quads
        • download_dolfin
        • download_doorman
        • download_dragon
        • download_drill
        • download_dual_sphere_animation
        • download_e07733s002i009
        • download_electronics_cooling
        • download_embryo
        • download_emoji
        • download_emoji_texture
        • download_exodus
        • download_face
        • download_face2
        • download_faults
        • download_fea_bracket
        • download_fea_hertzian_contact_cylinder
        • download_file
        • download_filled_contours
        • download_flamingo
        • download_foot_bones
        • download_frd
        • download_frog
        • download_full_head
        • download_gearbox
        • download_gears
        • download_gif_simple
        • download_gourds
        • download_gourds_pnm
        • download_gourds_texture
        • download_gpr_data_array
        • download_gpr_path
        • download_grasshopper
        • download_great_white_shark
        • download_grey_nurse_shark
        • download_guitar
        • download_head
        • download_head_2
        • download_headsq
        • download_honolulu
        • download_horse
        • download_horse_points
        • download_human
        • download_iron_protein
        • download_ivan_angel
        • download_kitchen
        • download_knee
        • download_knee_full
        • download_letter_a
        • download_letter_k
        • download_lidar
        • download_lincoln_life_mask
        • download_lobster
        • download_louis_louvre
        • download_lshape
        • download_lucy
        • download_m4_total_density
        • download_masonry_texture
        • download_meshio_xdmf
        • download_milk_truck
        • download_model_with_variance
        • download_moonlanding_image
        • download_motor
        • download_mount_damavand
        • download_mug
        • download_naca
        • download_nefertiti
        • download_nek5000
        • download_notch_displacement
        • download_notch_stress
        • download_oblique_cone
        • download_office
        • download_openfoam_tubes
        • download_owl
        • download_parallel_exodus
        • download_parched_canal_4k
        • download_particles
        • download_particles_lethe
        • download_pepper
        • download_pine_roots
        • download_plastic_vase
        • download_poly_line
        • download_prism
        • download_prostar
        • download_prostate
        • download_pump_bracket
        • download_puppy
        • download_puppy_texture
        • download_quadratic_pyramid
        • download_rectilinear_grid
        • download_reservoir
        • download_rgba_texture
        • download_room_cff
        • download_room_surface_mesh
        • download_saddle_surface
        • download_sea_vase
        • download_sextant
        • download_shark
        • download_single_sphere_animation
        • download_sky_box_cube_map
        • download_sky_box_nz
        • download_sky_box_nz_texture
        • download_sparse_points
        • download_spider
        • download_st_helens
        • download_stars_cloud_hyg
        • download_structured_grid
        • download_structured_grid_two
        • download_t3_grid_0
        • download_teapot
        • download_teapot_vrml
        • download_tecplot_ascii
        • download_tensors
        • download_tetra_dc_mesh
        • download_tetrahedron
        • download_thermal_probes
        • download_topo_global
        • download_topo_land
        • download_torso
        • download_tri_quadratic_hexahedron
        • download_trumpet
        • download_turbine_blade
        • download_unstructured_grid
        • download_urn
        • download_usa
        • download_usa_texture
        • download_victorian_goblet_face_illusion
        • download_vtk
        • download_vtk_logo
        • download_warping_spheres
        • download_washington_bust
        • download_wavy
        • download_whole_body_ct_female
        • download_whole_body_ct_male
        • download_woman
        • download_yinyang
        • file_from_files
      • planets
        • download_jupiter_surface
        • download_mars_surface
        • download_mercury_surface
        • download_milkyway_sky_background
        • download_moon_surface
        • download_neptune_surface
        • download_pluto_surface
        • download_saturn_rings
        • download_saturn_surface
        • download_stars_sky_background
        • download_sun_surface
        • download_uranus_surface
        • download_venus_surface
        • load_earth
        • load_jupiter
        • load_mars
        • load_mercury
        • load_moon
        • load_neptune
        • load_planet
        • load_planet_rings
        • load_pluto
        • load_saturn
        • load_saturn_rings
        • load_sun
        • load_uranus
        • load_venus
      • get_example
      • Example
        • Example.readers
        • Example.name
        • Example.function
        • Example.paths
        • Example.file_sizes
        • Example.source_urls
        • Example.load
      • Dataset Gallery
      • cells
        • BezierCurve
        • BezierHexahedron
        • BezierQuadrilateral
        • BezierTetrahedron
        • BezierTriangle
        • BezierWedge
        • BiQuadraticQuadraticHexahedron
        • BiQuadraticQuadraticWedge
        • BiQuadraticQuadrilateral
        • BiQuadraticTriangle
        • ConvexPointSet
        • CubicLine
        • Empty
        • HexagonalPrism
        • Hexahedron
        • LagrangeCurve
        • LagrangeHexahedron
        • LagrangeQuadrilateral
        • LagrangeTetrahedron
        • LagrangeTriangle
        • LagrangeWedge
        • Line
        • PentagonalPrism
        • Pixel
        • PolyLine
        • PolyVertex
        • Polygon
        • Polyhedron
        • Pyramid
        • QuadraticEdge
        • QuadraticHexahedron
        • QuadraticLinearQuadrilateral
        • QuadraticLinearWedge
        • QuadraticPolygon
        • QuadraticPyramid
        • QuadraticQuadrilateral
        • QuadraticTetrahedron
        • QuadraticTriangle
        • QuadraticWedge
        • Quadrilateral
        • Tetrahedron
        • TriQuadraticHexahedron
        • TriQuadraticPyramid
        • Triangle
        • TriangleStrip
        • Vertex
        • Voxel
        • Wedge
        • generate_cell_blocks
        • plot_cell
      • demos
        • glyphs
        • orientation_cube
        • orientation_plotter
        • plot_ants_plane
        • plot_beam
        • plot_datasets
        • plot_glyphs
        • plot_wave
    • Command Line
      • pyvista plot
      • pyvista compare
      • pyvista convert
      • pyvista validate
      • pyvista report
  • Extras
    • Building VTK
    • PyVista Within a Docker Container
    • Freezing PyVista With PyInstaller
    • Sphinx PyVista Plot Directive
    • Open Graph Link Previews
    • Sphinx VTK Role
    • Sphinx Examples-as-Code
    • PyVista pytest Plugin
    • Input Validation
    • Using Local pyvista/data
    • Extending PyVista
  • Contributing

Page not found

Try the search page, the API reference, or the examples gallery.

Backed by CoDimensional PBC

By Alex Kaszynski and Bane Sullivan

© Copyright 2017-2026, The PyVista Developers.