suboptimumg.plotting.grid_plot#

class suboptimumg.plotting.grid_plot.PlotType(*values)[source]#

Bases: str, Enum

Plot types for 3D grid plotting.

CONTOUR = 'contour'#
SURFACE = 'surface'#
suboptimumg.plotting.grid_plot.plot_grid_2D(x_list, y_data_dict, subplot_titles, title, x_label, y_label, rows, cols, *, theme=None, fit_curve=False, font_config=None, layout_config=None, smoothing_config=None)[source]#

Generic 2D grid plotting utility.

Parameters:

  • x_list (numpy.ndarray) – Numpy array of x coordinates (shared across all subplots)

  • y_data_dict (Dict[str, np.ndarray]) – Dictionary mapping event keys to y-data arrays

  • subplot_titles (List[str]) – List of subplot titles in order

  • title (str) – Overall grid title

  • x_label (str) – X-axis label for all subplots

  • y_label (str) – Y-axis label for all subplots

  • rows (int) – Number of rows in the grid

  • cols (int) – Number of columns in the grid

  • theme (str, optional) – Color theme name

  • fit_curve (bool, optional) – Whether to fit curves to data

  • font_config (FontConfig, optional) – FontConfig object for font settings

  • layout_config (LayoutConfig, optional) – LayoutConfig object for layout settings

  • smoothing_config (SmoothingConfig, optional) – SmoothingConfig object for smoothing settings

Returns:

Plotly figure object

Return type:

go.Figure

suboptimumg.plotting.grid_plot.plot_grid_3D(x_list, y_list, z_data_dict, subplot_titles, title, x_label, y_label, z_label_dict, rows, cols, plot_type, theme=None, font_config=None, layout_config=None, colorbar_config=None, smoothing_config=None)[source]#

Generic 3D grid plotting utility for contour or surface plots.

Requires grid-based input data (2D z arrays).

Parameters:

  • x_list (numpy.ndarray) – 1D numpy array of x coordinates defining the grid x-axis

  • y_list (numpy.ndarray) – 1D numpy array of y coordinates defining the grid y-axis

  • z_data_dict (Dict[str, np.ndarray]) – Dictionary mapping event keys to z-data 2D arrays. Each z array must have shape (len(x_list), len(y_list))

  • subplot_titles (List[str]) – List of subplot titles in order

  • title (str) – Overall grid title

  • x_label (str) – X-axis label

  • y_label (str) – Y-axis label

  • z_label_dict (Dict[str, str]) – Dictionary mapping event keys to z-axis labels

  • rows (int) – Number of rows in the grid

  • cols (int) – Number of columns in the grid

  • plot_type (PlotType) – PlotType enum (CONTOUR or SURFACE)

  • theme (str, optional) – Color theme name

  • font_config (FontConfig, optional) – FontConfig object for font settings

  • layout_config (LayoutConfig, optional) – LayoutConfig object for layout settings

  • colorbar_config (ColorbarConfig, optional) – ColorbarConfig object for colorbar settings

  • smoothing_config (SmoothingConfig, optional) – SmoothingConfig object for smoothing settings

Returns:

Plotly figure object

Return type:

go.Figure