class Rivet::JetShape

Rivet::JetShape #

Calculate transverse jet profiles. More…

#include <JetShape.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::JetShape;

Calculate transverse jet profiles.

Calculate the differential and integral jet shapes in (P_{\perp}) for a given set of jets. This particular jet shape projection calculates jet shapes relative to jet centroids, using only the particles associated to each jet, for the hardest ( n ) jets.

The rapidity scheme ( ( \eta ) or ( y )) has to be specified when invoking the constructor.

The differential jet shape around a given jet axis at distance interval ( r \pm \delta{r}/2 ) is defined as [ \rho(r) = \frac{1}{\delta r} \frac{1}{N_\mathrm{jets}} \sum_\mathrm{jets} \frac{P_\perp(r - \delta r/2, r+\delta r/2)}{p_\perp(0, R)} ] with ( 0 \le r \le R ) and ( P_\perp(r_1, r_2) = \sum_{\in [r_1, r_2)} p_\perp ).

The integral jet shape around a given jet axes until distance ( r ) is defined as [ \Psi(r) = \frac{1}{N_\mathrm{jets}} \sum_\mathrm{jets} \frac{P_\perp(0, r)}{p_\perp(0, R)} ] with ( 0 \le r \le R ) and ( P_\perp(r_1, r_2) = \sum_{\in [r_1, r_2)} p_\perp ).

The constructor expects also the binning in radius ( r ) to be supplied.

Public Functions Documentation ##

function JetShape ##

JetShape(
    const JetAlg & jetalg,
    double rmin,
    double rmax,
    size_t nbins,
    double ptmin =0,
    double ptmax =DBL_MAX,
    double absrapmin =-DBL_MAX,
    double absrapmax =-DBL_MAX,
    RapScheme rapscheme =RAPIDITY
)

Constructor from histo range and number of bins.

function JetShape ##

JetShape(
    const JetAlg & jetalg,
    vector< double > binedges,
    double ptmin =0,
    double ptmax =DBL_MAX,
    double absrapmin =-DBL_MAX,
    double absrapmax =-DBL_MAX,
    RapScheme rapscheme =RAPIDITY
)

Constructor from vector of bin edges.

function DEFAULT_RIVET_PROJ_CLONE ##

DEFAULT_RIVET_PROJ_CLONE(
    JetShape 
)

Clone on the heap.

function clear ##

void clear()

Reset projection between events.

function calc ##

void calc(
    const Jets & jets
)

Do the calculation directly on a supplied collection of Jet objects.

function numBins ##

inline size_t numBins() const

Number of equidistant radius bins.

function numJets ##

inline size_t numJets() const

Number of jets which passed cuts.

function rMin ##

inline double rMin() const

( r_\text{min} ) value.

function rMax ##

inline double rMax() const

( r_\text{max} ) value.

function ptMin ##

inline double ptMin() const

( p_\perp^\text{min} ) value.

function ptMax ##

inline double ptMax() const

( p_\perp^\text{max} ) value.

function rBinMin ##

inline double rBinMin(
    size_t rbin
) const

Central ( r ) value for bin rbin.

function rBinMax ##

inline double rBinMax(
    size_t rbin
) const

Central ( r ) value for bin rbin.

function rBinMid ##

inline double rBinMid(
    size_t rbin
) const

Central ( r ) value for bin rbin.

function diffJetShape ##

inline double diffJetShape(
    size_t ijet,
    size_t rbin
) const

Return value of differential jet shape profile histo bin.

function intJetShape ##

inline double intJetShape(
    size_t ijet,
    size_t rbin
) const

Return value of integrated jet shape profile histo bin.

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.

Protected Functions Documentation ##

function project ##

virtual void project(
    const Event & e
)

Apply the projection to the event.

Todo: Provide int and diff jet shapes with some sort of area normalisation?

Reimplements: Rivet::AxesDefinition::project

function compare ##

virtual CmpState compare(
    const Projection & p
) const

Compare projections.

Reimplements: Rivet::AxesDefinition::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:17 +0100