Rivet API documentation
![]() |
Rivet 4.1.3
|
Get the e+ e- thrust basis and the thrust, thrust major and thrust minor scalars. More...
#include <Thrust.hh>
Public Member Functions | |
| Thrust () | |
| Constructor. | |
| Thrust (const FinalState &fsp) | |
| RIVET_DEFAULT_PROJ_CLONE (Thrust) | |
| Clone on the heap. | |
| virtual unique_ptr< Projection > | clone () const =0 |
| Clone on the heap. | |
| 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. | |
| double | thrust () const |
| double | thrustMajor () const |
| The thrust major scalar, \( M \), (thrust along thrust major axis). | |
| double | thrustMinor () const |
| The thrust minor scalar, \( m \), (thrust along thrust minor axis). | |
| double | oblateness () const |
| The oblateness, \( O = M - m \) . | |
| const Vector3 & | thrustAxis () const |
| const Vector3 & | thrustMajorAxis () const |
| The thrust major axis (axis of max thrust perpendicular to thrust axis). | |
| const Vector3 & | thrustMinorAxis () const |
| The thrust minor axis (axis perpendicular to thrust and thrust major). | |
| const Vector3 & | axis1 () const |
| AxesDefinition axis accessors. | |
| const Vector3 & | axis2 () const |
| The 2nd most significant ("major") axis. | |
| const Vector3 & | axis3 () const |
| The least significant ("minor") axis. | |
Direct methods | |
Ways to do the calculation directly, without engaging the caching system | |
| void | calc (const FinalState &fs) |
| Manually calculate the thrust, without engaging the caching system. | |
| void | calc (const vector< Particle > &fsparticles) |
| Manually calculate the thrust, without engaging the caching system. | |
| void | calc (const vector< FourMomentum > &fsmomenta) |
| Manually calculate the thrust, without engaging the caching system. | |
| void | calc (const vector< Vector3 > &threeMomenta) |
| Manually calculate the thrust, without engaging the caching system. | |
Projection operation and comparison | |
| bool | before (const Projection &p) const |
Projection "getting" functions | |
| std::set< ConstProjectionPtr > | getProjections () const |
| Get the contained projections, including recursion. | |
| std::set< ConstProjectionPtr > | getImmediateChildProjections () const |
| Get the contained projections, excluding 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 |
| template<typename PROJ> | |
| const PROJ & | getProjectionFromDeclQueue (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 & > | apply (const Event &evt, const Projection &proj) const |
| Apply the supplied projection on event evt. | |
| 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 | |
| void | project (const Event &e) |
| Perform the projection on the Event. | |
| CmpState | compare (const Projection &p) const |
| Compare projections. | |
| 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. | |
| void | setProjectionHandler (ProjectionHandler &projectionHandler) const |
Projection registration functions | |
| template<typename PROJ> | |
| const PROJ & | declare (const PROJ &proj, const std::string &name) const |
| Register a contained projection (user-facing version). | |
| template<typename PROJ> | |
| const PROJ & | declare (const std::string &name, const PROJ &proj) const |
| Register a contained projection (user-facing, arg-reordered version). | |
Detailed Description
Get the e+ e- thrust basis and the thrust, thrust major and thrust minor scalars.
The scalar (maximum) thrust is defined as
\[T = \mathrm{max}_{\vec{n}} \frac{\sum_i \left|\vec{p}_i \cdot \vec{n} \right|}{\sum_i |\vec{p}_i|} \]
, with the direction of the unit vector \( \vec{n} \) which maximises \( T \) being identified as the thrust axis. The unit vector which maximises the thrust scalar in the plane perpendicular to \( \vec{n} \) is the "thrust major" direction, and the vector perpendicular to both the thrust and thrust major directions is the thrust minor. Both the major and minor directions have associated thrust scalars.
Thrust calculations have particularly simple forms for less than 4 particles, and in those cases this projection is computationally minimal. For 4 or more particles, a more general calculation must be carried out, based on the Brandt/Dahmen method from Z. Phys. C1 (1978). While a polynomial improvement on the exponential scaling of the naive method, this algorithm scales asymptotically as \( \mathcal{O}\left( n^3 \right) \). Be aware that the thrust may easily be the most computationally demanding projection in Rivet for large events!
The Rivet implementation of thrust is based heavily on Stefan Gieseke's Herwig++ re-coding of the 'tasso' code from HERWIG.
NB. special case with >= 4 coplanar particles will still fail. NB. Thrust assumes all momenta are in the CoM system: no explicit boost is performed. This can be dealt with by appropriate choice of the supplied FinalState.
Member Function Documentation
◆ apply()
|
inlineinherited |
Apply the supplied projection on event evt.
Apply the supplied projection on event evt (user-facing alias).
Referenced by Rivet::SimpleAnalysis::electrons(), Rivet::SimpleAnalysis::jets(), Rivet::SimpleAnalysis::metSignf(), Rivet::SimpleAnalysis::muons(), Rivet::SimpleAnalysis::photons(), Rivet::ALICE::V0AndTrigger::project(), Rivet::ATLAS::MinBiasTrigger::project(), Rivet::ATLAS::SumET_PB_Centrality::project(), Rivet::ATLAS::SumET_PBPB_Centrality::project(), Rivet::BeamThrust::project(), Rivet::BRAHMSCentrality::project(), Rivet::CentralityEstimator::project(), Rivet::CentralityProjection::project(), Rivet::EventMixingBase::project(), Rivet::GeneratedCentrality::project(), Rivet::GeneratedPercentileProjection::project(), Rivet::ImpactParameterProjection::project(), Rivet::LossyFinalState< FILTER >::project(), Rivet::MC_pPbMinBiasTrigger::project(), Rivet::MC_SumETFwdPbCentrality::project(), Rivet::PercentileProjection::project(), Rivet::SmearedJets::project(), Rivet::SmearedMET::project(), Rivet::SmearedParticles::project(), Rivet::Spherocity::project(), Rivet::STAR_BES_Centrality::project(), Rivet::Thrust::project(), Rivet::UserCentEstimate::project(), Rivet::SimpleAnalysis::set(), Rivet::SimpleAnalysis::taus(), Rivet::SimpleAnalysis::tracks(), Rivet::SimpleAnalysis::tracks(), and Rivet::SimpleAnalysis::vmet().
◆ axis1()
|
inlinevirtual |
◆ axis2()
|
inlinevirtual |
The 2nd most significant ("major") axis.
Implements Rivet::AxesDefinition.
References thrustMajorAxis().
◆ axis3()
|
inlinevirtual |
The least significant ("minor") axis.
Implements Rivet::AxesDefinition.
References thrustMinorAxis().
◆ before()
|
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.
References Projection(), and Rivet::Kin::p().
◆ clone()
|
pure virtualinherited |
Clone on the heap.
Implements Rivet::Projection.
◆ compare()
|
inlineprotectedvirtual |
Compare projections.
Implements Rivet::Projection.
References Rivet::Projection::mkNamedPCmp(), and Rivet::Kin::p().
◆ declare() [1/2]
|
inlineprotectedinherited |
Register a contained projection (user-facing version).
- Todo
- Add SFINAE to require that PROJ inherit from Projection
Referenced by Rivet::CentralEtHCM::CentralEtHCM(), Rivet::CentralityEstimator::CentralityEstimator(), Rivet::ChargedLeptons::ChargedLeptons(), Rivet::ALICE::CLMultiplicity< true >::CLMultiplicity(), Rivet::DISDiffHadron::DISDiffHadron(), Rivet::DISFinalState::DISFinalState(), Rivet::DISKinematics::DISKinematics(), Rivet::DISLepton::DISLepton(), Rivet::EventMixingBase::EventMixingBase(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), Rivet::GeneratedCentrality::GeneratedCentrality(), Rivet::HadronicFinalState::HadronicFinalState(), Rivet::HeavyHadrons::HeavyHadrons(), Rivet::Hemispheres::Hemispheres(), Rivet::InvisibleFinalState::InvisibleFinalState(), Rivet::LeadingParticlesFinalState::LeadingParticlesFinalState(), Rivet::LossyFinalState< FILTER >::LossyFinalState(), Rivet::LossyFinalState< FILTER >::LossyFinalState(), Rivet::MC_pPbMinBiasTrigger::MC_pPbMinBiasTrigger(), Rivet::MC_SumETFwdPbCentrality::MC_SumETFwdPbCentrality(), Rivet::ATLAS::MinBiasTrigger::MinBiasTrigger(), Rivet::MissingMomentum::MissingMomentum(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NonHadronicFinalState::NonHadronicFinalState(), Rivet::ParisiTensor::ParisiTensor(), Rivet::PercentileProjection::PercentileProjection(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedMET::SmearedMET(), Rivet::Spherocity::Spherocity(), Rivet::ATLAS::SumET_PB_Centrality::SumET_PB_Centrality(), Rivet::ATLAS::SumET_PBPB_Centrality::SumET_PBPB_Centrality(), Rivet::TriggerCDFRun0Run1::TriggerCDFRun0Run1(), Rivet::TriggerCDFRun2::TriggerCDFRun2(), Rivet::UndressBeamLeptons::UndressBeamLeptons(), Rivet::ALICE::V0AndTrigger::V0AndTrigger(), Rivet::ALICE::V0Trigger<-1 >::V0Trigger(), Rivet::VetoedFinalState::VetoedFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), Rivet::SimpleAnalysis::postInit(), Rivet::CentralityBinner< T, MDist >::setProjection(), and Rivet::VetoedFinalState::vetoFinalState().
◆ declare() [2/2]
|
inlineprotectedinherited |
Register a contained projection (user-facing, arg-reordered version).
- Todo
- Add SFINAE to require that PROJ inherit from Projection
◆ get()
|
inlineinherited |
Get the named projection, specifying return type via a template argument (user-facing alias).
- Todo
- Add SFINAE to require that PROJ inherit from Projection
References getProjection().
Referenced by Rivet::FastJets::FastJets(), and Rivet::FastJets::FastJets().
◆ getProjection() [1/2]
|
inlineinherited |
Get the named projection (non-templated, so returns as a reference to a Projection base class).
References Rivet::ProjectionHandler::getProjection(), and getProjHandler().
◆ getProjection() [2/2]
|
inlineinherited |
Get the named projection, specifying return type via a template argument.
- Todo
- Add SFINAE to require that PROJ inherit from Projection
References Rivet::ProjectionHandler::getProjection(), getProjectionFromDeclQueue(), getProjHandler(), and Rivet::Kin::p().
Referenced by Rivet::CentralityProjection::compare(), Rivet::SimpleAnalysis::electronsProj(), get(), Rivet::SimpleAnalysis::jetsProj(), Rivet::DISFinalState::kinematics(), Rivet::SimpleAnalysis::metProj(), Rivet::SimpleAnalysis::muonsProj(), Rivet::pcmp(), Rivet::pcmp(), Rivet::pcmp(), Rivet::pcmp(), Rivet::SimpleAnalysis::photonsProj(), Rivet::SimpleAnalysis::tausProj(), Rivet::SimpleAnalysis::tracksProj(), Rivet::SmearedJets::truthJets(), and Rivet::SmearedParticles::truthParticles().
◆ getProjectionFromDeclQueue()
|
inlineinherited |
Get a named projection from this projection appliers declqueue TODO for TP: Recursion?
References MSG_ERROR.
Referenced by getProjection().
◆ mkNamedPCmp()
|
protectedinherited |
Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.
References Projection().
Referenced by Rivet::ATLAS::MinBiasTrigger::compare(), Rivet::ATLAS::SumET_PB_Centrality::compare(), Rivet::ATLAS::SumET_PBPB_Centrality::compare(), Rivet::BeamThrust::compare(), Rivet::BRAHMSCentrality::compare(), Rivet::CentralEtHCM::compare(), Rivet::CentralityEstimator::compare(), Rivet::DISFinalState::compare(), Rivet::EventMixingBase::compare(), Rivet::FParameter::compare(), Rivet::GammaGammaFinalState::compare(), Rivet::GeneratedCentrality::compare(), Rivet::HeavyHadrons::compare(), Rivet::Hemispheres::compare(), Rivet::LossyFinalState< FILTER >::compare(), Rivet::MC_pPbMinBiasTrigger::compare(), Rivet::MC_SumETFwdPbCentrality::compare(), Rivet::PercentileProjection::compare(), Rivet::Spherocity::compare(), Rivet::STAR_BES_Centrality::compare(), and Rivet::Thrust::compare().
◆ mkPCmp()
|
protectedinherited |
Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.
- Note
- Alias for mkNamedPCmp
References Projection().
Referenced by Rivet::ALICE::PrimaryParticles::compare(), Rivet::Correlators::compare(), Rivet::SmearedJets::compare(), and Rivet::SmearedParticles::compare().
◆ name()
|
inlinevirtualinherited |
Get the name of the projection.
Implements Rivet::ProjectionApplier.
Referenced by getLog(), setName(), and Rivet::VetoedFinalState::vetoFinalState().
◆ project()
|
inlineprotectedvirtual |
Perform the projection on the Event.
Implements Rivet::Projection.
References Rivet::ProjectionApplier::apply(), and calc().
◆ setProjectionHandler()
|
protectedinherited |
- Todo
- AB: Add Doxygen comment, follow surrounding coding style
◆ thrust()
|
inline |
Thrust scalar accessors The thrust scalar, \( T \), (maximum thrust).
◆ thrustAxis()
|
inline |
The documentation for this class was generated from the following file:
- /builds/hepcedar/rivet/include/Rivet/Projections/Thrust.hh
Generated on for Rivet by
