alpaca.plotting.mpl

Functions

alpaca.plotting.mpl.exclusionplot(x: Container[float], y: Container[float], chi2: list[ChiSquared] | ChiSquared, xlabel: str, ylabel: str, title: str | None = None, ax: Axes | None = None, global_chi2: ChiSquared | bool = True) Axes

Create an exclusion plot.

Parameters

xContainer[float]

The x-coordinates of the data points.

yContainer[float]

The y-coordinates of the data points.

chi2list[ChiSquared] | ChiSquared

The ChiSquared object(s) representing the exclusion regions. If a single ChiSquared object is provided, it will be treated as the global exclusion significance.

xlabelstr

The label for the x-axis.

ylabelstr

The label for the y-axis.

titlestr | None, optional

The title of the plot (default is None).

axplt.Axes | None, optional

The matplotlib Axes object to plot on (default is None, which creates a new figure).

global_chi2ChiSquared | bool, optional

A ChiSquared object representing the global exclusion significance (default is True, which uses the combined chi squared). If set to False, no global significance will be plotted.

alpaca.plotting.mpl.alp_channels_plot(x: Container[float], channels: dict[str, Container[float]], xlabel: str, ylabel: str, ymin: float | None = None, title: str | None = None, ax: Axes | None = None) Axes

Create a plot for ALP decay channels.

Parameters

xContainer[float]

The x-coordinates of the data points.

channelsdict[str, Container[float]]

A dictionary where keys are channel names and values are the corresponding y-coordinates.

xlabelstr

The label for the x-axis.

ylabelstr

The label for the y-axis.

yminfloat

The minimum value for the y-axis.

ymaxfloat

The maximum value for the y-axis.

titlestr | None, optional

The title of the plot (default is None).

axplt.Axes | None, optional

The matplotlib Axes object to plot on (default is None, which creates a new figure).