class Rivet::DISFinalState

Rivet::DISFinalState #

Final state particles boosted to the hadronic center of mass system. More…

#include <DISFinalState.hh>

Inherits from Rivet::FinalState, Rivet::ParticleFinder, Rivet::Projection, Rivet::ProjectionApplier

Public Types ##

Public Functions ##

Protected Functions ##

Additional inherited members ##

Public Functions inherited from Rivet::FinalState

Public Functions inherited from Rivet::ParticleFinder

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::DISFinalState;

Final state particles boosted to the hadronic center of mass system.

NB. The DIS scattered lepton is not included in the final state particles.

Public Types Documentation ##

typedef entity_type ##

typedef Particle Rivet::ParticleFinder::entity_type;

typedef collection_type ##

typedef Particles Rivet::ParticleFinder::collection_type;

enum BoostFrame ##

Type of DIS boost to apply.

Public Functions Documentation ##

function entities ##

inline const collection_type & entities() const

Template-usable interface common to JetAlg.

function DISFinalState ##

inline DISFinalState(
    const FinalState & fs,
    BoostFrame boosttype,
    const DISKinematics & kinematicsp =DISKinematics()
)

Constructor with explicit FinalState.

Deprecated:

The DISKinematics has no parameters, hence explicitly passing it as an arg shouldn’t be necessary.

function DISFinalState ##

inline DISFinalState(
    BoostFrame boosttype,
    const FinalState & fs =FinalState(),
    const DISKinematics & kinematicsp =DISKinematics()
)

Constructor with optional FinalState.

Deprecated:

The DISKinematics has no parameters, hence explicitly passing it as an arg shouldn’t be necessary.

function DISFinalState ##

inline DISFinalState(
    const Cut & c,
    BoostFrame boosttype,
    const DISKinematics & kinematicsp =DISKinematics()
)

Constructor with explicit cuts to define final-state particles.

Deprecated:

The DISKinematics has no parameters, hence explicitly passing it as an arg shouldn’t be necessary.

Note: The cuts will be applied before the boost, e.g. to express detector acceptance.

Todo: Add a second optional Cut argument for post-boost cuts.

function DISFinalState ##

inline DISFinalState(
    BoostFrame boosttype,
    const Cut & c,
    const DISKinematics & kinematicsp =DISKinematics()
)

Constructor with explicit cuts to define final-state particles.

Deprecated:

The DISKinematics has no parameters, hence explicitly passing it as an arg shouldn’t be necessary.

Note: The cuts will be applied before the boost, e.g. to express detector acceptance.

Todo: Add a second optional Cut argument for post-boost cuts.

function DISFinalState ##

inline DISFinalState(
    const DISKinematics & kinematicsp,
    BoostFrame boosttype
)

Backward-compatible constructor with default FinalState.

Deprecated:

Prefer a version that doesn’t need a DISKinematics argument

function DEFAULT_RIVET_PROJ_CLONE ##

DEFAULT_RIVET_PROJ_CLONE(
    DISFinalState 
)

Clone on the heap.

function kinematics ##

inline const DISKinematics & kinematics()

Get the associated DISKinematics (to avoid needing a separate projection)

function DEFAULT_RIVET_PROJ_CLONE ##

DEFAULT_RIVET_PROJ_CLONE(
    FinalState 
)

Clone on the heap.

function accept ##

virtual bool accept(
    const Particle & p
) const

Todo: Rename to _accept or acceptFinal?

Reimplemented by: Rivet::FinalPartons::accept

Decide if a particle is to be accepted or not.

function clone ##

virtual unique_ptr< Projection > clone() const =0

Clone on the heap.

Reimplements: Rivet::Beam::clone

Reimplemented by: Rivet::ALICE::PrimaryParticles::clone

function size ##

inline size_t size() const

Count the final-state particles.

function size ##

inline size_t size(
    const Cut & c
) const

Count the final-state particles after a Cut is applied.

function size ##

inline size_t size(
    const ParticleSelector & s
) const

Count the final-state particles after a selection functor is applied.

function empty ##

inline bool empty() const

Is this final state empty?

function empty ##

inline bool empty(
    const Cut & c
) const

Is this final state empty after a Cut is applied?

function empty ##

inline bool empty(
    const ParticleSelector & s
) const

Is this final state empty after a selection functor is applied?

function particles ##

inline virtual const Particles & particles() const

Get the particles in no particular order, with no cuts.

function particles ##

inline Particles particles(
    const Cut & c
) const

Get the particles with selection cuts.

Note: Returns a copy rather than a reference, due to the cuts.

function particles ##

inline Particles particles(
    const ParticleSelector & selector
) const

Get the particles with selection cuts via a functor.

Note: Returns a copy rather than a reference, due to the cuts.

function particles ##

inline Particles particles(
    const ParticleSorter & sorter,
    const Cut & c =Cuts::open()
) const

Note: Returns a copy rather than a reference, due to cuts and sorting.

Get the particles, ordered by supplied sorting function object

function particles ##

inline Particles particles(
    const Cut & c,
    const ParticleSorter & sorter
) const

Note: Returns a copy rather than a reference, due to cuts and sorting.

Get the particles, ordered by supplied sorting function object

function particles ##

inline Particles particles(
    const ParticleSelector & selector,
    const ParticleSorter & sorter
) const

Note: Returns a copy rather than a reference, due to cuts and sorting.

Get the particles, ordered by a sorting functor and filtered by a selection functor

function particles ##

inline Particles particles(
    const ParticleSorter & sorter,
    const ParticleSelector & selector
) const

Note: Returns a copy rather than a reference, due to cuts and sorting.

Get the particles, ordered by a sorting functor and filtered by a selection functor

function rawParticles ##

inline Particles rawParticles() const

Note: Raw particles are the final-state constituents, as opposed to potentially composite particles returned as the finder’s particles()

Get the raw particles in no particular order, with no cuts

function particlesByPt ##

inline Particles particlesByPt(
    const Cut & c =Cuts::open()
) const

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).

function particlesByPt ##

inline Particles particlesByPt(
    const ParticleSelector & selector
) const

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).

function particlesByPt ##

inline Particles particlesByPt(
    double ptmin
) const

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).

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.

Protected Functions Documentation ##

function project ##

virtual void project(
    const Event & e
)

Apply the projection on the supplied event.

Reimplements: Rivet::FinalState::project

function compare ##

inline virtual CmpState compare(
    const Projection & p
) const

Compare projections.

Reimplements: Rivet::FinalPartons::compare

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

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