FS modifier to exclude classes of particles from the final state. More...

#include <VetoedFinalState.hh>

Public Types
typedef pair< double, double >	BinaryCut
	Typedef for a pair of back-to-back cuts.
typedef map< long, BinaryCut >	VetoDetails
	Typedef for a vetoing entry.
typedef multimap< int, BinaryCut >	CompositeVeto
	Typedef for a veto on a composite particle mass.
Public Member Functions
const VetoDetails &	vetoDetails () const
	Get the list of particle IDs and ranges to veto.
VetoedFinalState &	addVetoDetail (const long id, const double ptmin, const double ptmax)
VetoedFinalState &	addVetoPairDetail (const long id, const double ptmin, const double ptmax)
VetoedFinalState &	addVetoPairId (const long id)
VetoedFinalState &	addVetoId (const long id)
	Add a particle ID to veto (all range will be vetoed).
VetoedFinalState &	vetoNeutrinos ()
	Veto all neutrinos (convenience method)
VetoedFinalState &	addCompositeMassVeto (const double &mass, const double &width, int nProducts=2)
VetoedFinalState &	addDecayProductsVeto (const long id)
VetoedFinalState &	setVetoDetails (const VetoDetails &ids)
	Set the list of particle IDs and ranges to veto.
VetoedFinalState &	reset ()
	Clear the list of particle IDs and ranges to veto.
VetoedFinalState &	addVetoOnThisFinalState (const FinalState &fs)
	Veto particles from a supplied final state.
virtual bool	accept (const Particle &p) const
	Decide if a particle is to be accepted or not.
bool	before (const Projection &p) const
virtual const std::set< PdgIdPair >	beamPairs () const
virtual std::string	name () const
	Get the name of the projection.
Projection &	addPdgIdPair (PdgId beam1, PdgId 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.
void	markAsOwned () const
Constructors
	VetoedFinalState ()
	Default constructor.
	VetoedFinalState (const FinalState &fsp)
	Constructor with specific FinalState.
	VetoedFinalState (const VetoDetails &vetocodes)
	VetoedFinalState (const FinalState &fsp, const VetoDetails &vetocodes)
	DEFAULT_RIVET_PROJ_CLONE (VetoedFinalState)
	Clone on the heap.
Standard constructors etc.
	DEFAULT_RIVET_PROJ_CLONE (FinalState)
	Clone on the heap.
Object lifetime management
virtual unique_ptr< Projection >	clone () const =0
	Clone on the heap.
Particle accessors
virtual const Particles &	particles () const
	Get the final-state particles in no particular order, with no cuts.
Particles	particles (const Cut &c) const
	Get the final-state particles, with optional cuts.
template<typename F >
Particles	particles (F sorter, const Cut &c=Cuts::open()) const
template<typename F >
Particles	particles (const Cut &c, F sorter) const
size_t	size () const
	Access the projected final-state particles.
bool	empty () const
	Is this final state empty?
bool	isEmpty () const
Particles	particlesByPt (const Cut &c=Cuts::open()) const
Particles	particlesByPt (double ptmin) const
Little-used sorted accessors
Deprecated: Use the versions with a sorter function argument
Particles	particlesByP (const Cut &c=Cuts::open()) const
Particles	particlesByE (const Cut &c=Cuts::open()) const
Particles	particlesByEt (const Cut &c=Cuts::open()) const
Particles	particlesByEta (const Cut &c=Cuts::open()) const
Particles	particlesByModEta (const Cut &c=Cuts::open()) const
Particles	particlesByRapidity (const Cut &c=Cuts::open()) const
Particles	particlesByModRapidity (const Cut &c=Cuts::open()) const
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
const Projection &	getProjection (const std::string &name) const
template<typename PROJ >
const PROJ &	get (const std::string &name) const
Projection applying functions
template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const Projection &proj) const
	Apply the supplied projection on event evt.
template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const PROJ &proj) const
	Apply the supplied projection on event evt.
