Skip to content

Commit d11aef6

Browse files
senabibisiliataider
senabibi
authored and
siliataider
committed
[doc][UHI] Updated Doxygen file.
1 parent d0b9c45 commit d11aef6

File tree

3 files changed

+49
-167
lines changed

3 files changed

+49
-167
lines changed

‎tutorials/CMakeLists.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -906,7 +906,6 @@ if(ROOT_pyroot_FOUND)
906906
hist/hist007_TH1_liveupdate_uhi.py
907907
hist/hist010_TH1_two_scales_uhi.py
908908
hist/hist015_TH1_read_and_draw_uhi.py
909-
hist/hist105_TExec_dynamic_slice_uhi.py
910909
)
911910

912911
file(GLOB requires_numba RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}

‎tutorials/hist/hist105_TExec_dynamic_slice_uhi.py‎

Lines changed: 0 additions & 125 deletions
This file was deleted.

‎tutorials/hist/index.md‎

Lines changed: 49 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
\addtogroup tutorial_hist
22

3+
34
@{
45
A histogram is a visual representation of the distribution of quantitative data.
56
[TH1 class](classTH1.html) introduces the basic data structure used in root for histograms.
@@ -58,35 +59,38 @@ Explore the examples below for [different histogram classes](group__Histograms.h
5859

5960
\anchor th1
6061

61-
## TH1 Histograms
6262

63-
These examples shows some of the ratioplots
64-
65-
| **Tutorial** || **Description** |
66-
|-------------|-------------|----------------------------|
67-
|hist000_TH1_first.C||Hello World example for TH1.|
68-
|hist001_TH1_fillrandom.C|hist001_TH1_fillrandom.py|Fill a 1D histogram with random values using predefined functions.|
69-
|hist002_TH1_fillrandom_userfunc.C||Fill a 1D histogram from a user-defined parametric function.|
70-
|hist003_TH1_draw.C||Draw a 1D histogram to a canva.|
71-
|hist004_TH1_labels.C||1D histograms with alphanumeric labels.|
72-
|hist005_TH1_palettecolor.C||Palette coloring for TH1.|
73-
|hist006_TH1_bar_charts.C||Draw 1D histograms as bar charts.|
74-
|hist007_TH1_liveupdate.C|hist007_TH1_liveupdate.py|Histograms filled and drawn in a loop.|
75-
|hist008_TH1_zoom.C||Change the range of an axis in a Histogram.|
76-
|hist009_TH1_normalize.C||Normalizing a Histogram.|
77-
|hist010_TH1_two_scales.C|hist010_TH1_two_scales.py|Draw two histograms on one canva using different y-axis scales.|
78-
|hist011_TH1_legend_autoplaced.C||Automatic placing of the legend.|
79-
|hist012_TH1_hksimple.C||Dynamic filling of TH1K histograms.|
80-
|hist013_TH1_rebin.C||Create a variable bin-width histogram and change bin sizes.|
81-
|hist014_TH1_cumulative.C||Illustrate use of the TH1::GetCumulative method.|
82-
|hist015_TH1_read_and_draw.C|hist015_TH1_read_and_draw.py|Read a 1D histogram from a ROOT File and draw it.|
83-
|hist016_TH1_different_scales_canvas.C||Draw two histograms on one canva using different y-axis scales.|
84-
|hist017_TH1_smooth.C||Histogram smoothing.|
85-
|hist060_TH1_stats.C||Edit statistics box.|
86-
|hist061_TH1_timeonaxis.C||Use a time axis as an x axis.|
87-
|hist062_TH1_timeonaxis2.C||Use a time axis as an x axis and use a time offset.|
88-
|hist063_TH1_seism.C||Use a time axis as an x axis to show sine signal as a strip chart.|
89-
|hist101_TH1_autobinning.C||Fill multiple histograms with different functions and automatic binning.|
63+
## TH1 Histograms
64+
The examples below showcase the same functionalities through 3 different implementations: the first column is a C++ macro, the second column corresponds to the Python implementation, and the third column is a Python implementation showcasing the newest Pythonizations available in ROOT.
65+
66+
67+
## Tutorial
68+
| | **Tutorial** | | **Description** |
69+
|------------------------------------|---------------------------------|-------------------------------|------------------------|
70+
|**C++ macro** |**Python** |**Python+Newest Pythonization**||
71+
| hist000_TH1_first.C | hist000_TH1_first.py | hist000_TH1_first_uhi.py |Hello World example for TH1. |
72+
| hist001_TH1_fillrandom.C | hist001_TH1_fillrandom.py | hist001_TH1_fillrandom_uhi.py | Fill a 1D histogram with random values using predefined functions. |
73+
| hist002_TH1_fillrandom_userfunc.C | hist002_TH1_fillrandom_userfunc.py |hist002_TH1_fillrandom_userfunc_uhi.py| Fill a 1D histogram from a user-defined parametric function. |
74+
| hist003_TH1_draw.C | hist003_TH1_draw.py | hist003_TH1_draw_uhi.py|Draw a 1D histogram to a canvas. |
75+
| hist004_TH1_labels.C | | | 1D histograms with alphanumeric labels. |
76+
| hist005_TH1_palettecolor.C | | | Palette coloring for TH1. |
77+
| hist006_TH1_bar_charts.C | | | Draw 1D histograms as bar charts. |
78+
| hist007_TH1_liveupdate.C | hist007_TH1_liveupdate.py |hist007_TH1_liveupdate_uhi.py | Histograms filled and drawn in a loop. |
79+
| hist008_TH1_zoom.C | | | Change the range of an axis in a Histogram. |
80+
| hist009_TH1_normalize.C | | | Normalizing a Histogram. |
81+
| hist010_TH1_two_scales.C | hist010_TH1_two_scales.py | hist010_TH1_two_scales_uhi.py|Draw two histograms on one canvas using different y-axis scales. |
82+
| hist011_TH1_legend_autoplaced.C | | | Automatic placing of the legend. |
83+
| hist012_TH1_hksimple.C | | | Dynamic filling of TH1K histograms. |
84+
| hist013_TH1_rebin.C | | | Create a variable bin-width histogram and change bin sizes. |
85+
| hist014_TH1_cumulative.C | | | Illustrate use of the TH1::GetCumulative method. |
86+
| hist015_TH1_read_and_draw.C | hist015_TH1_read_and_draw.py | hist015_TH1_read_and_draw_uhi.py|Read a 1D histogram from a ROOT File and draw it. |
87+
| hist016_TH1_different_scales_canvas.C | | | Draw two histograms on one canvas using different y-axis scales. |
88+
| hist017_TH1_smooth.C | | | Histogram smoothing. |
89+
| hist060_TH1_stats.C | | | Edit statistics box. |
90+
| hist061_TH1_timeonaxis.C | | | Use a time axis as an x axis. |
91+
| hist062_TH1_timeonaxis2.C | | | Use a time axis as an x axis and use a time offset. |
92+
| hist063_TH1_seism.C | | | Use a time axis as an x axis to show sine signal as a strip chart. |
93+
| hist101_TH1_autobinning.C | | | Fill multiple histograms with different functions and automatic binning. |
9094

9195
\anchor th2
9296

@@ -125,14 +129,16 @@ These examples shows some of the ratioplots
125129

126130
## Ratio plots
127131

128-
| **Tutorial** || **Description** |
129-
|------------|--------------|----------------------------|
130-
|hist029_TRatioPlot_simple.C|hist029_TRatioPlot_simple.py|Create a simple ratio plot of two histograms using the `pois` division option.|
131-
|hist030_TRatioPlot_residual.C|hist030_TRatioPlot_residual.py|Create a fit residual plot.|
132-
|hist031_TRatioPlot_residual_fit.C|hist031_TRatioPlot_residual_fit.py|Create a fit residual plot and set the y-axis range for it.|
133-
|hist032_TRatioPlot_fit_lines.C|hist032_TRatioPlot_fit_lines.py|Set custom dashed lines specified by a vector of floats.|
134-
|hist033_TRatioPlot_fit_confidence.C|hist033_TRatioPlot_fit_confidence.py|Set the colors of the confidence interval bands by using|
135-
|hist034_TRatioPlot_fit_margin.C|hist034_TRatioPlot_fit_margin.py|Create a fit residual plot, where the separation margin has been set to 0.|
132+
| | **Tutorial** | | **Description** |
133+
|------------------------------------|---------------------------------|-------------------------------|------------------------|
134+
|**C++ macro** |**Python** |**Python+Newest Pythonization**| |
135+
|hist029_TRatioPlot_simple.C|hist029_TRatioPlot_simple.py||Create a simple ratio plot of two histograms using the `pois` division option.|
136+
|hist030_TRatioPlot_residual.C|hist030_TRatioPlot_residual.py|hist030_TRatioPlot_residual_uhi.py |Create a fit residual plot.|
137+
|hist031_TRatioPlot_residual_fit.C|hist031_TRatioPlot_residual_fit.py||Create a fit residual plot and set the y-axis range for it.|
138+
|hist032_TRatioPlot_fit_lines.C|hist032_TRatioPlot_fit_lines.py||Set custom dashed lines specified by a vector of floats.|
139+
|hist033_TRatioPlot_fit_confidence.C|hist033_TRatioPlot_fit_confidence.py||Set the colors of the confidence interval bands by using|
140+
|hist034_TRatioPlot_fit_margin.C|hist034_TRatioPlot_fit_margin.py||Create a fit residual plot, where the separation margin has been set to 0.|
141+
136142

137143

138144
\anchor tpoly
@@ -172,12 +178,14 @@ These examples shows some of the ratioplots
172178

173179
## TExec
174180

175-
| **Tutorial** || **Description** |
176-
|------------|--------------|----------------------------|
177-
|hist057_TExec_th1.C||Echo object at mouse position.|
178-
|hist058_TExec_th2.C||Echo object at mouse position and show a graphics line.|
179-
|hist105_TExec_dynamic_slice.C|hist105_TExec_dynamic_slice.py|Show the slice of a TH2 following the mouse position.|
181+
| | **Tutorial** | | **Description** |
182+
|------------------------------------|---------------------------------|-------------------------------|------------------------|
183+
|**C++ macro** |**Python** |**Python+Newest Pythonization**||
184+
|hist057_TExec_th1.C | | |Echo object at mouse position.|
185+
|hist058_TExec_th2.C | | |Echo object at mouse position and show a graphics line.|
186+
|hist105_TExec_dynamic_slice.C |hist105_TExec_dynamic_slice.py ||Show the slice of a TH2 following the mouse position.|
180187

181188
\anchor hist_alltutorials
182189

183190
@}
191+

0 commit comments

Comments
 (0)