plot_recruitment_thresholds#

plot_recruitment_thresholds(
thresholds,
axs,
model_name=None,
y_max=None,
colors=None,
markers=None,
linestyles=None,
apply_default_formatting=True,
**kwargs,
)[source]#

Plot recruitment thresholds for one or multiple parameter sets.

Parameters:

  • thresholds (Dict[str | int | float, np.ndarray] | np.ndarray) – If dict: {parameter_value: rt_array} for multiple lines If array: single rt_array for single line plot

  • axs (beartype.cave.IterableType[matplotlib.axes.Axes]) – Matplotlib axes to plot on. This could be the same axis for all datasets, or separate axes for each dataset.

  • model_name (str, optional) – Name of the model for the plot title (only used if apply_default_formatting is True)

  • y_max (float, optional) – Maximum y-axis value. If None, determined from data

  • colors (str or list, optional) – Colors for plot lines

  • markers (str or list, optional) – Markers for plot lines

  • linestyles (str or list, optional) – Line styles for plot lines

  • apply_default_formatting (bool, optional) – Whether to apply default formatting to the plot

  • **kwargs (dict) – Additional keyword arguments to pass to the plot function. Only used if apply_default_formatting is False.

Returns:

The axes that were plotted on

Return type:

beartype.cave.IterableType[matplotlib.axes.Axes]

Raises:

ValueError – If the number of axes does not match the expected number of plots