What's Changed

Bug fixes or behavior changes

Full Changelog:v0.45.1...v0.45.2

See#7508

Full Changelog:v0.45.0...v0.45.1

Highlights

• VTK 9.4.2 is now supported
• Python 3.13 now supported
• Support for Python 3.8 has been dropped

New Filters

• PolyDataFilters.ruled_surface
• PolyDataFilters.decimate_polyline
• PolyDataFilters.flip_faces (replacement forflip_normals which is now deprecated)
• PolyDataFilters.flip_normal_vectors
• ImageDataFilters.label_connectivity
• ImageDataFilters.resample
• ImageDataFilters.select_values
• ImageDataFilters.contour_labels (replacement forcontour_labeled which is now deprecated)
• DatasetFilters.align_xyz
• DataSetFilters.color_labels
• DataSetFilters.bounding_box
• DataSetFilters.oriented_bounding_box
• DataSetFilters.voxelize_binary_mask
• CompositeFilters.generic_filter
• DataObjectFilters.cell_quality (replacement forcompute_cell_quality which is now deprecated)

Improved Transformations

• NewTransform class for working with transformation matrices
• UsingDataObjectFilters.transform withImageData now returnsImageData instead ofStructuredGrid
• TheDataObjectFilters.transform filter is generalized to work withMultiBlock meshes
• NewDataObjectFilters.rotate filter for rotating meshes
• NewProp3D.rotation_from method for rotating actors

NewMultiBlock Methods and Properties

• recursive_iterator
• flatten
• nested_block_types
• is_homogeneous
• is_heterogeneous
• as_unstructured_grid_blocks
• is_empty

NewImageData Properties

• index_to_physical_matrix
• physical_to_index_matrix
• direction_matrix
• dimensionality
• offset

New Utilities

• principal_axes for computing best-fit axes
• fit_line_to_points for computing a best-fit line
• cell_quality_info helper to complement thecell_quality filter with additional information
• vtk_verbosity to control the output fromvtkLogger
• vtk_snake_case to control if PyVista classes can use the new snake case API from VTK 9.4

Documentation Improvements

• New overall look: PyVista now uses theSphinx Book Theme
• New vector graphics and high-resolution versions of thePyVista logo
• Add cell descriptions and examples toCellType
• NewNamed Colors page with new colors fromvtkNamedColors; similar colors are also now grouped together
• Newtags added to examples in the Sphinx Gallery

Plotting Features

• New widgetPlotter.add_radio_button_widget for radio buttons
• New assemblyPlanesAssembly for plotting orthogonal planes

File IO

• New readers for Exodus II, Nek5000, and Grid Eclipse (GRDECL) formats
• Supportread andsave with pickled meshes (.pkl).

New Sphinx Gallery Examples

• Create Sphere Mesh Multiple Ways
• Visualize Anatomical Groups

New Downloadable Datasets

• download_biplane
• download_full_head
• download_grasshopper
• download_great_white_shark
• download_grey_nurse_shark

What's Changed

Breaking Changes

• Simplify code forfit_plane_to_points, fix crash with many points, fix returned center by@user27182 in#6517
• Add return info toset_default_active_scalars andset_default_active_vectors by@user27182 in#6919
• Makecheck_contains API easier to use and understand by@user27182 in#6939
• ReturnImageData when transformingImageData by@user27182 in#6616
• Fix empty input behavior forextract_values and remove redundant scalar validation by@user27182 in#7001
• Use 'static_cell' as default forsample filter by@MatthewFlamm in#7121
• Load decimated versions of large downloaded datasets by default by@user27182 in#7146
• Use downsampled versions of whole body ct datasets by@user27182 in#7131
• Add parameters to Polydata.triangulate filter by@beroda in#7317
• Prepend pyvista to plot directive configuration options by@akaszynski in#7365

New Features

• AddProp3D.rotation_from method to support arbitrary rotations by@user27182 in#6318
• Addset_actor_prop andget_actor_prop toAxesAssembly for setting/getting part properties by@user27182 in#6342
• Add extra coordinate specifications inPlaneSource by@tkoyama010 in#6372
• Addrelative_position andProp3D-like features toLabel class by@user27182 in#6373
• AddProp3DMixin toAxesAssembly class by@user27182 in#6389
• AddOrthogonalPlanesSource for generating orthogonal planes by@user27182 in#6366
• AddPlanesAssembly class adding orthogonal planes to a scene by@user27182 in#6379
• Addcategorical parameter topoint_data_to_cell_data() by@nicolascedilnik in#6407
• Replace type aliasBoundsLike with named tupleBoundsTuple by@user27182 in h...

