Module quantum_inferno.plot_templates.plot_templates

Base templates for plots: * 3 waveforms * 1 waveform, 2 mesh * 1 waveform, 1 mesh * CW and Power

Functions

def adjust_figure_height(figure_size_y: int, n_rows: int, n_rows_standard: int = 2, hspace: float = 0.13) ‑> Tuple[float, float, float]

Adjust the figure height based on the number of rows to preserve standard panel aspect ratios

:param figure_size_y: figure height :param n_rows: number of rows in figure :param n_rows_standard: number of rows in the figure for which height is not adjusted. Default 2 :param hspace: height space between panels, fraction of average panel height. Default 0.13 :return: adjusted figure height, space param for title, space param for x label

def get_colormesh(axes: matplotlib.axes._axes.Axes, time: numpy.ndarray, freq: numpy.ndarray, shading: Optional[str], mesh_base: MeshBase, mesh_panel: MeshPanel) ‑> matplotlib.collections.QuadMesh

:param axes: matplotlib axes to invoke the pcolormesh function :param time: timestamp array :param freq: frequency array :param shading: shading value :param mesh_base: MeshBase to get info from :param mesh_panel: MeshPanel to get info from :return: Quadmesh for plotting

def get_time_label(start_time_epoch: float, units_time: str, utc_offset_h: float = 0.0) ‑> str

:param start_time_epoch: start time in seconds since epoch UTC :param units_time: units of time :param utc_offset_h: hours offset from UTC. Default 0 (UTC time) :return: label for time units on a chart

def mesh_time_frequency_edges(frequency: numpy.ndarray, time: numpy.ndarray, frequency_ymin: float, frequency_ymax: float, frequency_scaling: str = 'linear') ‑> Tuple[numpy.ndarray, numpy.ndarray, float, float]

Find time and frequency edges for plotting. Raises an error if data is invalid.

:param frequency: frequencies :param time: timestamps of the data :param frequency_ymin: minimum frequency for y-axis :param frequency_ymax: maximum frequency for y-axis :param frequency_scaling: "log" or "linear". Default is "linear" :return: time and frequency edges, frequency min and max

def plot_cw_and_power(cw_panel: CwPanel, power_panel: PowerPanel, cw_plot_base: CwPowerPlotBase = CwPowerPlotBase(params_tfr=<quantum_inferno.plot_templates.figure_attributes.AudioParams object>, figure_title_show=True)) ‑> matplotlib.figure.Figure

Template for CW and power plots

:param cw_panel: CW panel to plot :param power_panel: Power panel to plot :param cw_plot_base: base parameters for plotting. Default to default CwPowerPlotBase values :return: Figure to plot

def plot_mesh_wf_vert(mesh_base: MeshBase, mesh_panel: MeshPanel, wf_base: WaveformPlotBase, wf_panel: WaveformPanel, sanitize_times: bool = True, use_default_size: bool = True) ‑> matplotlib.figure.Figure

Specifically plot one mesh and one waveform, vertically

:param mesh_base: base values for mesh plots :param mesh_panel: mesh panel to display :param wf_base: base values for plotting waveforms :param wf_panel: waveform to display :param sanitize_times: if True, sanitize timestamps. Default True :param use_default_size: if True, use the default size for the plots, otherwise size dynamically. Default True :return: Figure to plot

def plot_n_mesh_wf_vert(mesh_base: MeshBase, panels: List[MeshPanel], wf_base: WaveformPlotBase, wf_panel: WaveformPanel, sanitize_times: bool = True, use_default_size: bool = True) ‑> matplotlib.figure.Figure

Plot 1 or more mesh panels above the base waveform panel in a vertical layout.

:param mesh_base: base values for mesh plots :param panels: list of mesh panels to display, in order of display :param wf_base: base values for plotting waveforms :param wf_panel: WaveformPanel required for figure :param sanitize_times: if True, sanitize timestamps. Default True :param use_default_size: if True, use the default size for the plots, otherwise size dynamically. Default True :return: figure to display

def plot_wf_3_vert(wf_base: WaveformPlotBase, wf_panel_a: WaveformPanel, wf_panel_b: WaveformPanel, wf_panel_c: WaveformPanel, sanitize_times: bool = True) ‑> matplotlib.figure.Figure

plot 3 waveforms

:param wf_base: base params for plotting waveforms :param wf_panel_a: first waveform to plot :param wf_panel_b: second waveform to plot :param wf_panel_c: third waveform to plot :param sanitize_times: if True, sanitize the timestamps. Default True :return: figure to plot

def sanitize_timestamps(time_input: numpy.ndarray, start_epoch: Optional[float] = None) ‑> numpy.ndarray

Sanitize timestamps

:param time_input: array with timestamps :param start_epoch: optional start time to sanitize timestamps with. Default None (use the first timestamp) :return: timestamps re-calculated from given epoch_start or first timestamp

def setup_cw_power_plot(ax: matplotlib.axes._axes.Axes, y_units: str, x_units: str, text_size: int)

Set the x and y labels and set tick params for the given Axes

:param ax: the Axes object to update :param y_units: label for y-axis :param x_units: label for x-axis :param text_size: size of text

def setup_plot(ax: matplotlib.axes._axes.Axes, ylabel_units: str, text_size: int, is_waveform: bool, is_bottom: bool, ytick_style: str = 'plain')

set up a plot with common values :param ax: pyplot Axes to set values for :param ylabel_units: label for y-axis units :param text_size: size of text :param is_waveform: if True, the Axes is plotting a waveform, otherwise it's a mesh :param is_bottom: if True, the Axes being plotted is the bottom subplot :param ytick_style: tick style for waveform y-axis. Does nothing if is_waveform is False. Default "plain"