rivet is hosted by Hepforge, IPPP Durham
Rivet 4.0.2
Rivet::Hemispheres Class Referenceabstract

Calculate the hemisphere masses and broadenings. More...

#include <Hemispheres.hh>

Inheritance diagram for Rivet::Hemispheres:
Rivet::Projection Rivet::ProjectionApplier

Public Member Functions

 Hemispheres (const AxesDefinition &ax)
 Constructor.
 
 RIVET_DEFAULT_PROJ_CLONE (Hemispheres)
 Clone on the heap.
 
void clear ()
 Reset the projection.
 
void calc (const Vector3 &n, const std::vector< FourMomentum > &p4s)
 Use the projection manually (i.e. outside the projection mechanism) with raw 4-momentum inputs.
 
void calc (const Vector3 &n, const Particles &particles)
 Use the projection manually (i.e. outside the projection mechanism) with particle inputs.
 
void calc (const Vector3 &n, const Jets &jets)
 Use the projection manually (i.e. outside the projection mechanism) with jet inputs.
 
bool massMatchesBroadening () const
 Is the hemisphere with the max mass the same as the one with the max broadening?
 
bool highMassDirection () const
 Is the hemisphere with the max mass the one in the direction of the axis.
 
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.
 
Hemisphere masses (scaled by \f$ 1 / E^2_\mathrm{vis} \f$).
double E2vis () const
 
double Evis () const
 
double M2high () const
 
double Mhigh () const
 
double M2low () const
 
double Mlow () const
 
double M2diff () const
 
double Mdiff () const
 
double M2sum () const
 
double Msum () const
 
double scaledM2high () const
 
double scaledMhigh () const
 
double scaledM2low () const
 
double scaledMlow () const
 
double scaledM2diff () const
 
double scaledMdiff () const
 
Hemisphere broadenings.
double Bmax () const
 
double Bmin () const
 
double Bsum () const
 
double Bdiff () const
 
Standard constructors and destructors.
virtual unique_ptr< Projectionclone () const =0
 Clone on the heap.
 
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 ProjectiongetProjection (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 with other projections.
 
LoggetLog () 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< ProjectionmkNamedPCmp (const Projection &otherparent, const std::string &pname) const
 
Cmp< ProjectionmkPCmp (const Projection &otherparent, const std::string &pname) const
 
ProjectionHandlergetProjHandler () 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

Calculate the hemisphere masses and broadenings.

Calculate the hemisphere masses and broadenings, with event hemispheres defined by the plane normal to the thrust vector, \( \vec{n}_\mathrm{T} \).

The "high" hemisphere mass, \( M^2_\mathrm{high} / E^2_\mathrm{vis} \), is defined as

\[ \frac{M^2_\mathrm{high}}{E^2_\mathrm{vis}} = \frac{1}{E^2_\mathrm{vis}} \max \left( \left| \sum_{\vec{p}_k \cdot \vec{n}_\mathrm{T} > 0} p_k \right|^2 , \left| \sum_{\vec{p}_k \cdot \vec{n}_\mathrm{T} < 0} p_k \right|^2 \right) \]

and the corresponding "low" hemisphere mass, \( M^2_\mathrm{low} / E^2_\mathrm{vis} \), is the sum of momentum vectors in the opposite hemisphere, i.e. \( \max \rightarrow \min \) in the formula above.

Finally, we define a hemisphere mass difference:

\[ \frac{M^2_\mathrm{diff} }{ E^2_\mathrm{vis}} = \frac{ M^2_\mathrm{high} - M^2_\mathrm{low} }{ E^2_\mathrm{vis}} . \]

Similarly to the masses, we also define hemisphere broadenings, using the momenta transverse to the thrust axis:

\[ B_\pm = \frac{ \sum{\pm \vec{p}_i \cdot \vec{n}_\mathrm{T} > 0} |\vec{p}_i \times \vec{n}_\mathrm{T} | }{ 2 \sum_i | \vec{p}_i | } \]

and then a set of the broadening maximum, minimum, sum and difference as follows:

\[ B_\mathrm{max} = \max(B_+, B_-) \]

\[ B_\mathrm{min} = \min(B_+, B_-) \]

\[ B_\mathrm{sum} = B_+ + B_- \]

\[ B_\mathrm{diff} = |B_+ - B_-| \]

Internally, this projection uses a Thrust or Sphericity projection to determine the hemisphere orientation.

Member Function Documentation

◆ apply()

template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::apply ( const Event evt,
const Projection proj 
) const
inlineinherited

Apply the supplied projection on event evt.

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

Referenced by Rivet::ALICE::V0Trigger< MODE >::project().

◆ before()

bool Rivet::Projection::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.

◆ clone()

◆ compare()

CmpState Rivet::Hemispheres::compare ( const Projection p) const
inlineprotectedvirtual

Compare with other projections.

Implements Rivet::Projection.

References Rivet::Projection::mkNamedPCmp().

◆ declare() [1/2]

template<typename PROJ >
const PROJ & Rivet::ProjectionApplier::declare ( const PROJ &  proj,
const std::string &  name 
) const
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< INNER >::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(), 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::Spherocity::Spherocity(), Rivet::ATLAS::SumET_PB_Centrality::SumET_PB_Centrality(), Rivet::ATLAS::SumET_PBPB_Centrality::SumET_PBPB_Centrality(), Rivet::TauFinder::TauFinder(), Rivet::TriggerCDFRun0Run1::TriggerCDFRun0Run1(), Rivet::TriggerCDFRun2::TriggerCDFRun2(), Rivet::UndressBeamLeptons::UndressBeamLeptons(), Rivet::ALICE::V0AndTrigger::V0AndTrigger(), Rivet::ALICE::V0Trigger< MODE >::V0Trigger(), Rivet::VetoedFinalState::VetoedFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), Rivet::CentralityBinner< T, MDist >::setProjection(), and Rivet::VetoedFinalState::vetoFinalState().

