suboptimumg.plotting.overlay_plots#

suboptimumg.plotting.overlay_plots.overlay_grid_plot_2D(x_data_dict, y_data_dict, subplot_titles, title, x_label, y_label, rows, cols, *, show_points=False, show_legend=False, fit_curve=False, layout_config=LayoutConfig(width=1000, height=700, grid_width_per_col=400, grid_height_per_row=350, grid_horizontal_spacing=0.08, grid_vertical_spacing=0.12, margin={'l': 70, 'r': 50, 't': 90, 'b': 70}, plot_bgcolor='white', scene_bgcolor='rgba(240, 240, 240, 0.8)', title_x=0.5, title_xanchor='center', title_yanchor='top'), font_config=FontConfig(large=24, medium=16, small=12), smoothing_config=SmoothingConfig(interp_factor=5, smoothing_sigma=0, interp_method='linear'))[source]#

Generic 2D overlay grid plotting utility for comparing multiple series.

Parameters:

  • x_data_dict (Dict[str, Dict[str, npt.NDArray[np.number]]]) – {subplot_key: {trace_label: x_data_array}} - subplot_key: identifies which subplot the data belongs to (must match order in subplot_titles) - trace_label: identifies which trace/series (must match keys in y_data_dict[subplot_key])

  • y_data_dict (Dict[str, Dict[str, npt.NDArray[np.number]]]) – {subplot_key: {trace_label: y_data_array}} - subplot_key: identifies which subplot the data belongs to (must match order in subplot_titles) - trace_label: identifies which trace/series (must match keys in x_data_dict[subplot_key])

  • subplot_titles (List[str]) – List of titles for each subplot

  • title (str) – Overall title for the grid

  • x_label (str) – Label for x-axis

  • y_label (str) – Label for y-axis

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

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

  • show_legend (bool, optional) – If True, shows legend on the first subplot

  • fit_curve (bool, optional) – Whether to use spline fitting for curves

  • smoothing (float, optional) – Smoothing parameter (deprecated, use smoothing_config)

  • interp_factor (int, optional) – Interpolation factor (deprecated, use smoothing_config)

  • layout_config (LayoutConfig, optional) – Layout configuration object

  • font_config (FontConfig, optional) – Font configuration object

  • smoothing_config (SmoothingConfig, optional) – Smoothing configuration object

  • show_points (bool)

Returns:

Plotly figure object

Return type:

go.Figure

suboptimumg.plotting.overlay_plots.overlay_plot2D(x_data_dict, y_data_dict, title, x_axis, y_axis, *, h_line=None, v_line=None, fit_curve=False, show_points=False, subtitle=None, font_config=None, layout_config=None, smoothing_config=None)[source]#

Generic 2D overlay plotting utility for comparing multiple series.

Parameters:

  • x_data_dict (Dict[str, npt.NDArray[np.number]]) – Dictionary mapping trace labels to x data arrays

  • y_data_dict (Dict[str, npt.NDArray[np.number]]) – Dictionary mapping trace labels to y data arrays

  • title (str) – Plot title

  • x_axis (str) – X-axis label

  • y_axis (str) – Y-axis label

  • h_line (ReferenceLineConfig, optional) – ReferenceLineConfig for horizontal reference line (None = no line)

  • v_line (ReferenceLineConfig, optional) – ReferenceLineConfig for vertical reference line (None = no line)

  • fit_curve (bool, optional) – Whether to fit a curve to the data points

  • show_points (bool, optional) – Whether to show individual data points

  • subtitle (str, optional) – Optional subtitle

  • 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