template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const std::string &name) const
template<typename PROJ >
const PROJ &	apply (const Event &evt, const Projection &proj) const
template<typename PROJ >
const PROJ &	apply (const Event &evt, const PROJ &proj) const
template<typename PROJ >
const PROJ &	apply (const Event &evt, const std::string &name) const
Protected Member Functions
void	project (const Event &e)
	Apply the projection on the supplied event.
int	compare (const Projection &p) const
	Compare 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.
const Projection &	_applyProjection (const Event &evt, const std::string &name) const
const Projection &	_applyProjection (const Event &evt, const Projection &proj) const
Projection registration functions
template<typename PROJ >
const PROJ &	declareProjection (const PROJ &proj, const std::string &name)
	Register a contained projection.
template<typename PROJ >
const PROJ &	declare (const PROJ &proj, const std::string &name)
	Register a contained projection (user-facing version)
template<typename PROJ >
const PROJ &	addProjection (const PROJ &proj, const std::string &name)
	Register a contained projection (user-facing version)
const Projection &	_declareProjection (const Projection &proj, const std::string &name)
	Untemplated function to do the work...
Protected Attributes
Cut	_cuts
	The kinematic cuts cuts.
Particles	_theParticles
	The found particles returned by the particles() methods.
bool	_allowProjReg
	Flag to forbid projection registration in analyses until the init phase.
Private Types
typedef set< long >	ParentVetos
Private Attributes
VetoDetails	_vetoCodes
	The final-state particles.
CompositeVeto	_compositeVetoes
	Composite particle masses to veto.
set< int >	_nCompositeDecays
ParentVetos	_parentVetoes
	Set of decaying particle IDs to veto.
set< string >	_vetofsnames
	Set of finalstate to be vetoed.
Friends
class	Event
	Event is a friend.
class	Cmp< Projection >
	The Cmp specialization for Projection is a friend.
For JetAlg compatibility
Todo: Replace with cuts() accessor virtual Cut cuts() const { return _cuts; }
typedef Particle	entity_type
typedef Particles	collection_type
const collection_type &	entities () const
	Template-usable interface common to JetAlg.

Detailed Description

FS modifier to exclude classes of particles from the final state.

Definition at line 11 of file VetoedFinalState.hh.

Member Typedef Documentation

typedef pair<double, double> BinaryCut

Typedef for a pair of back-to-back cuts.

Definition at line 16 of file VetoedFinalState.hh.

typedef Particles collection_type [inherited]

Definition at line 173 of file ParticleFinder.hh.

typedef multimap<int, BinaryCut> CompositeVeto

Typedef for a veto on a composite particle mass.

Definition at line 22 of file VetoedFinalState.hh.

typedef Particle entity_type [inherited]

Definition at line 172 of file ParticleFinder.hh.

typedef set<long> ParentVetos [private]

Definition at line 171 of file VetoedFinalState.hh.

typedef map<long, BinaryCut> VetoDetails

Typedef for a vetoing entry.

Definition at line 19 of file VetoedFinalState.hh.

Constructor & Destructor Documentation

VetoedFinalState ( ) [inline]

Default constructor.

Definition at line 28 of file VetoedFinalState.hh.

                       {
      setName("VetoedFinalState");
      addProjection(FinalState(), "FS");
    }

VetoedFinalState ( const FinalState & fsp ) [inline]

Constructor with specific FinalState.

Definition at line 34 of file VetoedFinalState.hh.

    {
      setName("VetoedFinalState");
      addProjection(fsp, "FS");
    }

VetoedFinalState ( const VetoDetails & vetocodes ) [inline]

You can add a map of ID plus a pair containing $p_{Tmin}$ and $p_{Tmax}$ - these define the range of particles to be vetoed.

Definition at line 42 of file VetoedFinalState.hh.

      : _vetoCodes(vetocodes)
    {
      setName("VetoedFinalState");
      addProjection(FinalState(), "FS");
    }

VetoedFinalState	(	const FinalState &	fsp,
		const VetoDetails &	vetocodes
	)		`[inline]`