◆ declare() [2/2]

template<typename PROJ >
const PROJ & Rivet::ProjectionApplier::declare ( const std::string &  name,
const PROJ &  proj 
) const
inlineprotectedinherited

Register a contained projection (user-facing, arg-reordered version)

Todo:
Add SFINAE to require that PROJ inherit from Projection

◆ get()

template<typename PROJ >
const PROJ & Rivet::ProjectionApplier::get ( const std::string &  name) const
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

◆ getProjection() [1/2]

template<typename PROJ >
const PROJ & Rivet::ProjectionApplier::getProjection ( const std::string &  name) const
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(), and Rivet::ProjectionApplier::getProjHandler().

Referenced by Rivet::CentralityProjection::compare(), Rivet::pcmp(), Rivet::pcmp(), Rivet::pcmp(), and Rivet::pcmp().

◆ getProjection() [2/2]

const Projection & Rivet::ProjectionApplier::getProjection ( const std::string &  name) const
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().

◆ getProjectionFromDeclQueue()

template<typename PROJ >
const PROJ & Rivet::ProjectionApplier::getProjectionFromDeclQueue ( const std::string  name) const
inlineinherited

Get a named projection from this projection appliers declqueue TODO for TP: Recursion?

References MSG_ERROR.

◆ mkNamedPCmp()

◆ mkPCmp()

Cmp< Projection > Rivet::Projection::mkPCmp ( const Projection otherparent,
const std::string &  pname 
) const
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

Referenced by Rivet::ALICE::PrimaryParticles::compare(), Rivet::SmearedJets::compare(), Rivet::SmearedMET::compare(), Rivet::SmearedParticles::compare(), and Rivet::Correlators::compare().

◆ name()

virtual std::string Rivet::Projection::name ( ) const
inlinevirtualinherited

◆ project()

void Rivet::Hemispheres::project ( const Event e)
protectedvirtual

Perform the projection on the Event.

Implements Rivet::Projection.

◆ setProjectionHandler()

void Rivet::ProjectionApplier::setProjectionHandler ( ProjectionHandler projectionHandler) const
protectedinherited
Todo:
AB: Add Doxygen comment, follow surrounding coding style

The documentation for this class was generated from the following file:
  • /Users/chrisg/software/rivet/include/Rivet/Projections/Hemispheres.hh