PyvistaPlotter

class psipy.visualization.pyvista.PyvistaPlotter(mas_output: ModelOutput)

Bases: object

Wrapper for a pyvista.Plotter.

This class provides various convenience methods for plotting various structures in psipy to a 3D pyvista plotter.

Attributes

plotterpyvista.Plotter

Methods Summary

add_fline(fline, **kwargs)
add_sphere(radius, **kwargs)	Add a sphere at a given radius.
add_tracing_seed_sphere(radius, **kwargs)	Add a sphere to trace field lines from.
show(*args, **kwargs)

Methods Documentation

add_fline(fline, **kwargs)

add_sphere(radius: Unit('m'), **kwargs) → Sphere

Add a sphere at a given radius.

Parameters

radiusastropy.units.Quantity

Radius of the sphere.

kwargs

Additional keyword arguments are passed to pyvista.Sphere, for example to control the color or rednering of the sphere.

Returns

pyvista.Sphere

add_tracing_seed_sphere(radius: Unit('m'), **kwargs) → None

Add a sphere to trace field lines from.

Parameters

radiusastropy.units.Qantity

Radius of the sphere.

kwargs

Additional keyword arguments are passed to pyvista.Sphere, for example to control the color or rednering of the sphere.

Returns

pyvista.Sphere

show(*args, **kwargs)