plot_functions_1d

plot_functions_1d#

Example plot functions for one-dimensional plots.

Functions:

plot_variable_per_process(hists, ...[, ...])

TODO: misleading function name, it should somehow contain "stack" and not "per_proceess"

plot_variable_variants(hists, config_inst, ...)

TODO.

plot_shifted_variable(hists, config_inst, ...)

TODO.

plot_cutflow(hists, config_inst, category_inst)

TODO.

plot_profile(hists, config_inst, ...[, ...])

Takes 2-dimensional histograms as an input and profiles over the second axis.
plot_variable_per_process(hists, config_inst, category_inst, variable_insts, style_config=None, density=False, shape_norm=False, yscale='', process_settings=None, variable_settings=None, **kwargs)[source]#

TODO: misleading function name, it should somehow contain “stack” and not “per_proceess”

Return type:

plt.Figure

plot_variable_variants(hists, config_inst, category_inst, variable_insts, style_config=None, density=False, shape_norm=False, yscale=None, hide_errors=None, variable_settings=None, **kwargs)[source]#

TODO.

Return type:

plt.Figure

plot_shifted_variable(hists, config_inst, category_inst, variable_insts, style_config=None, density=False, shape_norm=False, yscale=None, hide_errors=None, legend_title=None, process_settings=None, variable_settings=None, **kwargs)[source]#

TODO.

Return type:

plt.Figure

plot_cutflow(hists, config_inst, category_inst, style_config=None, density=False, shape_norm=False, yscale=None, process_settings=None, **kwargs)[source]#

TODO.

Return type:

plt.Figure

plot_profile(hists, config_inst, category_inst, variable_insts, style_config=None, density=False, yscale='', hide_errors=None, process_settings=None, variable_settings=None, skip_base_distribution=False, base_distribution_yscale='linear', skip_variations=False, **kwargs)[source]#

Takes 2-dimensional histograms as an input and profiles over the second axis.

This task adds two custom parameters, skip_base_distribution and base_distribution_yscale, that can be selected on command-line via the –general-settings parameter

Exemplary task call:

law run cf.PlotVariables1D --version prod1 --processes st_tchannel_t             --variables jet1_pt-jet2_pt             --plot-function columnflow.plotting.plot_functions_1d.plot_profile
Parameters:

  • skip_base_distribution (bool, default: False) – whether to skip adding distributions of the non-profiled histogram to the plot

  • base_distribution_yscale (str, default: 'linear') – yscale of the base distributions

  • skip_variations (bool, default: False) – whether to skip adding the up and down variation of the profile plot

Return type:

plt.Figure