plot_all

plot_all#

Example plot function.

Functions:

draw_stat_error_bands(ax, h[, norm])

draw_syst_error_bands(ax, h, syst_hists, ...)

draw_stack(ax, h[, norm])

draw_hist(ax, h[, norm, error_type])

draw_profile(ax, h[, norm, error_type])

Profiled histograms contains the storage type "Mean" and can therefore not be normalized

draw_errorbars(ax, h[, norm, error_type])

plot_all(plot_config, style_config[, ...])

Function that calls multiple plotting methods based on two configuration dictionaries, plot_config and style_config.
draw_stat_error_bands(ax, h, norm=1.0, **kwargs)[source]#
Return type:

None

draw_syst_error_bands(ax, h, syst_hists, shift_insts, norm=1.0, method='quadratic_sum', **kwargs)[source]#
Return type:

None

draw_stack(ax, h, norm=1.0, **kwargs)[source]#
Return type:

None

draw_hist(ax, h, norm=1.0, error_type='variance', **kwargs)[source]#
Return type:

None

draw_profile(ax, h, norm=1.0, error_type='variance', **kwargs)[source]#

Profiled histograms contains the storage type “Mean” and can therefore not be normalized

Return type:

None

draw_errorbars(ax, h, norm=1.0, error_type='poisson_unweighted', **kwargs)[source]#
Return type:

None

plot_all(plot_config, style_config, skip_ratio=False, skip_legend=False, cms_label='wip', whitespace_fraction=0.3, magnitudes=4, **kwargs)[source]#

Function that calls multiple plotting methods based on two configuration dictionaries, plot_config and style_config.

The plot_config expects dictionaries with fields:

  • “method”: str, identical to the name of a function defined above

  • “hist”: hist.Hist or hist.Stack

  • “kwargs”: dict (optional)

  • “ratio_kwargs”: dict (optional)

The style_config expects fields (all optional):

  • “gridspec_cfg”: dict

  • “ax_cfg”: dict

  • “rax_cfg”: dict

  • “legend_cfg”: dict

  • “cms_label_cfg”: dict

Parameters:

  • plot_config (dict) – Dictionary that defines which plot methods will be called with which key word arguments.

  • style_config (dict) – Dictionary that defines arguments on how to style the overall plot.

  • skip_ratio (bool, default: False) – Optional bool parameter to not display the ratio plot.

  • skip_legend (bool, default: False) – Optional bool parameter to not display the legend.

  • cms_label (str, default: 'wip') – Optional string parameter to set the CMS label text.

  • whitespace_fraction (float, default: 0.3) – Optional float parameter that defines the ratio of which the plot will consist of whitespace for the legend and labels

  • magnitudes (float, default: 4) – Optional float parameter that defines the displayed ymin when plotting with a logarithmic scale.

Return type:

tuple[Figure, tuple[Axes, ...]]

Returns:

tuple of plot figure and axes

Contents