Identify particles which can be paired to fit within a given invariant mass window. More...

#include <InvMassFinalState.hh>

Public Member Functions
	InvMassFinalState (const FinalState &fsp, const std::pair< PdgId, PdgId > &idpair, double minmass, double maxmass, double masstarget=-1.0)
	Constructor for a single inv-mass pair.
	InvMassFinalState (const FinalState &fsp, const std::vector< std::pair< PdgId, PdgId > > &idpairs, double minmass, double maxmass, double masstarget=-1.0)
	Constructor for multiple inv-mass pairs.
	InvMassFinalState (const std::pair< PdgId, PdgId > &idpair, double minmass, double maxmass, double masstarget=-1.0)
	Same thing as above, but we want to pass the particles directly to the calc method.
	InvMassFinalState (const std::vector< std::pair< PdgId, PdgId > > &idpairs, double minmass, double maxmass, double masstarget=-1.0)
	DEFAULT_RIVET_PROJ_CLONE (InvMassFinalState)
	Clone on the heap.
const std::vector< std::pair < Particle, Particle > > &	particlePairs () const
	Constituent pairs.
void	useTransverseMass (bool usetrans=true)
	Choose whether to use the full inv mass or just the transverse mass.
void	calc (const Particles &inparticles)
	Operate on a given particle vector directly instead of through project (no caching)
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
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 Member Functions
double	massT (FourMomentum v1, FourMomentum v2)
	Transverse Mass.
Private Attributes
std::vector< PdgIdPair >	_decayids
	IDs of the decay products.
std::vector< std::pair < Particle, Particle > >	_particlePairs
	Constituent pairs.
double	_minmass
	Min inv mass.
double	_maxmass
	Max inv mass.
double	_masstarget
	Target mass if only one pair should be returned.
bool	_useTransverseMass
	Flag to decide whether to use the full inv mass or just the transverse mass.
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; }
const collection_type &	entities () const
	Template-usable interface common to JetAlg.
typedef Particle	entity_type
typedef Particles	collection_type

Detailed Description

Identify particles which can be paired to fit within a given invariant mass window.

Definition at line 11 of file InvMassFinalState.hh.

Member Typedef Documentation

typedef Particles collection_type [inherited]

Definition at line 173 of file ParticleFinder.hh.

typedef Particle entity_type [inherited]

Definition at line 172 of file ParticleFinder.hh.

Constructor & Destructor Documentation

InvMassFinalState	(	const FinalState &	fsp,
		const std::pair< PdgId, PdgId > &	idpair,
		double	minmass,
		double	maxmass,
		double	masstarget = `-1.0`
	)

Constructor for a single inv-mass pair.

InvMassFinalState	(	const FinalState &	fsp,
		const std::vector< std::pair< PdgId, PdgId > > &	idpairs,
		double	minmass,
		double	maxmass,
		double	masstarget = `-1.0`
	)

Constructor for multiple inv-mass pairs.

InvMassFinalState	(	const std::pair< PdgId, PdgId > &	idpair,
		double	minmass,
		double	maxmass,
		double	masstarget = `-1.0`
	)

Same thing as above, but we want to pass the particles directly to the calc method.

InvMassFinalState	(	const std::vector< std::pair< PdgId, PdgId > > &	idpairs,
		double	minmass,
		double	maxmass,
		double	masstarget = `-1.0`
	)

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

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

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

void calc ( const Particles & inparticles )

Operate on a given particle vector directly instead of through project (no caching)

