plot_glyph#

plot_glyph(vector_data, fig=None, glyph=None, glyph_space=1, glyph_kwargs=None, mesh_kwargs=None, plotter_kwargs=None)[source]#

Plot glyphs to the Plotter such as arrows, spheres, etc. for vector fields

Return type:

Plotter

Parameters:
  • vector_data – A dataclass containing 3D vector data in 3 component directions

  • fig – Pyvista plotter object

  • glyph – PyVista polydata object to add to the plotter. Defaults to arrow glyph

  • glyph_space – Spacing between glyphs. Defaults to 1

  • glyph_kwargs – Additional keyword arguments to customize the glyph

  • mesh_kwargs – Pyvista mesh keyword arguments to pass to the plotter.

  • plotter_kwargs – Additional keyword arguments to pass to the plotter.

Returns:

Plotter object with glyphs added as a mesh

Return type:

pv.Plotter