DISLepton Class Reference

#include <DISLepton.hh>

Inheritance diagram for DISLepton:

[legend]

Collaboration diagram for DISLepton:

[legend]

List of all members.

---

Detailed Description

This class projects out the incoming and outgoing leptons in a DIS event.

Definition at line 15 of file DISLepton.hh.

Public Member Functions
const Particle &	in () const
	The incoming lepton.
const Particle &	out () const
	The outgoing lepton.
const double &	pzSign () const
bool	before (const Projection &p) const
virtual const std::set< BeamPair >	beamPairs () const
virtual std::string	name () const
	Get the name of the projection.
Projection &	addBeamPair (const ParticleName &beam1, const ParticleName &beam2)
	Add a colliding beam pair.
Log &	getLog () const
	Get a Log object based on the getName() property of the calling projection object.
void	setName (const std::string &name)
	Used by derived classes to set their name.
Constructors.
	DISLepton ()
virtual const Projection *	clone () const
	Clone on the heap.
Projection "getting" functions
std::set< ConstProjectionPtr >	getProjections () const
	Get the contained projections, including recursion.
template<typename PROJ>
const PROJ &	getProjection (const std::string &name) const
	Get the named projection, specifying return type via a template argument.
const Projection &	getProjection (const std::string &name) const
Projection applying functions
template<typename PROJ>
const PROJ &	applyProjection (const Event &evt, const PROJ &proj) const
	Apply the supplied projection on event.
template<typename PROJ>
const PROJ &	applyProjection (const Event &evt, const Projection &proj) const
	Apply the supplied projection on event.
template<typename PROJ>
const PROJ &	applyProjection (const Event &evt, const std::string &name) const
	Apply the named projection on event.
Protected Member Functions
virtual void	project (const Event &e)
	Perform the projection operation on the supplied event.
virtual int	compare (const Projection &p) const
	Compare with other projections.
Cmp< Projection >	mkNamedPCmp (const Projection &otherparent, const std::string &pname) const
Cmp< Projection >	mkPCmp (const Projection &otherparent, const std::string &pname) const
ProjectionHandler &	getProjHandler () const
	Get a reference to the ProjectionHandler for this thread.
Projection registration functions
template<typename PROJ>
const PROJ &	addProjection (const PROJ &proj, const std::string &name)
const Projection &	_addProjection (const Projection &proj, const std::string &name)
	Untemplated function to do the work...
Protected Attributes
bool	_allowProjReg
	Flag to forbid projection registration in analyses until the init phase.
Private Attributes
Particle	_incoming
	The incoming lepton.
Particle	_outgoing
	The outgoing lepton.
double	_sign
	The sign of the PZ of the incoming lepton.
Friends
class	Event
	Event is a friend.
class	Cmp< Projection >
	The Cmp specialization for Projection is a friend.
class	Projectionhandler

---

Constructor & Destructor Documentation

DISLepton

(

)

[inline]

Definition at line 22 of file DISLepton.hh.

References ProjectionApplier::addProjection(), and Projection::setName().

Referenced by DISLepton::clone().

               {
      setName("DISLepton");
      addProjection(Beam(), "Beam");
      addProjection(FinalState(), "FS");
    }

---

Member Function Documentation

virtual const Projection* clone

(

)

const [inline, virtual]

Clone on the heap.

Implements Projection.

Definition at line 29 of file DISLepton.hh.

References DISLepton::DISLepton().

                                            {
      return new DISLepton(*this);
    }

void project

(

const Event &

e

)

[protected, virtual]

Perform the projection operation on the supplied event.

Implements Projection.

Definition at line 17 of file DISLepton.cc.

References DISLepton::_incoming, DISLepton::_outgoing, DISLepton::_sign, Rivet::beams(), Particle::hasGenParticle(), Rivet::PID::isLepton(), Particle::momentum(), FinalState::particles(), Particle::pdgId(), and FourMomentum::pz().

                                        {
    const ParticlePair& inc = applyProjection<Beam>(e, "Beam").beams();
 
    Particle inLepton;
 
    bool firstIsLepton = PID::isLepton(inc.first.pdgId());
    bool secondIsLepton = PID::isLepton(inc.second.pdgId());
 
    if(firstIsLepton && !secondIsLepton){
      _incoming = inc.first;
    }else if(!firstIsLepton && secondIsLepton){
      _incoming = inc.second;
    }else{
      //eek!
      throw Error("DISLepton projector could not find the correct beam. ");
    }
 
    _sign = (_incoming.momentum().pz() > 0.0)? 1.0: -1.0;
    long id = _incoming.pdgId();
 
    double pzMax = -1000000000.0;
 
    const FinalState& fs = applyProjection<FinalState>(e, "FS");
    foreach (const Particle& p, fs.particles()) {
      double pz = _sign * p.momentum().pz();
      if(p.pdgId() == id && pz > pzMax){
        _outgoing = p;
        pzMax = pz;
      }
    }
 
    if (!_outgoing.hasGenParticle()) {
      throw Error("DISLepton projector could not find the scattered lepton.");
    }
  }

