NaviNIBS.util.pyvista.plotting module

class NaviNIBS.util.pyvista.plotting.PlotterImprovementsMixin

Bases: object

updateScalarBarRangeWithVol(clim, volumeKey, volume)

Handle manual update of volume scalars that were hard-converted to previous scale within add_volume

reset_scalar_bar_ranges(scalarBarTitles=None)

Fix some issues with update_scalar_bar_ranges and handling of all nan values

addLineSegments(lines, color='w', opacity=1.0, width=5, reset_camera=False, label=None, name=None, scalar_bar_args=None, scalars=None, show_scalar_bar=None, cmap=None, userTransform=None)

Similar to plotter.add_lines but with a few improvements: - Allows lines arg to already be pv.PolyData (e.g. to already been passed through pv.lines_from_points.) This

allows for the possibility of grouping multiple discontinuous line segments into one actor.

• Added opacity arg

• Added reset_camera arg

• Allows specifying user transform in same call

Return type:

Actor

add_axes_marker(total_length=None, reset_camera=False, **kwargs)

Return type:

vtkActor

addMesh(mesh, defaultMeshColor=None, **kwargs)

Wrapper around add_mesh with some extra defaults for things like mesh color handling

defaultMeshColor: use this if the mesh has no color arrays

showGrid(mesh=None, bounds=None, n_xlabels=5, n_ylabels=5, n_zlabels=5, **kwargs)

Similar to show_grid, but simplified and with fixes for tick rounding issues introduced in https://github.com/pyvista/pyvista/commit/344f8388841043e0ff68b5813c4560f55333f057.

As part of this, specified number of tick marks will be used as a suggestion, but actual number may be different.

class NaviNIBS.util.pyvista.plotting.BackgroundPlotter(*args, auto_update=0.0, **kwargs)

Bases: _DelayedPlotter, QtInteractor, PlotterImprovementsMixin

Similar to pvqt.BackgroundPlotter, with a few key differences: - This batches multiple render calls together with an async coroutine - This sets default background color based on app palette - This doesn’t include some of the “extra” functionality in pvqt.BackgroundPlotter related to

toolbars and single-plotter-per-window management.

allowNonblockingCalls()

For now, this is does nothing. Is here for interface compatibility with RemotePlotterProxy that may be used instead. :return:

disallowNonblockingCalls()

For now, this is does nothing. Is here for interface compatibility with RemotePlotterProxy that may be used instead. :return:

async add_lines_async(*args, **kwargs)

Not actually async. Is here for interface compatibility with RemotePlotterProxy that may be used instead

async add_points_async(*args, **kwargs)

Not actually async. Is here for interface compatibility with RemotePlotterProxy that may be used instead

closeEvent(self, event: PySide6.QtGui.QCloseEvent) → None

addIrenStyleClassObserver(*, event, callback)

staticMetaObject = PySide6.QtCore.QMetaObject("BackgroundPlotter" inherits "QtInteractor": )

class NaviNIBS.util.pyvista.plotting.SecondaryLayeredPlotter(mainPlotter, rendererLayer=None, **kwargs)

Bases: _DelayedPlotter, BasePlotter, PlotterImprovementsMixin

allowNonblockingCalls()

For now, this is does nothing. Is here for interface compatibility with RemotePlotterProxy that may be used instead. :return:

disallowNonblockingCalls()

For now, this is does nothing. Is here for interface compatibility with RemotePlotterProxy that may be used instead. :return:

property rendererLayer

enable_depth_peeling(*args, **kwargs)

Enable depth peeling to improve rendering of translucent geometry.

Parameters

number_of_peelsint, optional

The maximum number of peeling layers. Initial value is 4 and is set in the pyvista.global_theme. A special value of 0 means no maximum limit. It has to be a positive value.

occlusion_ratiofloat, optional

The threshold under which the depth peeling algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering has to be exact. Greater values may speed up the rendering with small impact on the quality.

Returns

bool

If depth peeling is supported.

render(doRenderPrimaryPlotter=True, doRenderImmediately=False)

Render the main window.

Will not render until show has been called.

Any render callbacks added with add_on_render_callback() and the render_event=False option set will still execute on any call.

reset_camera_clipping_range(doIncludeMainPlotter=True)

Reset camera clipping planes.

class NaviNIBS.util.pyvista.plotting.CustomRenderWindowInteractor(plotter, desired_update_rate=30, light_follow_camera=True, interactor=None)

Bases: RenderWindowInteractor

Some quirks for layered plotter setup require us to override some behavior in pyvista’s RenderWindowInteractor

get_event_subplot_loc()

Get the subplot location of the last event.

class NaviNIBS.util.pyvista.plotting.PrimaryLayeredPlotter(*args, rendererLayer=0, doAutoAdjustCameraClippingRange=True, **kwargs)

Bases: BackgroundPlotter

property secondaryPlotters

property doAutoAdjustCameraClippingRange

setLayer(layer)

addLayeredPlotter(key, layer=None)

Return type:

SecondaryLayeredPlotter

pauseRendering()

staticMetaObject = PySide6.QtCore.QMetaObject("PrimaryLayeredPlotter" inherits "BackgroundPlotter": )

resumeRendering()

render(doRenderSecondaryPlotters=True, doRenderImmediately=False)

Override the render method to handle threading issues.

set_background(*args, **kwargs)

Set the background color.

Parameters

colorColorLike, optional

Either a string, rgb list, or hex color string. Defaults to current theme parameters. For example:

• color='white'

• color='w'

• color=[1.0, 1.0, 1.0]

• color='#FFFFFF'

topColorLike, optional

If given, this will enable a gradient background where the color argument is at the bottom and the color given in top will be the color at the top of the renderer.

all_renderersbool, default: True

If True, applies to all renderers in subplots. If False, then only applies to the active renderer.

Examples

Set the background color to black.

>>> import pyvista
>>> plotter = pyvista.Plotter()
>>> plotter.set_background('black')
>>> plotter.background_color
Color(name='black', hex='#000000ff', opacity=255)
>>> plotter.close()

Set the background color at the bottom to black and white at the top. Display a cone as well.

>>> import pyvista
>>> pl = pyvista.Plotter()
>>> actor = pl.add_mesh(pyvista.Cone())
>>> pl.set_background('black', top='white')
>>> pl.show()

enable_depth_peeling(*args, **kwargs)

Enable depth peeling to improve rendering of translucent geometry.

Parameters

number_of_peelsint, optional

The maximum number of peeling layers. Initial value is 4 and is set in the pyvista.global_theme. A special value of 0 means no maximum limit. It has to be a positive value.

occlusion_ratiofloat, optional

The threshold under which the depth peeling algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering has to be exact. Greater values may speed up the rendering with small impact on the quality.

Returns

bool

If depth peeling is supported.

reset_camera()

Reset the camera of the active render window.

The camera slides along the vector defined from camera position to focal point until all of the actors can be seen.

Parameters

renderbool, default: True

Trigger a render after resetting the camera.

boundsiterable(int), optional

Automatically set up the camera based on a specified bounding box (xmin, xmax, ymin, ymax, zmin, zmax).

Examples

Add a mesh and place the camera position too close to the mesh. Then reset the camera and show the mesh.

>>> import pyvista
>>> pl = pyvista.Plotter()
>>> actor = pl.add_mesh(pyvista.Sphere(), show_edges=True)
>>> pl.set_position((0, 0.1, 0.1))
>>> pl.reset_camera()
>>> pl.show()

reset_camera_clipping_range()

Reset camera clipping planes.

set_camera_clipping_range(range)

close()

Quit application.