Skip to content

[skip-ci] improve documentation #20686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
couet merged 1 commit into from
Dec 11, 2025
Merged

[skip-ci] improve documentation #20686

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions graf2d/gpad/src/TRatioPlot.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@
\ingroup gpad
Class for displaying ratios, differences and fit residuals.

RatioPlot is a helper class designed to draw ratios; it is not meant to be a persistent
object on its own. Therefore, saving a TRatioPlot in a ROOT file (or exporting it directly
as a PDF or PNG) does not make sense, because it is not a self-contained entity like a TH1
or a TGraph. TRatioPlot is specifically designed to arrange pads, which becomes evident
when inspecting the pad contents (using gPad->ls()): multiple pads and axes are created.
To save its visual output, you should print the entire canvas in formats such as PDF, SVG, or PNG.

TRatioPlot has two constructors, one which accepts two histograms, and is responsible
for setting up the calculation of ratios and differences. This calculation is in part
delegated to `TEfficiency`. A single option can be given as a parameter, that is
Expand Down