int compare

(

const Projection &

p

)

const [protected, virtual]

Compare with other projections.

Implements Projection.

Definition at line 9 of file DISLepton.cc.

References Projection::mkNamedPCmp().

                                                  {
    const DISLepton& other = pcast<DISLepton>(p);
    return
      mkNamedPCmp(other, "Beam") ||
      mkNamedPCmp(other, "FS");
  }

const Particle& in

(

)

const [inline]

The incoming lepton.

Definition at line 46 of file DISLepton.hh.

References DISLepton::_incoming.

Referenced by DISKinematics::project().

{ return _incoming; }

const Particle& out

(

)

const [inline]

The outgoing lepton.

Definition at line 49 of file DISLepton.hh.

References DISLepton::_outgoing.

Referenced by FinalStateHCM::project(), and DISKinematics::project().

{ return _outgoing; }

const double& pzSign

(

)

const [inline]

Definition at line 51 of file DISLepton.hh.

References DISLepton::_sign.

{ return _sign; }

bool before

(

const Projection &

p

)

const [inherited]

Determine whether this object should be ordered before the object p given as argument. If p is of a different class than this, the before() function of the corresponding type_info objects is used. Otherwise, if the objects are of the same class, the virtual compare(const Projection &) will be returned.

Definition at line 28 of file Projection.cc.

References Projection::compare().

Referenced by less< const Rivet::Projection * >::operator()().

                                                   {
    const std::type_info& thisid = typeid(*this);
    const std::type_info& otherid = typeid(p);
    if (thisid == otherid) {
      return compare(p) < 0;
    } else {
      return thisid.before(otherid);
    }
  }

const set< BeamPair > beamPairs

(

)

const [virtual, inherited]

Return the BeamConstraints for this projection, not including recursion. Derived classes should ensure that all contained projections are registered in the _projections set for the beam constraint chaining to work.

Definition at line 39 of file Projection.cc.

References Projection::_beamPairs, Projection::beamPairs(), Projection::getLog(), ProjectionApplier::getProjections(), Rivet::intersection(), and Log::TRACE.

Referenced by Projection::beamPairs().

                                                  {
    set<BeamPair> ret = _beamPairs;
    set<ConstProjectionPtr> projs = getProjections();
    for (set<ConstProjectionPtr>::const_iterator ip = projs.begin(); ip != projs.end(); ++ip) {
      ConstProjectionPtr p = *ip;
      getLog() << Log::TRACE << "Proj addr = " << p << endl;
      if (p) ret = intersection(ret, p->beamPairs());
    }
    return ret;
  }

virtual std::string name

(

)

const [inline, virtual, inherited]

Get the name of the projection.

Implements ProjectionApplier.

Definition at line 99 of file Projection.hh.

References Projection::_name.

Referenced by ProjectionApplier::_addProjection(), ProjectionHandler::_checkDuplicate(), ProjectionHandler::_getEquiv(), VetoedFinalState::addVetoOnThisFinalState(), Projection::getLog(), ZFinder::project(), ClusteredPhotons::project(), Projection::Projection(), ProjectionHandler::registerProjection(), and Projection::~Projection().

                                   {
      return _name;
    }

Projection& addBeamPair	(	const ParticleName &	beam1,
		const ParticleName &	beam2
	)			[inline, inherited]

Add a colliding beam pair.

Definition at line 105 of file Projection.hh.

References Projection::_beamPairs.

Referenced by Projection::Projection().

                                                                                  {
      _beamPairs.insert(BeamPair(beam1, beam2));
      return *this;
    }

Log& getLog

(

)

const [inline, inherited]

Get a Log object based on the getName() property of the calling projection object.

Reimplemented from ProjectionApplier.

Definition at line 112 of file Projection.hh.

References Log::getLog(), and Projection::name().

