Module quantum_inferno.plot_templates.plot_templates_examples

This module contains functionalized versions of the quantum inferno plot templates used by examples. These functions are intended to run with the full set of parameters for each chart, without the user knowing the underlying classes that group the values.

Functions

def plot_cw_and_power(cw_panel_sig: numpy.ndarray, power_panel_sigs: List[numpy.ndarray], cw_panel_time: numpy.ndarray, power_panel_freqs: List[numpy.ndarray], power_panel_ls: List[str] = None, power_panel_lw: List[int] = None, power_panel_sig_labels: List[str] = None, cw_panel_units: str = 'Norm', power_panel_y_units: str = 'Power/Var(signal)', power_panel_x_units: str = 'Frequency, Hz', params_tfr=<quantum_inferno.plot_templates.figure_attributes.AudioParams object>, units_time: str = 's', cw_panel_title: str = 'CW', power_panel_title: str = 'Power', figure_title_show: bool = True) ‑> Optional[matplotlib.figure.Figure]

Template for CW and power plots from intro set examples

:param cw_panel_sig: CW signal waveform :param power_panel_sigs: list of power signal arrays :param cw_panel_time: CW time series :param power_panel_freqs: list of power frequency arrays :param power_panel_ls: list of line styles for power signals :param power_panel_lw: list of line widths for power signals :param power_panel_sig_labels: list of labels for power signals :param cw_panel_units: units of the CW signal waveform :param power_panel_y_units: y-axis units of the power signals :param power_panel_x_units: x-axis units of the power signals :param params_tfr: parameters for tfr; see AudioParams() in figure_attributes.py :param units_time: x-axis units for the CW panel :param cw_panel_title: title of the CW panel :param power_panel_title: title of the power panel :param figure_title_show: show panel titles if True; default is True :return: the figure

def plot_wf_mesh_mesh_vert_example(station_id: str, wf_panel_a_sig: numpy.ndarray, wf_panel_a_time: numpy.ndarray, mesh_time: numpy.ndarray, mesh_frequency: numpy.ndarray, mesh_panel_b_tfr: numpy.ndarray, mesh_panel_c_tfr: numpy.ndarray, params_tfr=<quantum_inferno.plot_templates.figure_attributes.AudioParams object>, wf_panel_a_yscaling: str = 'auto', wf_panel_a_ytick_style: str = 'plain', mesh_panel_b_ytick_style: str = 'sci', mesh_panel_c_ytick_style: str = 'sci', frequency_scaling: str = 'log', mesh_shading: str = 'auto', mesh_panel_b_colormap_scaling: str = 'auto', mesh_panel_b_color_max: float = 15, mesh_panel_b_color_range: float = 15, mesh_panel_b_color_min: float = 0, mesh_panel_c_colormap_scaling: str = 'auto', mesh_panel_c_color_max: float = 15, mesh_panel_c_color_range: float = 15, mesh_panel_c_color_min: float = 0, start_time_epoch: float = 0, frequency_hz_ymin: float = None, frequency_hz_ymax: float = None, mesh_colormap: str = None, units_time: str = 's', units_frequency: str = 'Hz', wf_panel_a_units: str = 'Norm', mesh_panel_b_cbar_units: str = 'bits', mesh_panel_c_cbar_units: str = 'bits', figure_title: str = 'Time-Frequency Representation', figure_title_show: bool = True)

Plot 3 vertical panels - mesh (top panel), mesh (middle panel) and signal waveform (bottom panel)

