hh-common-plot is a configuration-based plotting tool that allows to superimpose several one-dimensional limits in a single plot.
Plotting package is installed together with HHStatAnalysis, if the recommended installation procedure is used. Here is the recommended way to install only the plotting tools:
curl -s https://raw.githubusercontent.com/cms-hh/HHStatAnalysis/master/install.sh | bash -s plottingXcode Command Line Tools (OS X only), CERN ROOT, Boost C++ Libraries.
mkdir HHStatAnalysis
cd HHStatAnalysis
git init
git remote add cms-hh [email protected]:cms-hh/HHStatAnalysis.git
git config core.sparsecheckout true
echo -e "Core/" >> .git/info/sparse-checkout
git pull cms-hh master
cd ..
git clone -o cms-hh [email protected]:cms-hh/Plotting.git HHStatAnalysis/Plotting
git clone -o cms-hh [email protected]:cms-hh/Resources.git HHStatAnalysis/Resources
cd HHStatAnalysis
mkdir build
cd build
cmake ../Plotting
make
cd ..cd HHStatAnalysis
hh-common-plot --help # output command line help
hh-common-plot --config Resources/Plots/configs/run2_plot.cfg --input Resources/Limits --output Resources/Plots/Limits/run2_plot_cms_spin0.pdf --plot hh_common_plot_cms_spin0 # produce CMS only spin0 Run II common plot below 1 TeV
hh-common-plot --config Resources/Plots/configs/run2_plot.cfg --input Resources/Limits --output Resources/Plots/Limits/run2_plot_cms_spin2.pdf --plot hh_common_plot_cms_spin2 # produce CMS only spin2 Run II common plot below 1 TeV
hh-common-plot --config Resources/Plots/configs/run2_plot.cfg --input Resources/Limits --output Resources/Plots/Limits/run2_plot_cms_extended_spin0.pdf --plot hh_common_plot_cms_extended_spin0 # produce CMS only spin0 Run II common plot below and above 1 TeV
hh-common-plot --config Resources/Plots/configs/run2_plot.cfg --input Resources/Limits --output Resources/Plots/Limits/run2_plot_cms_extended_spin2.pdf --plot hh_common_plot_cms_extended_spin2 # produce CMS only spin2 Run II common plot below and above 1 TeV
hh-common-plot --config Resources/Plots/configs/run2_plot.cfg --input Resources/Limits --output Resources/Plots/Limits/run2_plot_lhc_spin0.pdf --plot hh_common_plot_lhc_spin0 # produce LHC spin0 Run II common plot below 1 TeV
hh-common-plot --config Resources/Plots/configs/run2_plot.cfg --input Resources/Limits --output Resources/Plots/Limits/run2_plot_lhc_spin2.pdf --plot hh_common_plot_lhc_spin2 # produce LHC spin2 Run II common plot below 1 TeV
hh-common-plot --config Resources/Plots/configs/run2_plot.cfg --input Resources/Limits --output Resources/Plots/Limits/run2_plot_lhc_extended_spin0.pdf --plot hh_common_plot_lhc_extended_spin0 # produce LHC spin0 Run II common plot below and above 1 TeV
hh-common-plot --config Resources/Plots/configs/run2_plot.cfg --input Resources/Limits --output Resources/Plots/Limits/run2_plot_lhc_extended_spin2.pdf --plot hh_common_plot_lhc_extended_spin2 # produce LHC spin2 Run II common plot below and above 1 TeFor standalone installation run ./build/hh-common-plot.
Used text-based configuration format originally implemented and used within hh-italian-group framework (https://github.com/hh-italian-group/AnalysisTools/).
Configuration is represented as a list of configuration entries. Each configuration entry starts with entry header and ends with an empty line. Entry header has a following format:
[TYPE entry_name]
OR
[TYPE entry_name : reference_entry_name]
where TYPE is entry type and can be omitted for the default entry type, entry_name is the entry name that should be unique for a given TYPE, reference_entry_name the name of a reference entry of the same type that is used to initialize the entry.
Each configuration entry is a set of properties. Each property is represented by one line in the configuration file and has a following format:
property_name: property_value
Each entry type defines its own set of properties, related parsing rules and allowed property multiplicity.
Other remarks:
- spaces in entry and property names are not allowed;
- lines that starts with "#" are considered as commentary and are ignored by the configuration parser.
Entry type name is PLOT.
| Name | Description | Value format | Multiplicity |
|---|---|---|---|
| canvas_size | size of the canvas | x_size y_size | ≤ 1 |
| margins | main pad margins | left bottom right top | ≤ 1 |
| x_range | x axis range | x_min x_max | ≤ 1 |
| y_range | y axis range | y_min y_max | ≤ 1 |
| units | y axis units | pb | fb | ≤ 1 |
| x_title | x axis title | TLatex text | ≤ 1 |
| y_title | y axis title | TLatex text | ≤ 1 |
| axis_title_size | size of the axis titles | x_size y_size | ≤ 1 |
| axis_title_offset | offset of the axis titles | x_offset y_offset | ≤ 1 |
| axis_label_size | size of the axis labels | x_size y_size | ≤ 1 |
| axis_label_offset | offset of the axis labels | x_offset y_offset | ≤ 1 |
| log_scale | true/false flags that indicates if log scale should be used | log_x log_y | ≤ 1 |
| limit_line_style | Style_t for a given limit type | limit_type style_code | ≥ 0 |
| limit_legend_label | Label for the auxiliary legend for a given limit type | limit_type label_text | ≥ 0 |
| limit | Name of a limit entry that should be included in the plot. Order in which limits are specified defines order of their appearance in the legend and their drawing order. Special limit entry name NULL corresponds to the empty entry in the legend. | limit_entry_name | ≥ 0 |
| label | Name of a label entry that should be included in the plot. | label_entry_name | ≥ 0 |
| legend | Name of a legend entry that should be included in the plot. | legend_entry_name | ≥ 0 |
Entry type name is LIMIT. It is the default entry type.
| Name | Description | Value format | Multiplicity |
|---|---|---|---|
| title | text that should be used in the legend | TLatex text | ≤ 1 |
| source_format | format of the input file/files | combine_root | combine_log | text_table | ≤ 1 |
| mass_value_pattern | in case of one input file per mass point, regular expression that should be used to extract mass value from the file name | mass_regex | ≤ 1 |
| source_path | relative path to the input file or directory. Each source_path entry corresponds to a separate TGraph. | path | ≥ 0 |
| units | input units | pb | fb | ≤ 1 |
| scale_factor | additional scale factor that should be used to normalize input limit values. TF1-compatible numerical equation might be used. Default value is 1. If more than one scale_factor properties are specified, they should be defined in the same order as source_path entries. | tf1_formula | ≥ 0 |
| limit_type | limit type that should be plotted | predicted | observed | expected | expected+1sigma | expected-1sigma | expected+2sigma | expected-2sigma | ≥ 0 |
| line_color | color of the limit line. It can be one of the ROOT color wheel colors (e.g. kOrange+3) or a hex RGB color code (e.g. #0000FF). | color | ≤ 1 |
| line_width | width of the limit line. (line_width > 0) | width | ≤ 1 |
| show_in_legend | true/false indicator whether the limit entry should be shown in the legend or not. | true | false | ≤ 1 |
| columns | for the text_table source format, this property describes the columns content in the input table. "mX" - column with resonance mass; "BR..." - columns with additional branching ratio factors; "limit_type" - columns with values for the specified limit type; "+-Xsigma" - columns with limit uncertainty values that are relative to the expected value; all other columns are considered as non informative (arbitrary column description can be used). | column_1 ... column_N | ≤ 1 |
Entry type name is LABEL.
| Name | Description | Value format | Multiplicity |
|---|---|---|---|
| text | each text property corresponds to a text line of the label | TLatex text | ≥ 0 |
| position | (x, y) absolute or relative (to the position_reference reference) position of the entry. In case of the relative position, position coordinates are scaled to the user plot area (i.e. excluding margins). If position_reference is one of the angles of the plot rectangle, the coordinate system is originated in this angle with the positive x, y directions towards center of the plot. | x y | ≤ 1 |
| position_reference | reference for the label position. It could be one of the angles of the plot inner rectangle (excluding margins), other label or legend entry. | inner_left_top | inner_right_top | inner_left_bottom | inner_right_bottom | label_entry_name | legend_entry_name | ≤ 1 |
| text_size | size of the label text | text_size | ≤ 1 |
| line_spacing | spacing between the text lines in the units relative to the line width. | spacing_size | ≤ 1 |
| font | text font | font_id | ≤ 1 |
| color | text color (same format as line_color for limit entry) | color | ≤ 1 |
| align | text alignment | left_bottom | left_center | left_top | center_bottom | center | center_top | right_bottom | right_center | right_top | ≤ 1 |
Entry type name is LEGEND.
| Name | Description | Value format | Multiplicity |
|---|---|---|---|
| type | type of the legend | main | auxiliary | ≤ 1 |
| position | (x, y) absolute or relative position of the entry (similar definition as for label entry) | x y | ≤ 1 |
| size | (x, y) size of the legend. In case if position_reference is specified, size is scaled to the user plot area (i.e. excluding margins). | size_x size_y | ≤ 1 |
| position_reference | reference for the legend position (similar definition as for label entry) | inner_left_top | inner_right_top | inner_left_bottom | inner_right_bottom | label_entry_name | legend_entry_name | ≤ 1 |
| text_size | size of the legend text | text_size | ≤ 1 |
| font | text font | font_id | ≤ 1 |
| color | text color (same format as line_color for limit entry) | color | ≤ 1 |
| line_width | for auxiliary legend, width of the entry lines | width | ≤ 1 |