class Rivet::Hemispheres

Rivet::Hemispheres #

Calculate the hemisphere masses and broadenings. More…

#include <Hemispheres.hh>

Inherits from Rivet::Projection, Rivet::ProjectionApplier

Public Functions ##

Protected Functions ##

Additional inherited members ##

Public Functions inherited from Rivet::Projection

Protected Functions inherited from Rivet::Projection

Friends inherited from Rivet::Projection

Public Functions inherited from Rivet::ProjectionApplier

Detailed Description ##

class Rivet::Hemispheres;

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.

Public Functions Documentation ##

function E2vis ##

inline double E2vis() const

function Evis ##

inline double Evis() const

function M2high ##

inline double M2high() const

function Mhigh ##

inline double Mhigh() const

function M2low ##

inline double M2low() const

function Mlow ##

inline double Mlow() const

function M2diff ##

inline double M2diff() const

function Mdiff ##

inline double Mdiff() const

function M2sum ##

inline double M2sum() const

function Msum ##

inline double Msum() const

function scaledM2high ##

inline double scaledM2high() const

function scaledMhigh ##

inline double scaledMhigh() const

function scaledM2low ##

inline double scaledM2low() const

function scaledMlow ##

inline double scaledMlow() const

function scaledM2diff ##

inline double scaledM2diff() const

function scaledMdiff ##

inline double scaledMdiff() const

function Bmax ##

inline double Bmax() const

function Bmin ##

inline double Bmin() const

function Bsum ##

inline double Bsum() const

function Bdiff ##

inline double Bdiff() const

function massMatchesBroadening ##

inline bool massMatchesBroadening() const

Is the hemisphere with the max mass the same as the one with the max broadening?

function highMassDirection ##

inline bool highMassDirection() const

Is the hemisphere with the max mass the one in the direction of the axis.

function clone ##

virtual unique_ptr< Projection > clone() const =0

Clone on the heap.

Reimplemented by: Rivet::ALICE::V0Multiplicity::clone, Rivet::ALICE::CLMultiplicity::clone, Rivet::ALICE::V0Trigger::clone, Rivet::ALICE::V0AndTrigger::clone, Rivet::ALICE::PrimaryParticles::clone, Rivet::AxesDefinition::clone, Rivet::FastJets::clone, Rivet::ChargedFinalState::clone

function name ##

inline virtual std::string name() const

Get the name of the projection.

Reimplements: Rivet::ProjectionApplier::name

function valid ##

inline bool valid() const

Get the state of the projetion.

function failed ##

inline bool failed() const

Get the state of the projetion.

function before ##

bool before(
    const Projection & p
) const

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.

function beamPairs ##

virtual const std::set< PdgIdPair > beamPairs() const

Todo: Remove the beam constraints system from projections.

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.

function addPdgIdPair ##

inline Projection & addPdgIdPair(
    PdgId beam1,
    PdgId beam2
)

Todo: This deserves a better name!

Add a colliding beam pair.

function getProjections ##

inline std::set< ConstProjectionPtr > getProjections() const

Get the contained projections, including recursion.

function hasProjection ##

inline bool hasProjection(
    const std::string & name
) const

Does this applier have a projection registered under the name name?

function getProjection ##

template <typename PROJ >
inline const PROJ & getProjection(
    const std::string & name
) const

Todo: Add SFINAE to require that PROJ inherit from Projection

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

function getProjection ##

inline const Projection & getProjection(
    const std::string & name
) const

Get the named projection (non-templated, so returns as a reference to a Projection base class).

function get ##

template <typename PROJ >
inline const PROJ & get(
    const std::string & name
) const

Todo: Add SFINAE to require that PROJ inherit from Projection

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

function applyProjection ##

template <typename PROJ  =Projection>
inline std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > applyProjection(
    const Event & evt,
    const Projection & proj
) const

Deprecated:

Prefer the simpler apply<> form

Apply the supplied projection on event evt.

function applyProjection ##

template <typename PROJ  =Projection>
inline std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > applyProjection(
    const Event & evt,
    const PROJ & proj
) const

Deprecated:

Prefer the simpler apply<> form

Apply the supplied projection on event evt.

function applyProjection ##

template <typename PROJ  =Projection>
inline std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > applyProjection(
    const Event & evt,
    const std::string & name
) const

Deprecated:

Prefer the simpler apply<> form

Apply the named projection on event evt.

function apply ##

template <typename PROJ  =Projection>
inline 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).

function apply ##

template <typename PROJ  =Projection>
inline 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).

function apply ##

template <typename PROJ  =Projection>
inline 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).

function apply ##

template <typename PROJ  =Projection>
inline 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).

function markAsOwned ##

inline void markAsOwned() const

Mark this object as owned by a proj-handler.

function Hemispheres ##

inline Hemispheres(
    const AxesDefinition & ax
)

Constructor.

function DEFAULT_RIVET_PROJ_CLONE ##

DEFAULT_RIVET_PROJ_CLONE(
    Hemispheres 
)

Clone on the heap.

function clear ##

inline void clear()

Reset the projection.

function calc ##

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.

function calc ##

void calc(
    const Vector3 & n,
    const Particles & particles
)

Use the projection manually (i.e. outside the projection mechanism) with particle inputs.

function calc ##

void calc(
    const Vector3 & n,
    const Jets & jets
)

Use the projection manually (i.e. outside the projection mechanism) with jet inputs.

Protected Functions Documentation ##

function getLog ##

inline Log & getLog() const

Get a Log object based on the getName() property of the calling projection object.

function setName ##

inline void setName(
    const std::string & name
)

Used by derived classes to set their name.

function fail ##

inline void fail()

Set the projection in an unvalid state.

function mkNamedPCmp ##

Cmp< Projection > mkNamedPCmp(
    const Projection & otherparent,
    const std::string & pname
) const

Shortcut to make a named Cmp comparison with the *this object automatically passed as one of the parent projections.

function mkPCmp ##

Cmp< Projection > mkPCmp(
    const Projection & otherparent,
    const std::string & pname
) const

Note: Alias for mkNamedPCmp

Shortcut to make a named Cmp comparison with the *this object automatically passed as one of the parent projections.

function getProjHandler ##

inline ProjectionHandler & getProjHandler() const

Get a reference to the ProjectionHandler for this thread.

function declareProjection ##

template <typename PROJ >
inline const PROJ & declareProjection(
    const PROJ & proj,
    const std::string & name
)

Register a contained projection.

Todo: Add SFINAE to require that PROJ inherit from 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.

function declare ##

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

Register a contained projection (user-facing version)

Todo: Add SFINAE to require that PROJ inherit from Projection

function declare ##

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

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

Todo: Add SFINAE to require that PROJ inherit from Projection

function project ##

virtual void project(
    const Event & e
)

Perform the projection on the Event.

Reimplements: Rivet::AxesDefinition::project

function compare ##

inline virtual CmpState compare(
    const Projection & p
) const

Compare with other projections.

Reimplements: Rivet::AxesDefinition::compare

Updated on 2022-08-07 at 20:17:17 +0100