PlotHandler

class rubin_sim.maf.plots.PlotHandler(out_dir='.', results_db=None, savefig=True, fig_format='pdf', dpi=600, thumbnail=True, trim_whitespace=True)

Bases: object

Methods Summary

plot(plot_func[, plot_dicts, display_dict, ...])	Create plot for mBundles, using plot_func.
save_fig(fignum, outfile_root, plot_type, ...)
set_metric_bundles(m_bundles)	Set the metric bundle or bundles (list or dictionary).
set_plot_dicts([plot_dicts, plot_func, reset])	Set or update (or 'reset') the plot_dict for the (possibly joint) plots.

Methods Documentation

plot(plot_func, plot_dicts=None, display_dict=None, outfile_root=None, outfile_suffix=None)

Create plot for mBundles, using plot_func.

plot_dicts: List of plot_dicts if one wants to use a _new_ plot_dict per MetricBundle.

save_fig(fignum, outfile_root, plot_type, metric_name, slicer_name, run_name, constraint, info_label, display_dict=None)

set_metric_bundles(m_bundles)

Set the metric bundle or bundles (list or dictionary). Reuse the PlotHandler by resetting this reference. The metric bundles have to have the same slicer.

set_plot_dicts(plot_dicts=None, plot_func=None, reset=False)

Set or update (or ‘reset’) the plot_dict for the (possibly joint) plots.

Resolution is: auto-generated items (colors/labels/titles) < anything previously set in the plot_handler < defaults set by the plotter < explicitly set items in the metricBundle plot_dict < explicitly set items in the plot_dicts list passed to this method.