From 100da72fccf6843cfde42f661813dd79e3836d53 Mon Sep 17 00:00:00 2001 From: Christopher Dilks Date: Sun, 1 Dec 2024 03:57:07 -0500 Subject: [PATCH] doc: fill out entry info --- doc/gen/Doxyfile.in | 1 + src/iguana/bankdefs/iguana.json | 68 ++++++++++++++++----------------- 2 files changed, 35 insertions(+), 34 deletions(-) diff --git a/doc/gen/Doxyfile.in b/doc/gen/Doxyfile.in index 042a88e0..1385851b 100644 --- a/doc/gen/Doxyfile.in +++ b/doc/gen/Doxyfile.in @@ -965,6 +965,7 @@ WARN_LOGFILE = INPUT = @top_srcdir@/src/ \ @top_builddir@/src/iguana/algorithms \ + @top_builddir@/src/iguana/bankdefs \ @top_srcdir@/bind/ \ @top_srcdir@/doc/gen/ \ @top_srcdir@/doc/gen/mainpage.md \ diff --git a/src/iguana/bankdefs/iguana.json b/src/iguana/bankdefs/iguana.json index 301c77fd..385cee7d 100644 --- a/src/iguana/bankdefs/iguana.json +++ b/src/iguana/bankdefs/iguana.json @@ -6,8 +6,8 @@ "info": "", "algorithm": "clas12::SectorFinder", "entries": [ - { "name": "pindex", "type": "S", "info": "row number in the particle bank"}, - { "name": "sector", "type": "I", "info": "sector for this particle"} + { "name": "pindex", "type": "S", "info": "row number in the particle bank" }, + { "name": "sector", "type": "I", "info": "sector for this particle" } ] }, { @@ -17,18 +17,18 @@ "info": "", "algorithm": "physics::InclusiveKinematics", "entries": [ - { "name": "pindex", "type": "S", "info": ""}, - { "name": "Q2", "type": "D", "info": ""}, - { "name": "x", "type": "D", "info": ""}, - { "name": "y", "type": "D", "info": ""}, - { "name": "W", "type": "D", "info": ""}, - { "name": "nu", "type": "D", "info": ""}, - { "name": "qx", "type": "D", "info": ""}, - { "name": "qy", "type": "D", "info": ""}, - { "name": "qz", "type": "D", "info": ""}, - { "name": "qE", "type": "D", "info": ""}, - { "name": "beamPz", "type": "D", "info": ""}, - { "name": "targetM", "type": "D", "info": ""} + { "name": "pindex", "type": "S", "info": "`REC::Particle` row (`pindex`) of the scattered electron" }, + { "name": "Q2", "type": "D", "info": "@latex{Q^2} (GeV@latex{^2})" }, + { "name": "x", "type": "D", "info": "@latex{x_B}" }, + { "name": "y", "type": "D", "info": "@latex{y}" }, + { "name": "W", "type": "D", "info": "@latex{W} (GeV)" }, + { "name": "nu", "type": "D", "info": "@latex{\\nu}" }, + { "name": "qx", "type": "D", "info": "@latex{x}-component of virtual photon momentum @latex{q}" }, + { "name": "qy", "type": "D", "info": "@latex{y}-component of virtual photon momentum @latex{q}" }, + { "name": "qz", "type": "D", "info": "@latex{z}-component of virtual photon momentum @latex{q}" }, + { "name": "qE", "type": "D", "info": "@latex{E}-component of virtual photon momentum @latex{q}" }, + { "name": "beamPz", "type": "D", "info": "beam momentum @latex{z}-component (GeV)" }, + { "name": "targetM", "type": "D", "info": "target mass (GeV)" } ] }, { @@ -38,14 +38,14 @@ "info": "", "algorithm": "physics::SingleHadronKinematics", "entries": [ - { "name": "pindex", "type": "S", "info": ""}, - { "name": "pdg", "type": "I", "info": ""}, - { "name": "z", "type": "D", "info": ""}, - { "name": "PhPerp", "type": "D", "info": ""}, - { "name": "MX", "type": "D", "info": ""}, - { "name": "xF", "type": "D", "info": ""}, - { "name": "phiH", "type": "D", "info": ""}, - { "name": "xi", "type": "D", "info": ""} + { "name": "pindex", "type": "S", "info": "`REC::Particle` row (`pindex`) of the hadron" }, + { "name": "pdg", "type": "I", "info": "PDG code of the hadron" }, + { "name": "z", "type": "D", "info": "@latex{z}: Momentum fraction of the fragmenting parton carried by the hadron" }, + { "name": "PhPerp", "type": "D", "info": "@latex{P_h^\\perp}: transverse momentum of the hadron in the @latex{\\perp}-frame (transverse to @latex{\\vec{q}})" }, + { "name": "MX", "type": "D", "info": "@latex{M_X(ehX)}: Missing mass of the hadron" }, + { "name": "xF", "type": "D", "info": "@latex{x_F}: Feynman-x of the hadron" }, + { "name": "phiH", "type": "D", "info": "@latex{\\phi_h}: @latex{q}-azimuthal angle between the lepton-scattering plane and the @latex{\\vec{q}\\times\\vec{P}_h} plane; if the value is `tools::UNDEF`, the calculation failed" }, + { "name": "xi", "type": "D", "info": "@latex{\\xi_h}: Longitudinal momentum fraction of the nucleon carried by the hadron" } ] }, { @@ -55,18 +55,18 @@ "info": "", "algorithm": "physics::DihadronKinematics", "entries": [ - { "name": "pindex_a", "type": "S", "info": ""}, - { "name": "pindex_b", "type": "S", "info": ""}, - { "name": "pdg_a", "type": "I", "info": ""}, - { "name": "pdg_b", "type": "I", "info": ""}, - { "name": "Mh", "type": "D", "info": ""}, - { "name": "z", "type": "D", "info": ""}, - { "name": "PhPerp", "type": "D", "info": ""}, - { "name": "MX", "type": "D", "info": ""}, - { "name": "xF", "type": "D", "info": ""}, - { "name": "phiH", "type": "D", "info": ""}, - { "name": "phiR", "type": "D", "info": ""}, - { "name": "theta", "type": "D", "info": ""} + { "name": "pindex_a", "type": "S", "info": "`REC::Particle` row (`pindex`) of hadron A" }, + { "name": "pindex_b", "type": "S", "info": "`REC::Particle` row (`pindex`) of hadron B" }, + { "name": "pdg_a", "type": "I", "info": "PDG code of hadron A" }, + { "name": "pdg_b", "type": "I", "info": "PDG code of hadron B" }, + { "name": "Mh", "type": "D", "info": "@latex{M_h}: Invariant mass of the dihadron" }, + { "name": "z", "type": "D", "info": "@latex{z}: Momentum fraction of the fragmenting parton carried by the dihadron" }, + { "name": "PhPerp", "type": "D", "info": "@latex{P_h^\\perp}: transverse momentum of the dihadron in the @latex{\\perp}-frame (transverse to @latex{\\vec{q}})" }, + { "name": "MX", "type": "D", "info": "@latex{M_X(ehhX)}: Missing mass of the dihadron" }, + { "name": "xF", "type": "D", "info": "@latex{x_F}: Feynman-x of the dihadron" }, + { "name": "phiH", "type": "D", "info": "@latex{\\phi_h}: @latex{q}-azimuthal angle between the lepton-scattering plane and the @latex{\\vec{q}\\times\\vec{P}_h} plane; if the value is `tools::UNDEF`, the calculation failed" }, + { "name": "phiR", "type": "D", "info": "@latex{\\phi_R}: @latex{q}-azimuthal angle between the lepton-scattering plane and dihadron plane; if the value is `tools::UNDEF`, the calculation failed" }, + { "name": "theta", "type": "D", "info": "@latex{\\theta}: The 'decay' angle of hadron A in the dihadron rest frame, with respect; to the dihadron momentum direction" } ] } ]