![]() |
Rivet
3.1.2
|
Project out all physical-but-decayed particles in an event. More...
#include <UnstableParticles.hh>
Public Member Functions | |
virtual CmpState | compare (const Projection &p) const |
Compare projections. | |
virtual bool | accept (const Particle &p) const |
virtual std::string | name () const |
Get the name of the projection. | |
bool | valid () const |
Get the state of the projetion. | |
bool | failed () const |
Get the state of the projetion. | |
void | markAsOwned () const |
Mark this object as owned by a proj-handler. | |
Standard constructors and destructors. | |
UnstableParticles (const Cut &c=Cuts::open()) | |
Cut-based / default constructor. | |
DEFAULT_RIVET_PROJ_CLONE (UnstableParticles) | |
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 | |
size_t | size () const |
Count the final-state particles. | |
size_t | size (const Cut &c) const |
Count the final-state particles after a Cut is applied. | |
size_t | size (const ParticleSelector &s) const |
Count the final-state particles after a selection functor is applied. | |
bool | empty () const |
Is this final state empty? | |
bool | empty (const Cut &c) const |
Is this final state empty after a Cut is applied? | |
bool | empty (const ParticleSelector &s) const |
Is this final state empty after a selection functor is applied? | |
virtual const Particles & | particles () const |
Get the particles in no particular order, with no cuts. | |
Particles | particles (const Cut &c) const |
Get the particles with selection cuts. More... | |
Particles | particles (const ParticleSelector &selector) const |
Get the particles with selection cuts via a functor. More... | |
Particles | particles (const ParticleSorter &sorter, const Cut &c=Cuts::open()) const |
Particles | particles (const Cut &c, const ParticleSorter &sorter) const |
Particles | particles (const ParticleSelector &selector, const ParticleSorter &sorter) const |
Particles | particles (const ParticleSorter &sorter, const ParticleSelector &selector) const |
Particles | rawParticles () const |
Particles | particlesByPt (const Cut &c=Cuts::open()) const |
Particles | particlesByPt (const ParticleSelector &selector) const |
Particles | particlesByPt (double ptmin) const |
Projection operation and comparison | |
bool | before (const Projection &p) const |
Beam configuration | |
| |
virtual const std::set< PdgIdPair > | beamPairs () const |
Projection & | addPdgIdPair (PdgId beam1, PdgId beam2) |
Projection "getting" functions | |
std::set< ConstProjectionPtr > | getProjections () const |
Get the contained projections, including recursion. | |
bool | hasProjection (const std::string &name) const |
Does this applier have a projection registered under the name name? | |
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 = Projection> | |
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > | applyProjection (const Event &evt, const Projection &proj) const |
template<typename PROJ = Projection> | |
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > | applyProjection (const Event &evt, const PROJ &proj) const |
template<typename PROJ = Projection> | |
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > | applyProjection (const Event &evt, const std::string &name) const |
template<typename PROJ = Projection> | |
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > | apply (const Event &evt, const Projection &proj) const |
Apply the supplied projection on event evt (user-facing alias). | |
template<typename PROJ = Projection> | |
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > | apply (const Event &evt, const PROJ &proj) const |
Apply the supplied projection on event evt (user-facing alias). | |
template<typename PROJ = Projection> | |
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > | apply (const Event &evt, const std::string &name) const |
Apply the supplied projection on event evt (user-facing alias). | |
template<typename PROJ = Projection> | |
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > | apply (const std::string &name, const Event &evt) const |
Apply the supplied projection on event evt (convenience arg-reordering alias). | |
Protected Member Functions | |
virtual void | project (const Event &e) |
Apply the projection to the event. | |
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 | fail () |
Set the projection in an unvalid state. | |
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 & | declareProjection (const PROJ &proj, const std::string &name) |
Register a contained projection. More... | |
template<typename PROJ > | |
const PROJ & | declare (const PROJ &proj, const std::string &name) |
Register a contained projection (user-facing version) More... | |
template<typename PROJ > | |
const PROJ & | declare (const std::string &name, const PROJ &proj) |
Register a contained projection (user-facing, arg-reordered version) More... | |
For JetAlg compatibility | |
| |
const collection_type & | entities () const |
Template-usable interface common to JetAlg. | |
typedef Particle | entity_type |
typedef Particles | collection_type |
Project out all physical-but-decayed particles in an event.
The particles returned by are unique unstable particles, such as hadrons which are decayed by the generator. If, for example, you set Ks and Lambda particles stable in the generator, they will not be returned. Also, you should be aware that all unstable particles in a decay chain are returned: if you are looking for something like the number of B hadrons in an event and there is a decay chain from e.g. B** -> B, you will count both B mesons unless you are careful to check for ancestor/descendent relations between the particles. Duplicate particles in the event record, i.e. those which differ only in bookkeeping details or photon emissions, are stripped from the returned particles collection.
Convert to a general ParticleFinder since this is explicitly not a final state... but needs care
Add a FIRST/LAST/ANY enum to specify the mode for uniquifying replica chains (default = LAST)
|
virtualinherited |
Decide if a particle is to be accepted or not.
Reimplemented in Rivet::FinalPartons.
|
inlineinherited |
Add a colliding beam pair.
|
inlineinherited |
Apply the supplied projection on event evt.
|
inlineinherited |
Apply the supplied projection on event evt.
|
inlineinherited |
Apply the named projection on event evt.
|
virtualinherited |
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.
Referenced by Rivet::Projection::failed().
|
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.
Referenced by Rivet::Projection::fail(), and Rivet::Projection::failed().
|
inlineprotectedinherited |
Register a contained projection (user-facing version)
References Rivet::ProjectionApplier::declareProjection().
Referenced by Rivet::CentralityProjection::add(), Rivet::VetoedFinalState::addVetoOnThisFinalState(), Rivet::BeamThrust::BeamThrust(), Rivet::CentralEtHCM::CentralEtHCM(), Rivet::CentralityEstimator::CentralityEstimator(), Rivet::ChargedLeptons::ChargedLeptons(), Rivet::ALICE::CLMultiplicity< INNER >::CLMultiplicity(), Rivet::DISDiffHadron::DISDiffHadron(), Rivet::DISFinalState::DISFinalState(), Rivet::DISKinematics::DISKinematics(), Rivet::DISLepton::DISLepton(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), Rivet::GeneratedCentrality::GeneratedCentrality(), Rivet::HadronicFinalState::HadronicFinalState(), Rivet::HeavyHadrons::HeavyHadrons(), Rivet::Hemispheres::Hemispheres(), Rivet::InvisibleFinalState::InvisibleFinalState(), Rivet::LeadingParticlesFinalState::LeadingParticlesFinalState(), Rivet::LossyFinalState< ConstRandomFilter >::LossyFinalState(), Rivet::MC_pPbMinBiasTrigger::MC_pPbMinBiasTrigger(), Rivet::MC_SumETFwdPbCentrality::MC_SumETFwdPbCentrality(), Rivet::ATLAS::MinBiasTrigger::MinBiasTrigger(), Rivet::MissingMomentum::MissingMomentum(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NonHadronicFinalState::NonHadronicFinalState(), Rivet::ParisiTensor::ParisiTensor(), Rivet::PercentileProjection::PercentileProjection(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::CentralityBinner< T, MDist >::setProjection(), Rivet::SmearedJets::SmearedJets(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedParticles::SmearedParticles(), Rivet::Spherocity::Spherocity(), Rivet::ATLAS::SumET_PB_Centrality::SumET_PB_Centrality(), Rivet::ATLAS::SumET_PBPB_Centrality::SumET_PBPB_Centrality(), Rivet::TauFinder::TauFinder(), Rivet::Thrust::Thrust(), Rivet::TriggerCDFRun0Run1::TriggerCDFRun0Run1(), Rivet::TriggerCDFRun2::TriggerCDFRun2(), Rivet::UndressBeamLeptons::UndressBeamLeptons(), Rivet::ALICE::V0AndTrigger::V0AndTrigger(), Rivet::ALICE::V0Trigger< MODE >::V0Trigger(), Rivet::VetoedFinalState::VetoedFinalState(), and Rivet::VisibleFinalState::VisibleFinalState().
|
inlineprotectedinherited |
Register a contained projection (user-facing, arg-reordered version)
References Rivet::ProjectionApplier::declareProjection(), and Rivet::ProjectionApplier::name().
|
inlineprotectedinherited |
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.
Referenced by Rivet::ProjectionApplier::declare().
|
inlineinherited |
Get the named projection, specifying return type via a template argument (user-facing alias).
References Rivet::ProjectionApplier::name().
|
inlineinherited |
Get the named projection, specifying return type via a template argument.
References Rivet::ProjectionHandler::getProjection(), and Rivet::ProjectionApplier::getProjHandler().
Referenced by Rivet::pcmp().
|
inlineinherited |
Get the named projection (non-templated, so returns as a reference to a Projection base class).
References Rivet::ProjectionHandler::getProjection(), and Rivet::ProjectionApplier::getProjHandler().
|
protectedinherited |
Shortcut to make a named Cmp<Projection> comparison with the *this
object automatically passed as one of the parent projections.
Referenced by Rivet::FParameter::compare(), Rivet::STAR_BES_Centrality::compare(), Rivet::CentralEtHCM::compare(), Rivet::BeamThrust::compare(), Rivet::MC_SumETFwdPbCentrality::compare(), Rivet::ATLAS::SumET_PB_Centrality::compare(), Rivet::CentralityEstimator::compare(), Rivet::Spherocity::compare(), Rivet::GammaGammaFinalState::compare(), Rivet::LossyFinalState< ConstRandomFilter >::compare(), Rivet::BRAHMSCentrality::compare(), Rivet::Thrust::compare(), Rivet::DISFinalState::compare(), Rivet::MC_pPbMinBiasTrigger::compare(), Rivet::ATLAS::SumET_PBPB_Centrality::compare(), Rivet::Hemispheres::compare(), Rivet::HeavyHadrons::compare(), Rivet::PercentileProjection::compare(), Rivet::ATLAS::MinBiasTrigger::compare(), Rivet::EventMixingBase::compare(), Rivet::GeneratedCentrality::compare(), and Rivet::Projection::fail().
|
protectedinherited |
Shortcut to make a named Cmp<Projection> comparison with the *this
object automatically passed as one of the parent projections.
Referenced by Rivet::SmearedMET::compare(), Rivet::SmearedParticles::compare(), Rivet::SmearedJets::compare(), Rivet::Correlators::compare(), Rivet::ALICE::PrimaryParticles::compare(), and Rivet::Projection::fail().
|
inlineinherited |
Get the particles with selection cuts.
References Rivet::filter_select(), and Rivet::ParticleFinder::particles().
|
inlineinherited |
Get the particles with selection cuts via a functor.
References Rivet::filter_select(), and Rivet::ParticleFinder::particles().
|
inlineinherited |
Get the particles, ordered by supplied sorting function object
References Rivet::ParticleFinder::particles(), and Rivet::sortBy().
|
inlineinherited |
Get the particles, ordered by supplied sorting function object
References Rivet::ParticleFinder::particles(), and Rivet::sortBy().
|
inlineinherited |
Get the particles, ordered by a sorting functor and filtered by a selection functor
References Rivet::ParticleFinder::particles(), and Rivet::sortBy().
|
inlineinherited |
Get the particles, ordered by a sorting functor and filtered by a selection functor
References Rivet::ParticleFinder::particles(), and Rivet::sortBy().
|
inlineinherited |
Get the 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).
References Rivet::cmpMomByPt(), and Rivet::ParticleFinder::particles().
Referenced by Rivet::SmearedParticles::project(), and Rivet::SmearedParticles::truthParticles().
|
inlineinherited |
Get the 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(f, cmpMomByPt).
References Rivet::cmpMomByPt(), and Rivet::ParticleFinder::particles().
|
inlineinherited |
Get the 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).
References Rivet::cmpMomByPt(), and Rivet::ParticleFinder::particles().
|
inlineinherited |
Get the raw particles in no particular order, with no cuts
References Rivet::ParticleFinder::particles().