FinalState.hh

Go to the documentation of this file.

// -*- C++ -*-
#ifndef RIVET_FinalState_HH
#define RIVET_FinalState_HH

#include "Rivet/Projection.hh"
#include "Rivet/Particle.hh"
#include "Rivet/Event.hh"


namespace Rivet {

  /// Project out all final-state particles in an event.
  class FinalState: public Projection {
    
  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).
    inline FinalState(double mineta = -MaxRapidity,
                      double maxeta = MaxRapidity,
                      double minpt = 0.0)
      : _etamin(mineta), _etamax(maxeta), _ptmin(minpt) 
    { 
      addCut("eta", MORE_EQ, mineta);
      addCut("eta", LESS_EQ, maxeta);
      addCut("pT",  MORE_EQ, minpt);
    }
    
    /// Return the name of the projection
    inline string getName() const {
      return "FinalState";
    }
    
    /// Access the projected final-state particles.
    inline const ParticleVector& particles() const { return _theParticles; }

    /// Is this final state empty?
    inline const bool isEmpty() const { return _theParticles.empty(); }

  protected:
    
    /// Apply the projection to the event.
    void project(const Event& e);
    
    /// Compare projections.
    int compare(const Projection& p) const;
    
    
  private:
    
    /// The minimum allowed pseudorapidity.
    double _etamin;
    
    /// The maximum allowed pseudorapidity.
    double _etamax;
    
    /// The minimum allowed transverse momentum.
    double _ptmin;

  protected:
    
    /// The final-state particles.
    ParticleVector _theParticles;
    
  };
  
}


#endif