You can add a map of ID plus a pair containing $p_{Tmin}$ and $p_{Tmax}$ - these define the range of particles to be vetoed. This version also supplies a specifi FinalState to be used.

Definition at line 52 of file VetoedFinalState.hh.

      : _vetoCodes(vetocodes)
    {
      setName("VetoedFinalState");
      addProjection(fsp, "FS");
    }

Member Function Documentation

const Projection & _applyProjection	(	const Event &	evt,
		const std::string &	name
	)		const `[protected, inherited]`

Non-templated version of string-based applyProjection, to work around header dependency issue.

Definition at line 22 of file ProjectionApplier.cc.

                                                                                  {
    return evt.applyProjection(getProjection(name));
  }

const Projection & _applyProjection	(	const Event &	evt,
		const Projection &	proj
	)		const `[protected, inherited]`

Non-templated version of proj-based applyProjection, to work around header dependency issue.

Definition at line 28 of file ProjectionApplier.cc.

                                                                                      {
    return evt.applyProjection(proj);
  }

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

Untemplated function to do the work...

Definition at line 34 of file ProjectionApplier.cc.

                                                                             {
    if (!_allowProjReg) {
      cerr << "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;
  }

bool accept ( const Particle & p ) const [virtual, inherited]

Decide if a particle is to be accepted or not.

Todo:: Rename to _accept or acceptFinal?

Reimplemented in FinalPartons.

Definition at line 75 of file FinalState.cc.

                                                 {
    // Not having status == 1 should never happen!
    assert(p.genParticle() == NULL || p.genParticle()->status() == 1);
    return _cuts->accept(p);
  }

VetoedFinalState& addCompositeMassVeto	(	const double &	mass,
		const double &	width,
		int	nProducts = `2`
	)		`[inline]`

Add a veto on composite masses within a given width. The composite mass is composed of nProducts decay products @ todo might we want to specify a range of pdg ids for the decay products?

Definition at line 115 of file VetoedFinalState.hh.

                                                                                                    {
      double halfWidth = 0.5*width;
      BinaryCut massRange(mass - halfWidth, mass + halfWidth);
      _compositeVetoes.insert(make_pair(nProducts, massRange));
      _nCompositeDecays.insert(nProducts);
      return *this;
    }

VetoedFinalState& addDecayProductsVeto ( const long id ) [inline]

Veto the decay products of particle with pdg id

Todo:: Need HepMC to sort themselves out and keep vector bosons from the hard vtx in the event record before this will work reliably for all pdg ids

Definition at line 126 of file VetoedFinalState.hh.

                                                         {
      _parentVetoes.insert(id);
      return *this;
    }

Projection& addPdgIdPair	(	PdgId	beam1,
		PdgId	beam2
	)		`[inline, inherited]`

Add a colliding beam pair.

Definition at line 108 of file Projection.hh.

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

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

Register a contained projection (user-facing version)

Deprecated:: Use declareProjection() or declare()

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 157 of file ProjectionApplier.hh.

{ return declareProjection(proj, name); }

VetoedFinalState& addVetoDetail	(	const long	id,
		const double	ptmin,
		const double	ptmax
	)		`[inline]`

Add a particle ID and $ p_T $ range to veto. Particles with $ p_T $ IN the given range will be rejected.

Definition at line 75 of file VetoedFinalState.hh.

                                                                                           {
      BinaryCut ptrange(ptmin, ptmax);
      _vetoCodes.insert(make_pair(id, ptrange));
      return *this;
    }

VetoedFinalState& addVetoId ( const long id ) [inline]

Add a particle ID to veto (all $ p_T $ range will be vetoed).

Definition at line 98 of file VetoedFinalState.hh.

                                               {
      BinaryCut ptrange(0.0, numeric_limits<double>::max());
      _vetoCodes.insert(make_pair(id, ptrange));
      return *this;
    }

VetoedFinalState& addVetoOnThisFinalState ( const FinalState & fs ) [inline]

Veto particles from a supplied final state.

Definition at line 145 of file VetoedFinalState.hh.

                                                                    {
      const string name = "FS_" + to_str(_vetofsnames.size());
      addProjection(fs, name);
      _vetofsnames.insert(name);
      return *this;
    }

VetoedFinalState& addVetoPairDetail	(	const long	id,
		const double	ptmin,
		const double	ptmax
	)		`[inline]`

Add a particle/antiparticle pair to veto in a given $ p_T $ range. Given a single ID, both the particle and its conjugate antiparticle will be rejected if their $ p_T $ is IN the given range.

Definition at line 83 of file VetoedFinalState.hh.

                                                                                               {
      addVetoDetail(id,  ptmin, ptmax);
      addVetoDetail(-id, ptmin, ptmax);
      return *this;
    }

VetoedFinalState& addVetoPairId ( const long id ) [inline]

Add a particle/antiparticle pair to veto. Given a single ID, both the particle and its corresponding antiparticle (for all $ p_T $ values) will be vetoed.

Definition at line 91 of file VetoedFinalState.hh.

                                                   {
      addVetoId(id);
      addVetoId(-id);
      return *this;
    }

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

Apply the supplied projection on event evt (user-facing alias).

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 80 of file ProjectionApplier.hh.

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

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

Apply the supplied projection on event evt (user-facing alias).

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 92 of file ProjectionApplier.hh.

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

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

Apply the supplied projection on event evt (user-facing alias).

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 104 of file ProjectionApplier.hh.

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

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

Apply the supplied projection on event evt.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 74 of file ProjectionApplier.hh.

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

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

Apply the supplied projection on event evt.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 86 of file ProjectionApplier.hh.

                                                                          {
      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 evt.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 98 of file ProjectionApplier.hh.

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

const set< PdgIdPair > beamPairs ( ) const [virtual, inherited]

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

Todo:: Remove the beam constraints system from projections.

Definition at line 35 of file Projection.cc.

                                                   {
    set<PdgIdPair> 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;
  }

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 24 of file Projection.cc.

                                                   {
    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);
    }
  }