Referenced by Sphericity::_calcSphericity(), Thrust::_calcThrust(), Projection::beamPairs(), FastJets::calc(), FastJets::FastJets(), FinalState::FinalState(), JetAlg::JetAlg(), ZFinder::project(), WFinder::project(), VetoedFinalState::project(), UnstableFinalState::project(), TriggerUA5::project(), TriggerCDFRun0Run1::project(), PVertex::project(), NeutralFinalState::project(), MergedFinalState::project(), LossyFinalState::project(), LeadingParticlesFinalState::project(), IsolationProjection::project(), InvMassFinalState::project(), InitialQuarks::project(), Hemispheres::project(), HadronicFinalState::project(), FoxWolframMoments::project(), FinalState::project(), ClusteredPhotons::project(), ChargedFinalState::project(), Beam::project(), Projection::Projection(), FastJets::splitJet(), Beam::sqrtS(), and Projection::~Projection().

                        {
      string logname = "Rivet.Projection." + name();
      return Log::getLog(logname);
    }

void setName

(

const std::string &

name

)

[inline, inherited]

Used by derived classes to set their name.

Definition at line 118 of file Projection.hh.

References Projection::_name.

Referenced by ZFinder::_init(), WFinder::_init(), Beam::Beam(), CentralEtHCM::CentralEtHCM(), ChargedFinalState::ChargedFinalState(), ChargedLeptons::ChargedLeptons(), ClusteredPhotons::ClusteredPhotons(), DISKinematics::DISKinematics(), DISLepton::DISLepton(), FastJets::FastJets(), FinalState::FinalState(), FinalStateHCM::FinalStateHCM(), FoxWolframMoments::FoxWolframMoments(), HadronicFinalState::HadronicFinalState(), Hemispheres::Hemispheres(), IdentifiedFinalState::IdentifiedFinalState(), InitialQuarks::InitialQuarks(), IsolationProjection::IsolationProjection(), JetAlg::JetAlg(), JetShape::JetShape(), KtJets::KtJets(), LeadingParticlesFinalState::LeadingParticlesFinalState(), LossyFinalState::LossyFinalState(), MergedFinalState::MergedFinalState(), Multiplicity::Multiplicity(), NeutralFinalState::NeutralFinalState(), ParisiTensor::ParisiTensor(), PVertex::PVertex(), Sphericity::Sphericity(), SVertex::SVertex(), Thrust::Thrust(), TotalVisibleMomentum::TotalVisibleMomentum(), TriggerCDFRun0Run1::TriggerCDFRun0Run1(), TriggerUA5::TriggerUA5(), UnstableFinalState::UnstableFinalState(), and VetoedFinalState::VetoedFinalState().

                                        {
      _name = name;
    }

Cmp<Projection> mkNamedPCmp	(	const Projection &	otherparent,
		const std::string &	pname
	)			const [protected, inherited]

Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.

Referenced by ZFinder::compare(), WFinder::compare(), VetoedFinalState::compare(), TotalVisibleMomentum::compare(), Thrust::compare(), SVertex::compare(), Sphericity::compare(), ParisiTensor::compare(), NeutralFinalState::compare(), Multiplicity::compare(), MergedFinalState::compare(), LossyFinalState::compare(), LeadingParticlesFinalState::compare(), KtJets::compare(), JetShape::compare(), IsolationProjection::compare(), InvMassFinalState::compare(), IdentifiedFinalState::compare(), Hemispheres::compare(), FoxWolframMoments::compare(), FinalStateHCM::compare(), FastJets::compare(), DISLepton::compare(), DISKinematics::compare(), ClusteredPhotons::compare(), ChargedLeptons::compare(), ChargedFinalState::compare(), and CentralEtHCM::compare().

Cmp<Projection> mkPCmp	(	const Projection &	otherparent,
		const std::string &	pname
	)			const [protected, inherited]

Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.

std::set<ConstProjectionPtr> getProjections

(

)

const [inline, inherited]

Get the contained projections, including recursion.

Definition at line 43 of file ProjectionApplier.hh.

References ProjectionHandler::DEEP, ProjectionHandler::getChildProjections(), and ProjectionApplier::getProjHandler().

Referenced by Projection::beamPairs().

                                                      {
      return getProjHandler().getChildProjections(*this, ProjectionHandler::DEEP);
    }

const PROJ& getProjection

(

const std::string &

name

)

const [inline, inherited]

Get the named projection, specifying return type via a template argument.

Definition at line 50 of file ProjectionApplier.hh.

References ProjectionHandler::getProjection(), and ProjectionApplier::getProjHandler().

Referenced by VetoedFinalState::compare(), Rivet::pcmp(), and Hemispheres::project().

                                                           {
      const Projection& p = getProjHandler().getProjection(*this, name);
      return pcast<PROJ>(p);
    }

const Projection& getProjection

(

const std::string &

name

)

const [inline, inherited]

Get the named projection (non-templated, so returns as a reference to a Projection base class).