Contributors

Limit VTK<9.4.0

Full Changelog:v0.44.1...v0.44.2

Patch release with the following fixes/quality of life changes. This being a patch fix, there are no API changes.

What's Changed

Full Changelog:v0.44.0...v0.44.1

Highlights

• Ensure compatibility with NumPy 2.0
• Method Resolution Order compatibility for upcoming VTK 9.4#5650 (preparation work to ensure some minimum level of compatibility with upcoming changes to VTK)
• Add Image Source module to create example images.

What's Changed

Breaking Changes

• Add parallel_projection and parallel_scale to Theme; makecamera setting a first class_ThemeConfig by@MatthewFlamm in#5624
• Ensure no overlap with crinkle clip by@banesullivan in#6060
• Fix active normals for propertiespoint_normals,cell_normals, and methodplot_normals withsmooth_shading by@user27182 in#6062

New Features

• Scale array for points gaussian by@kmarchais in#4366
• Add Paraview-like 2D interactor style by@MatthewFlamm in#5336
• InheritXdmfReader class fromTimeReader to improve time properties by@tkoyama010 in#5332
• Addoutline_opacity toadd_plane_widget by@tkoyama010 in#5354
• Addfrom_irregular_faces toPolyData by@darikg in#5375
• Addfont_family param toadd_legend function by@tkoyama010 in#5396
• Add Victorian Goblet face illusion example by@tkoyama010 in#5403
• Add italic and bold property toTextPropery by@tkoyama010 in#5408
• Add text justification option toadd_point_labels by@tkoyama010 in#5407
• Trame Plotter UI: Menu positioning by@annehaley in#5429
• Add custom trackball style and refactoringenable_2d_style by@MatthewFlamm in#5428
• Allow computing number of cell vertices incompute_cell_sizes by@MatthewFlamm in#5474
• Add support tomeshio'spolyhedronX cell types by@keurfonluu in#5369
• Fix EnSight reader time set selection by@advktEntnschdl in#5492
• Update CellArray to use ImportLegacyFormat by@darikg in#5495
• Addbackground_opacity argument toadd_legend by@tkoyama010 in#5509
• AddCubeSource algorithm class to represent cube by@tkoyama010 in#5526
• AddDiscSource algorithm class to represent disc by@tkoyama010 in#5531
• AddLineSource algorithm class to represent line by@tkoyama010 in#5534
• AddSphereSource algorithm class to represent sphere by@tkoyama010 in#5535
• AddPolygonSource algorithm class of polygon by@tkoyama010 in#5539
• AddPlatonicSolidSource platonic solid algorithm by@tkoyama010 in#5547
• AddPlaneSource to add plane algorithm source by@tkoyama010 in#5562
• Add thecamera3d_widget allow to move the camera by@tkoyama010 in#5577
• Legend improvements by@germa89 in#3015
• Addcompute_boundary_cell_quality DataSet method by@tkoyama010 in#5595
• AddBoxSource to add box algorithm source by@tkoyama010 in#5620
• AddArrowSource to add arrow algorithm source by@tkoyama010 in#5622
• AddSuperquadricSource to add arrow algorithm by@tkoyama010 in#5648
• Addget_charts method toRenderer by@kmarchais in#5656
• Addpoint_dtype toCube andCubeSource class by@tkoyama010 in#5676
• Add capsule geometry use vtkCapsuleSource and vtkCylinderSource withSetCapsuleCap by@kmarchais in#5655
• Addadd_box_axes to avoid complexity of add_axes by@tkoyama010 in#5605
• Add bounds to view methods on renderer by@MattTheCuber in#5730
• Allow setting and getting string scalar field data by@user27182 in#5747
• AddRendererviewport setter to control layout by@tkoyama010 in#5773
• Allow reading DICOM stack from directory withpv.read() by@user27182 in#5776
• Addresolve property toDataSetMapper class by@tkoyama010 in#5781
• Allow users to specify Trame Jupyter Mode in environment variable by@annehaley in#5798
• Add composite datasetPartitionedDataSet class by@tkoyama010 in#5833
• Add partition readerXMLPartitionedDataSetReader by@tkoyama010 in#5873
• Add CT image whole body segmentation dataset by@user27182 in#5910
• Add UNISIM-II-D reservoir model reservoir dataset by@user27182 in#5902
• Trame UI: add parallel projection toggle by@banesullivan in#5882
• Adduser_dict property toDataSet objects for storing user-specified data by@user27182 in#5933
• Addsigmoid_15 andsigmoid_20 opacity transfer functions by@user27182 in#5944
• Add Fluent CFF ReaderFLUENTCFFReader class by@tkoyama010 in#5953
• Addclamping option toto_opacity_tf method by@tkoyama010 in#5975
• Addextract_values filter and updateconnectivity filter to use it by@user27182 in#5963
• Add color mode option toglyph method of DataSet by@tkoyama010 in#5985
• Adddownload_headsq to download headsq dataset by@tkoyama010 in#5990
• AddImageEllipsoidSource to create ellipsoid img by@tkoyama010 in#5987
• AddImageMandelbrotSource to create Mandelbrot by@tkoyama010 in#5996
• AddImageNoiseSource to create noise image by@tkoyama010 in#5999
• AddImageSinusoidSource to create sinusoidal img by@tkoyama010 in#6000
• AddImageGaussianSource of image with Gaussian by@tkoyama010 in#6004
• AddGambitReader reads dataset in Fluent GAMBIT by@tkoyama010 in#6026
• Add ASCII gaussian cube dataGaussianCubeReader by@tkoyama010 in#5967
• AddMINCImageReader NetCDF-based img file format by@tkoyama010 in#6041
• Updateextract_values API and add newsplit_values filter by@user27182 in#6001
• AddPDBReader class read Molecular Data files by@tkoyama010 in#6038
• AddGESignaReader class read GE Signa ximg files by@tkoyama010 in#6043
• Allow clearing cell and point data for all blocks by@tkoyama010 in#6046
• AllowPlotter class to imports 3D Studio files by@tkoyama010 in#6054
• Addpad_image filter generating closed surfaces by@user27182 in#6051
• AllowPlotter class to imports obj files by@tkoyama010 in#6068
• vtkContourTriangulator: fill polyline contours by@banesullivan in#6059
• Add support write polygonal data to Houdini file by@tkoyama010 in#6085
• Addscale argument toPlotter.add_ruler method by@tkoyama010 in#6096
• AddParticleReader to read particle data by@tkoyama010 in#6040
• Addpoints_to_cells andcells_to_points ImageDataFilters by@user27182 in#6071
• Add support save polygonal data to obj file by@tkoyama010 in#6111
• Add support save polygonal data to OpenInventor by@tkoyama010 in#6113
• AddProStarReader to read unstructured grid data by@tkoyama010 in#6120
• Addseed param toImageNoiseSource and update default values by@user27182 in#6170
• Addorigin andlength toProp3D and add details to docstrings by@user27182 in#6194
• Addlabels property toAxesActor for convenience by@user27182 in#6231
• Geographic north arrow orientation marker by@banesullivan in#6070
• Add `protein_ribbons...

Contributors

Patch release with the following fixes/quality of life changes. This being a patch fix, there are no API changes.

What's Changed

• Fixcast_to_unstructured_grid forPointSet by@user27182#6127
• Usematplotlib.pyplot.get_cmap for matplotlib>3.8 by@tkoyama010#6163
• Fix typo ofadd_orientation_widget docstring by@tkoyama010#6174
• Fiximage_threshold bug with integer arrays on some systems by@user27182#6100
• Ensure compatibility with NumPy 2.0 by@adeak#6156
• Fixadd_ruler number_labels to turn off the auto by@MatthewFlamm#6258

Full Changelog:v0.43.9...v0.43.10

Contributors

Patch release with the following fixes/quality of life changes. This being a patch fix, there are no API changes.

What's Changed

• "PyQt6-Qt6!=6.6.0,!=6.7.0" "PyQt6!=6.6.0" to fix PyVistaQt and MNE-Python integration tests by@tkoyama010#6182
• Temporarily restrict NumPy version in pyproject.toml by@adeak#6210

Full Changelog:v0.43.8...v0.43.9

Contributors

Patch release with the following fixes/quality of life changes. This being a patch fix, there are no API changes.

What's Changed

• Ensure no overlap with crinkle clip by@banesullivan#6060
• Fix active normals for propertiespoint_normals,cell_normals, and methodplot_normals withsmooth_shading by@user27182#6062
• Add missingload parameter to some example downloads by@tkoyama010#6078

Full Changelog:v0.43.7...v0.43.8

Contributors

Patch release with the following fixes/quality of life changes. This being a patch fix, there are no API changes.

What's Changed

• Use n_points to calculate distance in CircularArc@tkoyama010#6025

Full Changelog:v0.43.6...v0.43.7

Contributors