gwpopulation_pipe.post_plots.chi_eff_chi_p_plot

chi_eff_chi_p_plot(results, args, rate=False, observed=False, save=True)[source]

Make the posterior chi_eff chi_p plot given either one or multiple result objects.

Parameters:
results: [list, `bilby.core.result.Result`]

Bilby result(s) to make the spectra from.

args: ArgumentParser

The arguments describing the model.

rate: bool

Whether to scale the spectra by the inferred rate.

observed: bool

Whether to correct for selection effects. Not currently implemented.

save: bool

Whether to save the result to file.

Returns:
[dict, matplotlib.pyplot.Figure]

If save the data behind the plot is returned as a dictionary. Else, the figure handle is returned.