Skip to content

Commit 87df4ed

Browse files
committed
[skip-ci] improve documentation
1 parent e677a75 commit 87df4ed

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

graf2d/gpad/src/TRatioPlot.cxx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@
3131
\ingroup gpad
3232
Class for displaying ratios, differences and fit residuals.
3333
34+
RatioPlot is a helper class designed to draw ratios; it is not meant to be a persistent
35+
object on its own. Therefore, saving a TRatioPlot in a ROOT file (or exporting it directly
36+
as a PDF or PNG) does not make sense, because it is not a self-contained entity like a TH1
37+
or a TGraph. TRatioPlot is specifically designed to arrange pads, which becomes evident
38+
when inspecting the pad contents (using gPad->ls()): multiple pads and axes are created.
39+
To save its visual output, you should print the entire canvas in formats such as PDF, SVG, or PNG.
40+
3441
TRatioPlot has two constructors, one which accepts two histograms, and is responsible
3542
for setting up the calculation of ratios and differences. This calculation is in part
3643
delegated to `TEfficiency`. A single option can be given as a parameter, that is

0 commit comments

Comments
 (0)