add_mesh_threshold

Plotter.add_mesh_threshold(mesh, scalars=None, invert=False, widget_color=None, preference='cell', title=None, pointa=(0.4, 0.9), pointb=(0.9, 0.9), continuous=False, **kwargs)

Apply a threshold on a mesh with a slider.

Add a mesh to the scene with a slider widget that is used to threshold the mesh interactively.

The threshold mesh is saved to the .threshold_meshes attribute on the plotter.

Parameters
meshpyvista.DataSet

The input dataset to add to the scene and threshold.

scalarsstr, optional

The string name of the scalars on the mesh to threshold and display.

invertbool, optional

Invert (flip) the threshold.

widget_colorstr or sequence, optional

Color of the widget. Either a string, RGB sequence, or hex color string. For example:

  • color='white'

  • color='w'

  • color=[1, 1, 1]

  • color='#FFFFFF'

preferencestr, optional

When mesh.n_points == mesh.n_cells and setting scalars, this parameter sets how the scalars will be mapped to the mesh. Default 'points', causes the scalars will be associated with the mesh points. Can be either 'points' or 'cells'.

titlestr, optional

The string label of the slider widget.

pointasequence, optional

The relative coordinates of the left point of the slider on the display port.

pointbsequence, optional

The relative coordinates of the right point of the slider on the display port.

continuousbool, optional

If this is enabled (default is False), use the continuous interval [minimum cell scalar, maxmimum cell scalar] to intersect the threshold bound, rather than the set of discrete scalar values from the vertices.

**kwargsdict, optional

All additional keyword arguments are passed to add_mesh to control how the mesh is displayed.

Returns
vtk.vtkActor

VTK actor of the mesh.