:param mesh_panel_b_ytick_style: y-tick style for the middle mesh panel :param wf_panel_a_ytick_style: y-tick style for the waveform panel :param wf_panel_a_yscaling: y-scaling for the waveform panel :param mesh_panel_c_ytick_style: y-tick style for the top mesh panel :param station_id: name of station :param wf_panel_a_sig: array with signal waveform for bottom panel :param wf_panel_a_time: array with signal timestamps for bottom panel :param mesh_time: array with mesh time :param mesh_frequency: array with mesh frequencies :param mesh_panel_b_tfr: array with mesh tfr data for mesh plot (middle panel) :param mesh_panel_c_tfr: array with mesh tfr data for mesh plot (top panel) :param params_tfr: parameters for tfr. Check AudioParams(). :param frequency_scaling: "log" or "linear". Default is "log" :param mesh_shading: type of mesh shading, one of "auto", "gouraud" or "else". Default is "auto" :param mesh_panel_b_colormap_scaling: color scaling for mesh plot (middle panel). One of: "auto", "range" or "else" (use inputs given in mesh_panel_b_color_max, mesh_panel_b_color_range, mesh_panel_b_color_min). Default is "auto" :param mesh_panel_b_color_max: maximum value for color scaling for mesh plot (middle panel). Default is 15.0 :param mesh_panel_b_color_range: range between maximum and minimum values in color scaling for mesh plot (middle panel). Default is 15.0 :param mesh_panel_b_color_min: minimum value for color scaling for mesh plot (middle panel). Default is 0.0 :param mesh_panel_c_colormap_scaling: color scaling for mesh plot (top panel). One of: "auto", "range" or "else" (use inputs given in mesh_panel_c_color_max, mesh_panel_c_color_range, mesh_panel_c_color_min). Default is "auto" :param mesh_panel_c_color_max: maximum value for color scaling for mesh plot (top panel). Default is 15.0 :param mesh_panel_c_color_range:range between maximum and minimum values in color scaling for scatter plot (top panel). Default is 15.0 :param mesh_panel_c_color_min: minimum value for color scaling for mesh plot (top panel). Default is 0.0 :param start_time_epoch: start time in epoch UTC. Default is 0.0 :param frequency_hz_ymin: minimum frequency for y-axis :param frequency_hz_ymax: maximum frequency for y-axis :param mesh_colormap: a Matplotlib Colormap instance or registered colormap name. Default is "inferno" :param units_time: units of time. Default is "s" :param units_frequency: units of frequency. Default is "Hz" :param wf_panel_a_units: units of waveform plot (bottom panel). Default is "Norm" :param mesh_panel_b_cbar_units: units of colorbar for mesh plot (middle panel). Default is "bits" :param mesh_panel_c_cbar_units: units of colorbar for mesh plot (top panel). Default is "bits" :param figure_title: title of figure. Default is "Time-Frequency Representation" :param figure_title_show: show title if True. Default is True :return: plot

def plot_wf_mesh_vert_example(station_id: str, wf_panel_a_sig: numpy.ndarray, wf_panel_a_time: numpy.ndarray, mesh_time: numpy.ndarray, mesh_frequency: numpy.ndarray, mesh_panel_b_tfr: numpy.ndarray, params_tfr=<quantum_inferno.plot_templates.figure_attributes.AudioParams object>, frequency_scaling: str = 'log', mesh_shading: str = 'auto', wf_panel_a_yscaling: str = 'auto', wf_panel_a_ytick_style: str = 'plain', mesh_panel_b_ytick_style: str = 'sci', mesh_panel_b_colormap_scaling: str = 'auto', mesh_panel_b_color_max: float = 15, mesh_panel_b_color_range: float = 15, mesh_panel_b_color_min: float = 0, start_time_epoch: float = 0, frequency_hz_ymin: float = None, frequency_hz_ymax: float = None, mesh_colormap: str = None, units_time: str = 's', units_frequency: str = 'Hz', wf_panel_a_units: str = 'Norm', mesh_panel_b_cbar_units: str = 'bits', figure_title: str = 'Time-Frequency Representation', figure_title_show: bool = True)

Plot 2 vertical panels - mesh (top panel) and signal waveform (bottom panel)

:param wf_panel_a_yscaling: 'auto', 'symmetric', 'positive' :param station_id: name of station :param wf_panel_a_sig: array with signal waveform for bottom panel :param wf_panel_a_time: array with signal timestamps for bottom panel :param mesh_time: array with mesh time :param mesh_frequency: array with mesh frequencies :param mesh_panel_b_tfr: array with mesh tfr data for mesh plot (top panel) :param params_tfr: Display parameters for tfr. Check AudioParams(). :param frequency_scaling: "log" or "linear". Default is "log" :param mesh_shading: type of mesh shading, one of "auto", "gouraud" or "else". Default is "auto" :param mesh_panel_b_colormap_scaling: color scaling for mesh plot (top panel). One of: "auto", "range" or "else" (use inputs given in mesh_panel_b_color_max, mesh_panel_b_color_range, mesh_panel_b_color_min). Default is "auto" :param mesh_panel_b_color_max: maximum value for color scaling for mesh plot (top panel). Default is 15.0 :param mesh_panel_b_color_range:range between maximum and minimum values in color scaling for scatter plot (top panel). Default is 15.0 :param mesh_panel_b_color_min: minimum value for color scaling for mesh plot (top panel). Default is 0.0 :param start_time_epoch: start time in epoch UTC. Default is 0.0 :param frequency_hz_ymin: minimum frequency for y-axis :param frequency_hz_ymax: maximum frequency for y-axis :param mesh_colormap: a Matplotlib Colormap instance or registered colormap name. If None, inherits style sheet spec :param units_time: units of time. Default is "s" :param units_frequency: units of frequency. Default is "Hz" :param wf_panel_a_units: units of waveform plot (bottom panel). Default is "Norm" :param wf_panel_a_ytick_style: 'plain' or 'sci'. Default is "plain" :param mesh_panel_b_ytick_style: 'plain' or 'sci'. Default is "sci" :param mesh_panel_b_cbar_units: units of colorbar for mesh plot (top panel). Default is "bits" :param figure_title: title of figure. Default is "Time-Frequency Representation" :param figure_title_show: show title if True. Default is True :return: plot