idstools.view.magnetics¶

This module provides view functions and classes for pf_active ids data

refer data dictionary.

Module Contents¶

class idstools.view.magnetics.MagneticsView(ids: object)[source]¶

This class provides view functions for pf_active ids

Initialization MagneticsView object.

Parameters:¶

ids: object¶

magnetics ids object

ids¶

magnetics_compute¶

view_b_field_probes(ax: matplotlib.pyplot.axes, probe_type='b_field_pol_probe', select=':')[source]¶

Plots the positions and directions of poloidal magnetic field probes on a tokamak wall.

Parameters: ax (matplotlib.axes.Axes): The matplotlib axes object where the plot will be drawn. probe_type (str, optional): The type of probe to plot. Defaults to “b_field_pol_probe”. select (str, optional): Selection criteria for the probe data. Defaults to “:”.

Returns: None

view_flux_loop(ax: matplotlib.pyplot.axes, select=':', color='#ff3d41')[source]¶

Plots the flux loops on the given matplotlib axes.

Parameters: ax (plt.axes): The matplotlib axes on which to plot the flux loops.

Returns: None

view_rogowski_coil(ax: matplotlib.pyplot.axes, select=':', color='#ff3d41')[source]¶

Plots Rogowski coil data on the given matplotlib axes.

Parameters: ax (matplotlib.axes.Axes): The axes on which to plot the Rogowski coil data. select (str, optional): Selection criteria for the Rogowski coil data. Defaults to “:”. color (str, optional): Color for the Rogowski coil markers. Defaults to “#069AF3”.

Returns: matplotlib.lines.Line2D: A legend handle for the Rogowski coil plot.

Logs a warning if no Rogowski coil data is found.

view_shunt(ax: matplotlib.pyplot.axes, select=':', color='#ff3d41')[source]¶

idstools.view.magnetics.logger¶