idstools.view.summary¶

This module provides view functions and classes for equilibrium ids data

refer data dictionary.

Module Contents¶

class idstools.view.summary.SummaryView(ids: object)[source]¶

Bases: idstools.view.common.BasePlot

This is a constructor function that initializes an object with an input object and creates another object using the input object.

Parameters:¶

ids: object¶

The parameter idsObj is an object that is being passed to the constructor of the class. It is not clear from the code snippet what type of object it is, but it is being stored as an instance variable self.idsObj.

compute_obj¶

ids¶

show_info_on_plot(ax, info: str = '', location='right')[source]¶

view_energy_content_waveforms(ax)[source]¶

The function view_energy_content_waveforms plots energy content waveforms on a given axis.

Parameters:¶

ax¶

The parameter “ax” is an instance of the matplotlib Axes class. It represents the axes on which the waveforms will be plotted.

view_hcd_waveforms(ax)[source]¶

The function view_hcd_waveforms plots various power waveforms on a given axis.

Parameters:¶

ax¶

The ax parameter is an instance of the Axes class from the matplotlib.pyplot module. It represents the axes on which the waveforms will be plotted.

view_hmode(ax)[source]¶

The function view_hmode checks if HMode is present and fills the area between th_min and th_max on the y-axis with a light yellow color if it is, otherwise it logs a warning message.

Parameters:¶

ax¶

The parameter ax is an instance of the Axes class from the matplotlib library. It represents the axes on which the plot is being drawn.

view_ip_b0_waveforms(ax)[source]¶

The function view_ip_b0_waveforms plots the absolute values of the Ip and B0 waveforms on a given axis.

Parameters:¶

ax¶

The parameter “ax” is an instance of the matplotlib Axes class. It represents the subplot where the Ip and B0 waveforms will be plotted.

view_time_line(ax, time)[source]¶

The function view_time_line plots a vertical dashed line on a given matplotlib axis at a specified time.

Parameters:¶

ax¶

The parameter “ax” is a reference to the second y-axis of a matplotlib figure. It is used to plot the timeline on the same figure as the other data.

time¶

The “time” parameter is the value at which you want to plot a vertical line on the timeline. It represents the specific point in time that you want to highlight on the timeline.

view_vloop_waveforms(ax)[source]¶

The function view_vloop_waveforms plots three waveforms (V_LOOP, H_98, and TAU_ENERGY) against time on the given ax object.

Parameters:¶

ax¶

The parameter “ax” is an instance of the matplotlib Axes class. It represents the axes on which the waveforms will be plotted.

idstools.view.summary.logger¶