API Plotting#
Functions for the generation of plots related to the fitting results.
- satlas2.plotting.generateCorrelationPlot(filename: str, filter: List[str] | None = None, bins: int | None = None, burnin: int = 0, source: bool = True, model: bool = True, binreduction: int = 1, bin2dreduction: int = 1) Tuple[Figure, Tuple[Axes], Axes] [source]#
Given the random walk data, creates a triangle plot: distribution of a single parameter on the diagonal axes, 2D contour plots with 1, 2 and 3 sigma contours on the off-diagonal. The 1-sigma limits based on the percentile method are also indicated, as well as added to the title.
- Parameters:
filename (str) – Filename for the h5 file containing the data from the walk.
filter (Optional[List[str]], optional) – Only this list of columns is used for the plot, by default None.
bins (Optional[int], optional) –
- Use this number of bins for the plotting. Applies the same
- number of bins for each parameter. If supplied as a list,
length must match the number of parameters. By default None.
burnin (int, optional) – Number of initial steps from the random walk to be discarded, by default 0.
source (bool, optional) – Add the source name to the plot titles, by default True.
model (bool, optional) – Add the model name to the plot titles, by default True.
binreduction (int, optional) – Reduces the amount of bins in the 1D case by this factor, by default 1.
bin2dreduction (int, optional) – Further reduces the amount of bins in the 2D case by this factor, by default 1.
- Returns:
Tuple containing the figure, the individual axes, and the colorbar axis.
- Return type:
Tuple[plt.Figure, Tuple[plt.Axes], plt.Axes]
- satlas2.plotting.generateWalkPlot(filename: str, filter: List[str] | None = None, burnin: int = 0, source: bool = False, model: bool = True) Tuple[Figure, Tuple[Axes]] [source]#
Given the random walk data, the random walk for the selected parameters is plotted.
- Parameters:
filename (str) – Filename for the h5 file containing the data from the walk.
filter (Optional[List[str]], optional) – Only this list of columns is used for the plot, by default None.
burnin (int, optional) – Number of initial steps from the random walk to be discarded, by default 0.
source (bool, optional) – Add the source name to the plot titles, by default False.
model (bool, optional) – Add the model name to the plot titles, by default True.
- Returns:
Tuple containing the figure and the individual axes.
- Return type:
Tuple[plt.Figure, Tuple[plt.Axes]]