Definition at line 58 of file ProjectionApplier.hh.

References ProjectionHandler::getProjection(), and ProjectionApplier::getProjHandler().

                                                                 {
      return getProjHandler().getProjection(*this, name);
    }

const PROJ& applyProjection	(	const Event &	evt,
		const PROJ &	proj
	)			const [inline, inherited]

Apply the supplied projection on event.

Definition at line 68 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

Referenced by HadronicFinalState::project(), and FinalStateHCM::project().

                                                                          {
      return pcast<PROJ>(_applyProjection(evt, proj));
    }

const PROJ& applyProjection	(	const Event &	evt,
		const Projection &	proj
	)			const [inline, inherited]

Apply the supplied projection on event.

Definition at line 75 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

                                                                                {
      return pcast<PROJ>(_applyProjection(evt, proj));
    }

const PROJ& applyProjection	(	const Event &	evt,
		const std::string &	name
	)			const [inline, inherited]

Apply the named projection on event.

Definition at line 82 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

                                                                               {
      return pcast<PROJ>(_applyProjection(evt, name));
    }

ProjectionHandler& getProjHandler

(

)

const [inline, protected, inherited]

Get a reference to the ProjectionHandler for this thread.

Definition at line 95 of file ProjectionApplier.hh.

References ProjectionApplier::_projhandler.

Referenced by ProjectionApplier::_addProjection(), ProjectionApplier::getProjection(), ProjectionApplier::getProjections(), and ProjectionApplier::~ProjectionApplier().

                                              {
      assert(_projhandler);
      return *_projhandler;
    }

const PROJ& addProjection	(	const PROJ &	proj,
		const std::string &	name
	)			[inline, protected, inherited]

Register a contained projection. The type of the argument is used to instantiate a new projection internally: this new object is applied to events rather than the argument object. Hence you are advised to only use locally-scoped Projection objects in your Projection and Analysis constructors, and to avoid polymorphism (e.g. handling ConcreteProjection via a pointer or reference to type Projection) since this will screw up the internal type management.

Definition at line 115 of file ProjectionApplier.hh.

References ProjectionApplier::_addProjection().

