From 5b7dc63dd5cb119877c49dc97661df1aac0abc5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Renata=20Kopecn=C3=A1?= Date: Wed, 26 Jan 2022 17:28:02 +0100 Subject: [PATCH] Update 'Design.cpp' --- Design.cpp.md | 73 ++++++++++++++------------------------------------- 1 file changed, 20 insertions(+), 53 deletions(-) diff --git a/Design.cpp.md b/Design.cpp.md index ba0ffa7..0bdba18 100644 --- a/Design.cpp.md +++ b/Design.cpp.md @@ -6,7 +6,7 @@ Most of these functions are overloaded as ROOT was not always happy at compilati # Functions and their parameters: ### void design_markers() Takes an existing histogram/TEfficiency, defines marker style. The histogram markers and lines are set to have selected color. -Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the title and label offsets. +Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the title and label offsets of the axes. * **Parameters** * TH1F \*histogram OR TH1D \*histogram OR TEfficiency \*histogram * string xaxis_name @@ -15,7 +15,7 @@ Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the tit ### void design_lines() Takes an existing histogram, defines line style. The histogram lines are set to have selected color. -Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the title and label offsets. +Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the title and label offsets of the axes. * **Parameters** * TH1F \*histogram OR TH1D \*histogram OR TH1 \*histogram * string xaxis_name @@ -25,7 +25,7 @@ Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the tit ### void design_filled_plot() Takes an existing histogram, defines line width and the fill style. The histogram lines and fill are set to have selected color. -Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the title and label offsets. +Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the title and label offsets of the axes. * **Parameters** * TH1F \*histogram OR TH1D \*histogram * string xaxis_name @@ -35,7 +35,7 @@ Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the tit ### void design_filled_plot() -Calls `design_filled_plot()` defined above and on top sets the line color. +Calls [design_filled_plot()](#void-design_filled_plot) and sets the line color. * **Parameters** * TH1F \*histogram OR TH1D \*histogram * string xaxis_name @@ -86,7 +86,7 @@ Takes an existing canvas and sets the margins. Used for fancier plots. ### void design_TH2F() Takes an existing 2D histogram. The histogram markers and lines are set to have selected color. -Sets it's x-axis title to xaxis_name, y-axis name to yaxis_name and z-axis name to zaxis_name. Sets the title and label offsets, the histogram title is set to be empty. +Sets it's x-axis title to xaxis_name, y-axis name to yaxis_name and z-axis name to zaxis_name. Sets the title and label offsets of the axes, the histogram title is set to be empty. * **Parameters** * TH2F \*histogram OR TH2D \*histogram * string xaxis_name @@ -94,7 +94,7 @@ Sets it's x-axis title to xaxis_name, y-axis name to yaxis_name and z-axis name * string zaxis_name ### void design_TH2F() -Executes [design_TH2F()](#void-design_th2f) +Executes [design_TH2F()](#void-design_th2f) and sets the palette of the histogram. * **Parameters** * TH2F \*histogram OR TH2D \*histogram * string xaxis_name @@ -102,9 +102,9 @@ Executes [design_TH2F()](#void-design_th2f) * string zaxis_name * int palette - ### void design_TH2F_ratio() - +Takes an existing 2D histogram. The histogram markers and lines are set to have selected color. +Sets it's x-axis title to xaxis_name, y-axis name to yaxis_name and z-axis name to zaxis_name. Sets the title and label offsets of the axes. The palette is set. * **Parameters** * TH2F \*histogram OR TH2D \*histogram * string xaxis_name @@ -113,62 +113,43 @@ Executes [design_TH2F()](#void-design_th2f) * int palette ### void design_function() - +Takes an existing graph, sets the width and the color of lines. * **Parameters** * TF1 \*graph * Color_t color -* **Return** ### void design_function() - +Executes [design_function()](#void-design_function) and sets the line style. * **Parameters** * TF1 \*graph * Color_t color * int style * **Return** -### void design_TH1F() - +### void design_TH1F(), design_TH1D() +Takes an existing histogram, defines marker style. The histogram markers and lines are set to have selected color. +Sets it's x-axis title to xaxis_name and y-axis name to yaxis_name. Sets the title and label offsets of the axes.The title is set to be empty. * **Parameters** - * TH1F \*histogram + * TH1F \*histogram OR TH1D \*histogram * string xaxis_name * string yaxis_name * Color_t color -* **Return** -### void design_TH1D() +### void design_TH1F(), design_TH1D() +Executes [design_TH1F() or design_TH1D()](#void-design_th1f(),-design_th1d()) and sets the marker style. * **Parameters** - * TH1D \*histogram - * string xaxis_name - * string yaxis_name - * Color_t color -* **Return** - -### void design_TH1F() - -* **Parameters** - * TH1F \*histogram + * TH1F \*histogram OR TH1D \*histogram * string xaxis_name * string yaxis_name * Color_t color * int marker_style -* **Return** -### void design_TH1D() +### void design_TH1F(), design_TH1D() +Executes [design_TH1F() or design_TH1D()](#void-design_th1f(),-design_th1d()-1) and sets range of the x-axis to (x_low,x_up) and y-axis to (y_low,y_up). * **Parameters** - * TH1D \*histogram - * string xaxis_name - * string yaxis_name - * Color_t color - * int marker_style -* **Return** - -### void design_TH1F() - -* **Parameters** - * TH1F \*histogram + * TH1F \*histogram OR TH1D \*histogram * string xaxis_name * string yaxis_name * Color_t color @@ -177,21 +158,7 @@ Executes [design_TH2F()](#void-design_th2f) * double x_up * double y_low * double y_up -* **Return** -### void design_TH1D() - -* **Parameters** - * TH1D \*histogram - * string xaxis_name - * string yaxis_name - * Color_t color - * int marker_style - * double x_low - * double x_up - * double y_low - * double y_up -* **Return** ### TLine \*design_cut_line()