bilby.core.result.plot_multiple

bilby.core.result.plot_multiple(results, filename=None, labels=None, colours=None, save=True, evidences=False, corner_labels=None, linestyles=None, **kwargs)[source]

Generate a corner plot overlaying two sets of results

Parameters:
results: list

A list of bilby.core.result.Result objects containing the samples to plot.

filename: str

File name to save the figure to. If None (default), a filename is constructed from the outdir of the first element of results and then the labels for all the result files.

labels: list

List of strings to use when generating a legend. If None (default), the label attribute of each result in results is used.

colours: list

The colours for each result. If None, default styles are applied.

save: bool

If true, save the figure

kwargs: dict

All other keyword arguments are passed to result.plot_corner (except for the keyword labels for which you should use the dedicated corner_labels input). However, show_titles and truths are ignored since they would be ambiguous on such a plot.

evidences: bool, optional

Add the log-evidence calculations to the legend. If available, the Bayes factor will be used instead.

corner_labels: list, optional

List of strings to be passed to the input labels to result.plot_corner.

Returns:
fig:

A matplotlib figure instance