virtual unique_ptr<Projection> clone ( ) const [pure virtual, inherited]

Clone on the heap.

Implements Projection.

int compare ( const Projection & p ) const [protected, virtual]

Compare projections.

Todo:: We can do better than this...

Reimplemented from FinalState.

Definition at line 7 of file VetoedFinalState.cc.

                                                         {
    const PCmp fscmp = mkNamedPCmp(p, "FS");
    if (fscmp != EQUIVALENT) return fscmp;
    /// @todo We can do better than this...
    if (_vetofsnames.size() != 0) return UNDEFINED;
    const VetoedFinalState& other = dynamic_cast<const VetoedFinalState&>(p);
    return \
      cmp(_vetoCodes, other._vetoCodes) ||
      cmp(_compositeVetoes, other._compositeVetoes) ||
      cmp(_parentVetoes, other._parentVetoes);
  }

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

Register a contained projection (user-facing version)

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 151 of file ProjectionApplier.hh.

{ return declareProjection(proj, name); }

const PROJ& declareProjection	(	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.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 142 of file ProjectionApplier.hh.

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

DEFAULT_RIVET_PROJ_CLONE ( FinalState ) [inherited]

Clone on the heap.

DEFAULT_RIVET_PROJ_CLONE ( VetoedFinalState )

Clone on the heap.

bool empty ( ) const [inline, inherited]

Is this final state empty?

Definition at line 41 of file ParticleFinder.hh.

{ return particles().empty(); }

const collection_type& entities ( ) const [inline, inherited]

Template-usable interface common to JetAlg.

Definition at line 176 of file ParticleFinder.hh.

                                            {
      return particles();
    }

const PROJ& get ( const std::string & name ) const [inline, inherited]

Get the named projection, specifying return type via a template argument (user-facing alias).

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 57 of file ProjectionApplier.hh.

{ return getProjection<PROJ>(name); }

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 115 of file Projection.hh.

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

const PROJ& getProjection ( const std::string & name ) const [inline, inherited]

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

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 50 of file ProjectionApplier.hh.

                                                           {
      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 61 of file ProjectionApplier.hh.

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

std::set<ConstProjectionPtr> getProjections ( ) const [inline, inherited]

Get the contained projections, including recursion.

Definition at line 43 of file ProjectionApplier.hh.

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

ProjectionHandler& getProjHandler ( ) const [inline, protected, inherited]

Get a reference to the ProjectionHandler for this thread.

Definition at line 122 of file ProjectionApplier.hh.

                                              {
      return _projhandler;
    }

bool isEmpty ( ) const [inline, inherited]

Deprecated:: Is this final state empty?

Definition at line 44 of file ParticleFinder.hh.

{ return particles().empty(); }

void markAsOwned ( ) const [inline, inherited]

Mark object as owned by the _projhandler

Todo:: Huh? What's this for?

Definition at line 111 of file ProjectionApplier.hh.

{ _owned = true; }

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.

Definition at line 47 of file Projection.cc.

                                                                                                  {
    return pcmp(*this, otherparent, pname);
  }

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.

Note:: Alias for mkNamedPCmp

Definition at line 51 of file Projection.cc.

                                                                                             {
    return pcmp(*this, otherparent, pname);
  }

virtual std::string name ( ) const [inline, virtual, inherited]

Get the name of the projection.

Implements ProjectionApplier.

Definition at line 102 of file Projection.hh.

                                   {
      return _name;
    }

virtual const Particles& particles ( ) const [inline, virtual, inherited]

Get the final-state particles in no particular order, with no cuts.

Definition at line 35 of file ParticleFinder.hh.

{ return _theParticles; }

Particles particles ( const Cut & c ) const [inline, inherited]

Get the final-state particles, with optional cuts.

Note:: Returns a copy rather than a reference, due to cuts

Todo:: Can't this be a const Cut& arg?

Definition at line 50 of file ParticleFinder.hh.

                                            {
      // Just return a copy of particles() if the cut is open
      if (c == Cuts::open()) return particles();
      // If there is a non-trivial cut...
      Particles rtn;
      rtn.reserve(size());
      foreach (const Particle& p, particles())
        if (c->accept(p)) rtn.push_back(p);
      return rtn;
    }

Particles particles	(	F	sorter,
		const Cut &	c = `Cuts::open()`
	)		const `[inline, inherited]`

Todo:

Want to add a general filtering function, but that clashes with the sorting functor... SFINAE?

Use a std::function instead of typename F?

Get the final-state particles, ordered by supplied sorting function object.

Note:: Returns a copy rather than a reference, due to cuts and sorting

Todo:: Can't this be a const Cut& arg?

Todo:: Will the vector be efficiently std::move'd by value through this function chain?

Definition at line 70 of file ParticleFinder.hh.

                                                                 {
      /// @todo Will the vector be efficiently std::move'd by value through this function chain?
      return sortBy(particles(c), sorter);
    }

Particles particles	(	const Cut &	c,
		F	sorter
	)		const `[inline, inherited]`

Get the final-state particles, ordered by supplied sorting function object.

Note:: Returns a copy rather than a reference, due to cuts and sorting

Todo:

Can't this be a const Cut& arg?

Use a std::function instead of typename F?

Todo:: Will the vector be efficiently std::move'd by value through this function chain?

Definition at line 80 of file ParticleFinder.hh.

                                                      {
      /// @todo Will the vector be efficiently std::move'd by value through this function chain?
      return sortBy(particles(c), sorter);
    }

Particles particlesByE ( const Cut & c = Cuts::open() ) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ E $ .

Todo:: Remove, since there is the templated method or sortByX methods available for these unusual cases?

Deprecated:: Use the version with a sorter function argument

Definition at line 116 of file ParticleFinder.hh.

                                                           {
      return particles(c, cmpMomByE);
    }

Particles particlesByEt ( const Cut & c = Cuts::open() ) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ E_T $ .

Todo:: Remove, since there is the templated method or sortByX methods available for these unusual cases?

Deprecated:: Use the version with a sorter function argument

Definition at line 124 of file ParticleFinder.hh.

                                                            {
      return particles(c, cmpMomByEt);
    }

Particles particlesByEta ( const Cut & c = Cuts::open() ) const [inline, inherited]

Get the final-state particles, ordered by increasing $\eta$ .

Todo:: Remove, since there is the templated method or sortByX methods available for these unusual cases?

Deprecated:: Use the version with a sorter function argument

Definition at line 132 of file ParticleFinder.hh.

                                                             {
      return particles(c, cmpMomByEta);
    }

Particles particlesByModEta ( const Cut & c = Cuts::open() ) const [inline, inherited]

Get the final-state particles, ordered by increasing $|\eta|$ .

Todo:: Remove, since there is the templated method or sortByX methods available for these unusual cases?

Deprecated:: Use the version with a sorter function argument

Definition at line 140 of file ParticleFinder.hh.

                                                                {
      return particles(c, cmpMomByAbsEta);
    }

Particles particlesByModRapidity ( const Cut & c = Cuts::open() ) const [inline, inherited]

Get the final-state particles, ordered by increasing $ |y| $ .

Todo:: Remove, since there is the templated method or sortByX methods available for these unusual cases?

Deprecated:: Use the version with a sorter function argument

Definition at line 156 of file ParticleFinder.hh.

                                                                     {
      return particles(c, cmpMomByAbsRap);
    }

Particles particlesByP ( const Cut & c = Cuts::open() ) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ p $ .

Todo:: Remove, since there is the templated method or sortByX methods available for these unusual cases?

Deprecated:: Use the version with a sorter function argument

Definition at line 108 of file ParticleFinder.hh.

                                                           {
      return particles(c, cmpMomByP);
    }

Particles particlesByPt ( const Cut & c = Cuts::open() ) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ p_T $ and with optional cuts.

This is a very common use-case, so is available as syntatic sugar for particles(c, cmpMomByPt).

Definition at line 88 of file ParticleFinder.hh.

                                                           {
      return particles(c, cmpMomByPt);
    }

Particles particlesByPt ( double ptmin ) const [inline, inherited]

Get the final-state particles, ordered by decreasing $ p_T $ and with a cut on minimum $ p_T $ .

This is a very common use-case, so is available as syntatic sugar for particles(Cuts::pT >= ptmin, cmpMomByPt).

Definition at line 95 of file ParticleFinder.hh.

                                                {
      return particles(Cuts::pT >= ptmin, cmpMomByPt);
    }

Particles particlesByRapidity ( const Cut & c = Cuts::open() ) const [inline, inherited]

Get the final-state particles, ordered by increasing $ y $ .

Todo:: Remove, since there is the templated method or sortByX methods available for these unusual cases?

Deprecated:: Use the version with a sorter function argument

Definition at line 148 of file ParticleFinder.hh.

                                                                  {
      return particles(c, cmpMomByRap);
    }

void project ( const Event & e ) [protected, virtual]

Apply the projection on the supplied event.

Todo:: There must be a nice way to do this -- an STL algorithm (or we provide a nicer wrapper)

Todo:: Could use any() here?

Reimplemented from FinalState.

Definition at line 20 of file VetoedFinalState.cc.

                                               {
    const FinalState& fs = applyProjection<FinalState>(e, "FS");
    _theParticles.clear();
    _theParticles.reserve(fs.particles().size());
    foreach (const Particle& p, fs.particles()) {
      if (getLog().isActive(Log::TRACE)) {
        vector<long> codes;
        for (VetoDetails::const_iterator code = _vetoCodes.begin(); code != _vetoCodes.end(); ++code) {
          codes.push_back(code->first);
        }
        const string codestr = "{ " + join(codes) + " }";
        MSG_TRACE(p.pid() << " vs. veto codes = " << codestr << " (" << codes.size() << ")");
      }
      VetoDetails::iterator iter = _vetoCodes.find(p.pid());
      if (iter == _vetoCodes.end()) {
        MSG_TRACE("Storing with PDG code = " << p.pid() << ", pT = " << p.pT());
        _theParticles.push_back(p);
      } else {
        // This particle code is listed as a possible veto... check pT.
        // Make sure that the pT range is sensible:
        BinaryCut ptrange = iter->second;
        assert(ptrange.first <= ptrange.second);
        stringstream rangess;
        if (ptrange.first < numeric_limits<double>::max()) rangess << ptrange.second;
        rangess << " - ";
        if (ptrange.second < numeric_limits<double>::max()) rangess << ptrange.second;
        MSG_TRACE("ID = " << p.pid() << ", pT range = " << rangess.str());
        stringstream debugline;
        debugline << "with PDG code = " << p.pid() << " pT = " << p.pT();
        if (p.pT() < ptrange.first || p.pT() > ptrange.second) {
          MSG_TRACE("Storing " << debugline.str());
          _theParticles.push_back(p);
        } else {
          MSG_TRACE("Vetoing " << debugline.str());
        }
      }
    }

    set<Particles::iterator> toErase;
    for (set<int>::iterator nIt = _nCompositeDecays.begin();
         nIt != _nCompositeDecays.end() && !_theParticles.empty(); ++nIt) {
      map<set<Particles::iterator>, FourMomentum> oldMasses;
      map<set<Particles::iterator>, FourMomentum> newMasses;
      set<Particles::iterator> start;
      start.insert(_theParticles.begin());
      oldMasses.insert(pair<set<Particles::iterator>, FourMomentum>
                       (start, _theParticles.begin()->momentum()));

      for (int nParts = 1; nParts != *nIt; ++nParts) {
        for (map<set<Particles::iterator>, FourMomentum>::iterator mIt = oldMasses.begin();
             mIt != oldMasses.end(); ++mIt) {
          Particles::iterator pStart = *(mIt->first.rbegin());
          for (Particles::iterator pIt = pStart + 1; pIt != _theParticles.end(); ++pIt) {
            FourMomentum cMom = mIt->second + pIt->momentum();
            set<Particles::iterator> pList(mIt->first);
            pList.insert(pIt);
            newMasses[pList] = cMom;
          }
        }
        oldMasses = newMasses;
        newMasses.clear();
      }
      for (map<set<Particles::iterator>, FourMomentum>::iterator mIt = oldMasses.begin();
           mIt != oldMasses.end(); ++mIt) {
        double mass2 = mIt->second.mass2();
        if (mass2 >= 0.0) {
          double mass = sqrt(mass2);
          for (CompositeVeto::iterator cIt = _compositeVetoes.lower_bound(*nIt);
               cIt != _compositeVetoes.upper_bound(*nIt); ++cIt) {
            BinaryCut massRange = cIt->second;
            if (mass < massRange.second && mass > massRange.first) {
              for (set<Particles::iterator>::iterator lIt = mIt->first.begin();
                   lIt != mIt->first.end(); ++lIt) {
                toErase.insert(*lIt);
              }
            }
          }
        }
      }
    }

    for (set<Particles::iterator>::reverse_iterator p = toErase.rbegin(); p != toErase.rend(); ++p) {
      _theParticles.erase(*p);
    }

    // Remove particles whose parents match entries in the parent veto PDG ID codes list
    /// @todo There must be a nice way to do this -- an STL algorithm (or we provide a nicer wrapper)
    foreach (PdgId vetoid, _parentVetoes) {
      for (Particles::iterator ip = _theParticles.begin(); ip != _theParticles.end(); ++ip) {
        const GenVertex* startVtx = ip->genParticle()->production_vertex();
        if (startVtx == NULL) continue;
        // Loop over parents and test their IDs
        /// @todo Could use any() here?
        foreach (const GenParticle* parent, Rivet::particles(startVtx, HepMC::ancestors)) {
          if (vetoid == parent->pdg_id()) {
            ip = _theParticles.erase(ip); --ip; //< Erase this _theParticles entry
            break;
          }
        }
      }
    }

    // Now veto on the FS
    foreach (const string& ifs, _vetofsnames) {
      const FinalState& vfs = applyProjection<FinalState>(e, ifs);
      const Particles& vfsp = vfs.particles();
      for (Particles::iterator icheck = _theParticles.begin(); icheck != _theParticles.end(); ++icheck) {
        if (icheck->genParticle() == NULL) continue;
        bool found = false;
        for (Particles::const_iterator ipart = vfsp.begin(); ipart != vfsp.end(); ++ipart){
          if (ipart->genParticle() == NULL) continue;
          MSG_TRACE("Comparing barcode " << icheck->genParticle()->barcode()
                   << " with veto particle " << ipart->genParticle()->barcode());
          if (ipart->genParticle()->barcode() == icheck->genParticle()->barcode()){
            found = true;
            break;
          }
        }
        if (found) {
          _theParticles.erase(icheck);
          --icheck;
        }
      }
    }
  }

VetoedFinalState& reset ( ) [inline]

Clear the list of particle IDs and ranges to veto.

Definition at line 138 of file VetoedFinalState.hh.

                              {
      _vetoCodes.clear();
      return *this;
    }

void setName ( const std::string & name ) [inline, inherited]

Used by derived classes to set their name.

Definition at line 121 of file Projection.hh.

                                        {
      _name = name;
    }

VetoedFinalState& setVetoDetails ( const VetoDetails & ids ) [inline]

Set the list of particle IDs and $ p_T $ ranges to veto.

Definition at line 132 of file VetoedFinalState.hh.

                                                             {
      _vetoCodes = ids;
      return *this;
    }

size_t size ( ) const [inline, inherited]

Access the projected final-state particles.

Definition at line 38 of file ParticleFinder.hh.

{ return particles().size(); }

const VetoDetails& vetoDetails ( ) const [inline]

Get the list of particle IDs and $ p_T $ ranges to veto.

Definition at line 69 of file VetoedFinalState.hh.

                                           {
      return _vetoCodes;
    }

VetoedFinalState& vetoNeutrinos ( ) [inline]

Veto all neutrinos (convenience method)

Definition at line 105 of file VetoedFinalState.hh.

                                      {
      addVetoPairId(PID::NU_E);
      addVetoPairId(PID::NU_MU);
      addVetoPairId(PID::NU_TAU);
      return *this;
    }

Friends And Related Function Documentation

friend class Cmp< Projection > [friend, inherited]

The Cmp specialization for Projection is a friend.

Definition at line 36 of file Projection.hh.

friend class Event [friend, inherited]

Event is a friend.

Definition at line 33 of file Projection.hh.

Member Data Documentation

bool _allowProjReg [protected, inherited]

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

Definition at line 176 of file ProjectionApplier.hh.

CompositeVeto _compositeVetoes [private]

Composite particle masses to veto.

Definition at line 168 of file VetoedFinalState.hh.

Cut _cuts [protected, inherited]

The kinematic cuts cuts.

Definition at line 192 of file ParticleFinder.hh.

set<int> _nCompositeDecays [private]

Definition at line 169 of file VetoedFinalState.hh.

ParentVetos _parentVetoes [private]

Set of decaying particle IDs to veto.

Definition at line 174 of file VetoedFinalState.hh.

Particles _theParticles [protected, inherited]

The found particles returned by the particles() methods.

Definition at line 195 of file ParticleFinder.hh.

VetoDetails _vetoCodes [private]

The final-state particles.

Definition at line 165 of file VetoedFinalState.hh.

set<string> _vetofsnames [private]

Set of finalstate to be vetoed.

Definition at line 177 of file VetoedFinalState.hh.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Friends

For JetAlg compatibility

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation