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

[blackhole at projects.hepforge.org]

Author: buckley
Date: Tue Aug 23 14:46:47 2011
New Revision: 3323

Log:
Add some more Doxygen description to the UnstableFinalState

Modified:
   trunk/include/Rivet/Projections/UnstableFinalState.hh

Modified: trunk/include/Rivet/Projections/UnstableFinalState.hh
==============================================================================
--- trunk/include/Rivet/Projections/UnstableFinalState.hh	Tue Aug 23 14:46:05 2011	(r3322)
+++ trunk/include/Rivet/Projections/UnstableFinalState.hh	Tue Aug 23 14:46:47 2011	(r3323)
@@ -10,11 +10,23 @@
 
 
   /// @brief Project out all physical-but-decayed particles in an event.
+  ///
+  /// The particles returned by the UFS are unique unstable particles, such as
+  /// hadrons which are decayed by the generator. If, for example, you set Ks
+  /// and Lambda particles stable in the generator, they will not be returned by
+  /// the UFS. Also, you should be aware that all unstable particles in a decay
+  /// chain are returned: if you are looking for something like the number of B
+  /// hadrons in an event and there is a decay chain from e.g. B** -> B, you
+  /// will count both B mesons unless you are careful to check for
+  /// ancestor/descendent relations between the particles. Duplicate particles
+  /// in the event record, i.e. those which differ only in bookkeeping details
+  /// or photon emissions, are stripped from the returned particles collection.
   class UnstableFinalState : public FinalState {
   public:
 
     /// @name Standard constructors and destructors.
     //@{
+
     /// The default constructor. May specify the minimum and maximum
     /// pseudorapidity \f$ \eta \f$ and the min \f$ p_T \f$ (in GeV).
     UnstableFinalState(double mineta = -MAXRAPIDITY,
@@ -33,8 +45,13 @@
     virtual const Projection* clone() const {
       return new UnstableFinalState(*this);
     }
+
     //@}
 
+
+    /// @name Accessors
+    //@{
+
     /// Access the projected final-state particles.
     virtual const ParticleVector& particles() const { return _theParticles; }
 
@@ -44,6 +61,8 @@
     /// @deprecated Is this final state empty?
     virtual bool isEmpty() const { return _theParticles.empty(); }
 
+    //@}
+
 
   protected: