open_viewmin.filter_tree_plot.filters.streamlines

open_viewmin.filter_tree_plot.filters.streamlines#

Utilities for creating streamlines for orientation data on surfaces

Functions#

add_streamlines_to_surface(plotter, actor_name, mesh_name)

Add a filter formula for surface streamlines to an existing surface

add_surface_streamlines_aux(mesh)

Create a callable that adds a surface streamlines filter formula

Module Contents#

add_streamlines_to_surface(plotter, actor_name, mesh_name, vectors_name=None, max_steps=10, n_points=0, tube=True, radius=0.1, n_sides=3, **mesh_kwargs)#

Add a filter formula for surface streamlines to an existing surface mesh.

Parameters:

  • plotter (open_viewmin.FilterTreePlot)

  • actor_name (str) – Name of new (child) streamlines mesh.

  • mesh_name (str) – Name of parent mesh.

  • vectors_name (str or None, optional) – Name of vector dataset defined on parent mesh from which to calculate streamlines.

  • max_steps (int, optional) – Maximum length of each streamline in iteration steps.

  • n_points (int, optional) – Number of randomly selected surface points each which to draw streamlines. Pass 0 to sample at all points.

  • tube (bool, optional) – Whether to render streamlines as tubes.

  • radius (float, optional) – Radius of each streamline tube.

  • n_sides (int, optional) – Resolution of tube visualizing streamline.

  • mesh_kwargs (dict, optional) – Keyword arguments to pyvista.Plotter.add_mesh

add_surface_streamlines_aux(mesh)#

Create a callable that adds a surface streamlines filter formula to a mesh.

Parameters:

mesh (pyvista.dataset) – Parent mesh in which to draw the streamlines.

Return type:

callable()

Contents