[Rivet-svn] r3360 - trunk/include/Rivet/Projections

[blackhole at projects.hepforge.org]

Author: fsiegert
Date: Thu Sep 15 15:39:05 2011
New Revision: 3360

Log:
Add more extensive documentation to W/ZFinder constructors.

Modified:
   trunk/include/Rivet/Projections/WFinder.hh
   trunk/include/Rivet/Projections/ZFinder.hh

Modified: trunk/include/Rivet/Projections/WFinder.hh
==============================================================================
--- trunk/include/Rivet/Projections/WFinder.hh	Thu Sep 15 15:06:47 2011	(r3359)
+++ trunk/include/Rivet/Projections/WFinder.hh	Thu Sep 15 15:39:05 2011	(r3360)
@@ -23,19 +23,17 @@
     /// @name Constructors
     //@{
 
-    // /// Constructor taking a FinalState and type of the charged lepton, mass window,
-    // /// and maximum dR of photons around the charged lepton to take into account for W
-    // /// reconstruction.
-    // WFinder(const ChargedFinalState& fs_l,
-    //         PdgId pid,
-    //         double minmass, double maxmass,
-    //         double missingET,
-    //         double dRmax, bool clusterPhotons, bool excludePhotonsFromRFS);
-
-
-    /// Constructor taking single eta/pT bounds and type of the charged lepton, transverse mass
-    /// window, and maximum dR of photons around the charged lepton to take into account
-    /// for W reconstruction.
+    /// Constructor taking single eta/pT bounds
+    /// @param pid type of the charged lepton
+    /// @param minmass,maxmass (transverse) mass window
+    /// @param missingET minimal amount of missing ET (neutrinos) required
+    /// @param dRmax maximum dR of photons around charged lepton to take into account
+    ///  for W reconstruction (only relevant if one of the following are true)
+    /// @param clusterPhotons whether such photons are supposed to be
+    ///  clustered to the lepton object and thus W mom
+    /// @param trackPhotons whether such photons should be added to _theParticles
+    ///  (cf. _trackPhotons)
+    /// @param useTransverseMass whether mass window should be applied using mT
     WFinder(double etaMin, double etaMax,
             double pTmin,
             PdgId pid,
@@ -46,9 +44,17 @@
             bool useTransverseMass=false);
 
 
-    /// Constructor taking multiple eta/pT bounds and type of the charged lepton, transverse mass
-    /// window, and maximum dR of photons around the charged lepton to take into account
-    /// for W reconstruction.
+    /// Constructor taking multiple eta/pT bounds
+    /// @param pid type of the charged lepton
+    /// @param minmass,maxmass (transverse) mass window
+    /// @param missingET minimal amount of missing ET (neutrinos) required
+    /// @param dRmax maximum dR of photons around charged lepton to take into account
+    ///  for W reconstruction (only relevant if one of the following are true)
+    /// @param clusterPhotons whether such photons are supposed to be
+    ///  clustered to the lepton object and thus W mom
+    /// @param trackPhotons whether such photons should be added to _theParticles
+    ///  (cf. _trackPhotons)
+    /// @param useTransverseMass whether mass window should be applied using mT
     WFinder(const std::vector<std::pair<double, double> >& etaRanges,
             double pTmin,
             PdgId pid,

Modified: trunk/include/Rivet/Projections/ZFinder.hh
==============================================================================
--- trunk/include/Rivet/Projections/ZFinder.hh	Thu Sep 15 15:06:47 2011	(r3359)
+++ trunk/include/Rivet/Projections/ZFinder.hh	Thu Sep 15 15:39:05 2011	(r3360)
@@ -24,12 +24,15 @@
     /// @name Constructors
     //@{
 
-    /// Constructor taking single eta/pT bounds and type of the leptons, mass
-    /// window, and maximum dR of photons around leptons to take into account
-    /// for Z reconstruction.
-    /// It has to be specified separately whether such photons are
-    /// supposed to be clustered to the lepton objects and whether they should
-    /// be excluded from the remaining FS.
+    /// Constructor taking single eta/pT bounds
+    /// @param pid type of the leptons
+    /// @param minmass,maxmass mass window
+    /// @param dRmax maximum dR of photons around leptons to take into account
+    ///  for Z reconstruction (only relevant if one of the following are true)
+    /// @param clusterPhotons whether such photons are supposed to be
+    ///  clustered to the lepton objects and thus Z mom
+    /// @param trackPhotons whether such photons should be added to _theParticles
+    ///  (cf. _trackPhotons)
     ZFinder(double etaMin, double etaMax,
             double pTmin,
             PdgId pid,
@@ -38,12 +41,15 @@
             double masstarget=91.2*GeV);
 
 
-    /// Constructor taking multiple eta/pT bounds and type of the leptons, mass
-    /// window, and maximum dR of photons around leptons to take into account
-    /// for Z reconstruction.
-    /// It has to be specified separately whether such photons are
-    /// supposed to be clustered to the lepton objects and whether they should
-    /// be excluded from the remaining FS.
+    /// Constructor taking multiple eta/pT bounds
+    /// @param pid type of the leptons
+    /// @param minmass,maxmass mass window
+    /// @param dRmax maximum dR of photons around leptons to take into account
+    ///  for Z reconstruction (only relevant if one of the following are true)
+    /// @param clusterPhotons whether such photons are supposed to be
+    ///  clustered to the lepton objects and thus Z mom
+    /// @param trackPhotons whether such photons should be added to _theParticles
+    ///  (cf. _trackPhotons)
     ZFinder(const std::vector<std::pair<double, double> >& etaRanges,
             double pTmin,
             PdgId pid,