Referenced by ZFinder::_init(), WFinder::_init(), VetoedFinalState::addVetoOnThisFinalState(), CDF_2009_S8057893::CDF_2009_S8057893::init(), CentralEtHCM::CentralEtHCM(), ChargedFinalState::ChargedFinalState(), ChargedLeptons::ChargedLeptons(), ClusteredPhotons::ClusteredPhotons(), DISKinematics::DISKinematics(), DISLepton::DISLepton(), FinalState::FinalState(), FinalStateHCM::FinalStateHCM(), FoxWolframMoments::FoxWolframMoments(), HadronicFinalState::HadronicFinalState(), Hemispheres::Hemispheres(), IdentifiedFinalState::IdentifiedFinalState(), ZEUS_2001_S4815815::init(), UA5_1989_S1926373::init(), UA5_1988_S1867512::init(), UA5_1986_S1583476::init(), UA5_1982_S875503::init(), UA1_1990_S2044935::init(), STAR_2009_UE_HELEN::init(), STAR_2008_S7993412::init(), STAR_2006_S6870392::init(), STAR_2006_S6860818::init(), STAR_2006_S6500200::init(), SFM_1984_S1178091::init(), PDG_HADRON_MULTIPLICITIES_RATIOS::init(), PDG_HADRON_MULTIPLICITIES::init(), OPAL_2004_S6132243::init(), OPAL_1998_S3780481::init(), MC_ZJETS::init(), MC_WJETS::init(), MC_TTBAR::init(), MC_SUSY::init(), MC_PHOTONJETUE::init(), MC_PHOTONJETS::init(), MC_LEADINGJETS::init(), MC_JETS::init(), MC_DIPHOTON::init(), MC_DIJET::init(), JADE_OPAL_2000_S4300807::init(), H1_2000_S4129130::init(), H1_1995_S3167097::init(), H1_1994_S2919893::init(), ExampleAnalysis::init(), E735_1998_S3905616::init(), DELPHI_2002_069_CONF_603::init(), DELPHI_1995_S3137023::init(), D0_2010_S8570965::init(), D0_2010_S8566488::init(), D0_2009_S8349509::init(), D0_2009_S8320160::init(), D0_2009_S8202443::init(), D0_2008_S7863608::init(), D0_2008_S7837160::init(), D0_2008_S7719523::init(), D0_2008_S7662670::init(), D0_2008_S7554427::init(), D0_2008_S6879055::init(), D0_2007_S7075677::init(), D0_2006_S6438750::init(), D0_2004_S5992206::init(), D0_2001_S4674421::init(), D0_1998_S3711838::init(), D0_1996_S3324664::init(), D0_1996_S3214044::init(), CDF_2009_S8436959::init(), CDF_2009_S8383952::init(), CDF_2009_S8233977::init(), CDF_2008_S8095620::init(), CDF_2008_S8093652::init(), CDF_2008_S7828950::init(), CDF_2008_S7782535::init(), CDF_2008_S7541902::init(), CDF_2008_S7540469::init(), CDF_2008_NOTE_9351::init(), CDF_2008_LEADINGJETS::init(), CDF_2007_S7057202::init(), CDF_2006_S6653332::init(), CDF_2006_S6450792::init(), CDF_2005_S6217184::init(), CDF_2005_S6080774::init(), CDF_2004_S5839831::init(), CDF_2002_S4796047::init(), CDF_2001_S4751469::init(), CDF_2001_S4563131::init(), CDF_2001_S4517016::init(), CDF_2000_S4266730::init(), CDF_2000_S4155203::init(), CDF_1998_S3618439::init(), CDF_1997_S3541940::init(), CDF_1996_S3418421::init(), CDF_1996_S3349578::init(), CDF_1996_S3108457::init(), CDF_1994_S2952106::init(), CDF_1991_S2313472::init(), CDF_1990_S2089246::init(), CDF_1988_S1865951::init(), BELLE_2006_S6265367::init(), ATLAS_2010_S8591806::init(), ALEPH_2004_S5765862::init(), ALEPH_1996_S3486095::init(), ALEPH_1996_S3196992::init(), ALEPH_1991_S2435284::init(), IsolationProjection::IsolationProjection(), JetAlg::JetAlg(), JetShape::JetShape(), KtJets::KtJets(), LeadingParticlesFinalState::LeadingParticlesFinalState(), LossyFinalState::LossyFinalState(), MergedFinalState::MergedFinalState(), Multiplicity::Multiplicity(), NeutralFinalState::NeutralFinalState(), ParisiTensor::ParisiTensor(), Sphericity::Sphericity(), SVertex::SVertex(), Thrust::Thrust(), TotalVisibleMomentum::TotalVisibleMomentum(), TriggerCDFRun0Run1::TriggerCDFRun0Run1(), TriggerUA5::TriggerUA5(), and VetoedFinalState::VetoedFinalState().

                                                                       {
      const Projection& reg = _addProjection(proj, name);
      return dynamic_cast<const PROJ&>(reg);
    }

const Projection & _addProjection	(	const Projection &	proj,
		const std::string &	name
	)			[protected, inherited]

Untemplated function to do the work...

Definition at line 33 of file ProjectionApplier.cc.

References ProjectionApplier::_allowProjReg, Log::ERROR, ProjectionApplier::getLog(), ProjectionApplier::getProjHandler(), ProjectionApplier::name(), Projection::name(), and ProjectionHandler::registerProjection().

Referenced by ProjectionApplier::addProjection().

                                                                             {
    if (!_allowProjReg) {
      getLog() << Log::ERROR << "Trying to register projection '"
               << proj.name() << "' before init phase in '" << this->name() << "'." << endl;
      exit(2);
    }
    const Projection& reg = getProjHandler().registerProjection(*this, proj, name);
    return reg;
  }

---

Friends And Related Function Documentation

friend class Event [friend, inherited]

Event is a friend.

Definition at line 31 of file Projection.hh.

friend class Cmp< Projection > [friend, inherited]

The Cmp specialization for Projection is a friend.

Definition at line 34 of file Projection.hh.

friend class Projectionhandler [friend, inherited]

Definition at line 23 of file ProjectionApplier.hh.

---

Member Data Documentation

Particle _incoming [private]

The incoming lepton.

Definition at line 56 of file DISLepton.hh.

Referenced by DISLepton::in(), and DISLepton::project().

Particle _outgoing [private]

The outgoing lepton.

Definition at line 59 of file DISLepton.hh.

Referenced by DISLepton::out(), and DISLepton::project().

double _sign [private]

The sign of the PZ of the incoming lepton.

Definition at line 62 of file DISLepton.hh.

Referenced by DISLepton::project(), and DISLepton::pzSign().

bool _allowProjReg [protected, inherited]

Flag to forbid projection registration in analyses until the init phase.

Definition at line 141 of file ProjectionApplier.hh.

Referenced by ProjectionApplier::_addProjection(), and AnalysisHandler::init().

---

The documentation for this class was generated from the following files:

• DISLepton.hh
• DISLepton.cc