Definition at line 86 of file InvMassFinalState.cc.

                                                           {
    _theParticles.clear();
    _particlePairs.clear();

    // Containers for the particles of type specified in the pair
    vector<const Particle*> type1;
    vector<const Particle*> type2;
    // Get all the particles of the type specified in the pair from the particle list
    foreach (const Particle& ipart, inparticles) {
      // Loop around possible particle pairs (typedef needed to keep BOOST_FOREACH happy)
      foreach (const PdgIdPair& ipair, _decayids) {
        if (ipart.pid() == ipair.first) {
          if (accept(ipart)) {
            type1 += &ipart;
          }
        } else if (ipart.pid() == ipair.second) {
          if (accept(ipart)) {
            type2 += &ipart;
          }
        }
      }
    }
    if (type1.empty() || type2.empty()) return;

    // Temporary container of selected particles iterators
    // Useful to compare iterators and avoid double occurrences of the same
    // particle in case it matches with more than another particle
    vector<const Particle*> tmp;

    // Now calculate the inv mass
    pair<double, pair<Particle, Particle> > closestPair;
    closestPair.first = 1e30;
    foreach (const Particle* i1, type1) {
      foreach (const Particle* i2, type2) {
        // Check this is actually a pair
        // (if more than one pair in vector particles can be unrelated)
        bool found = false;
        foreach (const PdgIdPair& ipair, _decayids) {
          if (i1->pid() == ipair.first && i2->pid() == ipair.second) {
            found = true;
            break;
          }
        }
        if (!found) continue;

        FourMomentum v4 = i1->momentum() + i2->momentum();
        if (v4.mass2() < 0) {
          MSG_DEBUG("Constructed negative inv mass2: skipping!");
          continue;
        }
        bool passedMassCut = false;
        if (_useTransverseMass) {
          passedMassCut = inRange(massT(i1->momentum(), i2->momentum()), _minmass, _maxmass);
        } else {
          passedMassCut = inRange(v4.mass(), _minmass, _maxmass);
        }

        if (passedMassCut) {
          MSG_DEBUG("Selecting particles with IDs " << i1->pid() << " & " << i2->pid()
                    << " and mass = " << v4.mass()/GeV << " GeV");
          // Store accepted particles, avoiding duplicates
          if (find(tmp.begin(), tmp.end(), i1) == tmp.end()) {
            tmp.push_back(i1);
            _theParticles += *i1;
          }
          if (find(tmp.begin(), tmp.end(), i2) == tmp.end()) {
            tmp.push_back(i2);
            _theParticles += *i2;
          }
          // Store accepted particle pairs
          _particlePairs += make_pair(*i1, *i2);
          if (_masstarget>0.0) {
            double diff=fabs(v4.mass()-_masstarget);
            if (diff<closestPair.first) {
              closestPair.first=diff;
              closestPair.second=make_pair(*i1, *i2);
            }
          }
        }
      }
    }
    if (_masstarget > 0.0 && closestPair.first < 1e30) {
      _theParticles.clear();
      _particlePairs.clear();
      _theParticles += closestPair.second.first;
      _theParticles += closestPair.second.second;
      _particlePairs += closestPair.second;
    }

    MSG_DEBUG("Selected " << _theParticles.size() << " particles " << "(" << _particlePairs.size() << " pairs)");
    if (getLog().isActive(Log::TRACE)) {
      foreach (const Particle& p, _theParticles) {
        MSG_TRACE("ID: " << p.pid() << ", barcode: " << p.genParticle()->barcode());
      }
    }
  }

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.

Reimplemented from FinalState.

Definition at line 53 of file InvMassFinalState.cc.

                                                          {
    // First compare the final states we are running on
    int fscmp = mkNamedPCmp(p, "FS");
    if (fscmp != EQUIVALENT) return fscmp;

    // Then compare the two as final states
    const InvMassFinalState& other = dynamic_cast<const InvMassFinalState&>(p);
    fscmp = FinalState::compare(other);
    if (fscmp != EQUIVALENT) return fscmp;

    // Compare the mass limits
    int masstypecmp = cmp(_useTransverseMass, other._useTransverseMass);
    if (masstypecmp != EQUIVALENT) return masstypecmp;
    int massllimcmp = cmp(_minmass, other._minmass);
    if (massllimcmp != EQUIVALENT) return massllimcmp;
    int masshlimcmp = cmp(_maxmass, other._maxmass);
    if (masshlimcmp != EQUIVALENT) return masshlimcmp;

    // Compare the decay species
    int decaycmp = cmp(_decayids, other._decayids);
    if (decaycmp != EQUIVALENT) return decaycmp;

    // Finally compare them as final states
    return FinalState::compare(other);
  }

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 ( InvMassFinalState )

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

double massT	(	FourMomentum	v1,
		FourMomentum	v2
	)		`[inline, private]`

Transverse Mass.

Definition at line 60 of file InvMassFinalState.hh.

                                                           {
      return sqrt( (v1.Et() + v2.Et())*(v1.Et() + v2.Et()) -
                   (v1+v2).perp()*(v1+v2).perp() );
    }

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

const std::vector< std::pair< Particle, Particle > > & particlePairs ( ) const

Constituent pairs.

Definition at line 185 of file InvMassFinalState.cc.

                                                                                        {
    return _particlePairs;
  }

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.

Reimplemented from FinalState.

Definition at line 80 of file InvMassFinalState.cc.

                                                {
    const FinalState& fs = applyProjection<FinalState>(e, "FS");
    calc(fs.particles());
  }

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

size_t size ( ) const [inline, inherited]

Access the projected final-state particles.

Definition at line 38 of file ParticleFinder.hh.

{ return particles().size(); }

void useTransverseMass ( bool usetrans = true ) [inline]

Choose whether to use the full inv mass or just the transverse mass.

Definition at line 50 of file InvMassFinalState.hh.

                                               {
      _useTransverseMass = usetrans;
    }

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.

Cut _cuts [protected, inherited]

The kinematic cuts cuts.

Definition at line 192 of file ParticleFinder.hh.

std::vector<PdgIdPair> _decayids [private]

IDs of the decay products.

Definition at line 77 of file InvMassFinalState.hh.

double _masstarget [private]

Target mass if only one pair should be returned.

Definition at line 89 of file InvMassFinalState.hh.

double _maxmass [private]

Max inv mass.

Definition at line 86 of file InvMassFinalState.hh.

double _minmass [private]

Min inv mass.

Definition at line 83 of file InvMassFinalState.hh.

std::vector<std::pair<Particle, Particle> > _particlePairs [private]

Constituent pairs.

Definition at line 80 of file InvMassFinalState.hh.

Particles _theParticles [protected, inherited]

The found particles returned by the particles() methods.

Definition at line 195 of file ParticleFinder.hh.

bool _useTransverseMass [private]

Flag to decide whether to use the full inv mass or just the transverse mass.

Definition at line 92 of file InvMassFinalState.hh.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

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