group Generic jet filtering, efficiency and smearing utils

Generic jet filtering, efficiency and smearing utils #

Module: Detector smearing & efficiency functions

Classes ##

Types ##

Functions ##

Types Documentation ##

typedef JetSmearFn ##

typedef function<Jet(const Jet&)> Rivet::JetSmearFn;

Typedef for Jet smearing functions/functors.

typedef JetEffFn ##

typedef function<double(const Jet&)> Rivet::JetEffFn;

Typedef for Jet efficiency functions/functors.

using jetEffFilter ##

using Rivet::jetEffFilter = typedef JetEffFilter;

typedef ParticleSmearFn ##

typedef function<Particle(const Particle&)> Rivet::ParticleSmearFn;

Typedef for Particle smearing functions/functors.

typedef ParticleEffFn ##

typedef function<double(const Particle&)> Rivet::ParticleEffFn;

Typedef for Particle efficiency functions/functors.

using particleEffFilter ##

using Rivet::particleEffFilter = typedef ParticleEffFilter;

Functions Documentation ##

function JET_EFF_ZERO ##

inline double JET_EFF_ZERO(
    const Jet & p
)

Take a jet and return a constant 0.

function JET_EFF_0 ##

inline double JET_EFF_0(
    const Jet & p
)

Alias for JET_EFF_ZERO.

function JET_FN0 ##

inline double JET_FN0(
    const Jet & p
)

Alias for JET_EFF_ZERO.

function JET_EFF_ONE ##

inline double JET_EFF_ONE(
    const Jet & p
)

Take a jet and return a constant 1.

function JET_EFF_1 ##

inline double JET_EFF_1(
    const Jet & p
)

Alias for JET_EFF_ONE.

function JET_EFF_PERFECT ##

inline double JET_EFF_PERFECT(
    const Jet & 
)

Alias for JET_EFF_ONE.

function JET_FN1 ##

inline double JET_FN1(
    const Jet & 
)

Alias for JET_EFF_ONE.

function JET_BTAG_PERFECT ##

inline double JET_BTAG_PERFECT(
    const Jet & j
)

Return 1 if the given Jet contains a b, otherwise 0.

Todo: Need to be able to pass a tag pT threshold? -> functor struct

function JET_CTAG_PERFECT ##

inline double JET_CTAG_PERFECT(
    const Jet & j
)

Return 1 if the given Jet contains a c, otherwise 0.

Todo: Need to be able to pass a tag pT threshold? -> functor struct

function JET_TAUTAG_PERFECT ##

inline double JET_TAUTAG_PERFECT(
    const Jet & j
)

Return 1 if the given Jet contains a c, otherwise 0.

Todo: Need to be able to pass a tag pT threshold? -> functor struct

function JET_SMEAR_IDENTITY ##

inline Jet JET_SMEAR_IDENTITY(
    const Jet & j
)

Todo: Modify constituent particle vectors for consistency

Set a null PseudoJet if the Jet is smeared?

Take a jet and return an unmodified copy

function JET_SMEAR_PERFECT ##

inline Jet JET_SMEAR_PERFECT(
    const Jet & j
)

Alias for JET_SMEAR_IDENTITY.

function efffilt ##

template <typename FN >
inline bool efffilt(
    const Jet & j,
    FN & feff
)

Return true if Jetj is chosen to survive a random efficiency selection.

function PARTICLE_EFF_ZERO ##

inline double PARTICLE_EFF_ZERO(
    const Particle & 
)

Take a Particle and return 0.

function PARTICLE_EFF_0 ##

inline double PARTICLE_EFF_0(
    const Particle & 
)

Alias for PARTICLE_EFF_ZERO.

function PARTICLE_FN0 ##

inline double PARTICLE_FN0(
    const Particle & 
)

Alias for PARTICLE_EFF_ZERO.

function PARTICLE_EFF_ONE ##

inline double PARTICLE_EFF_ONE(
    const Particle & 
)

Take a Particle and return 1.

function PARTICLE_EFF_1 ##

inline double PARTICLE_EFF_1(
    const Particle & 
)

Alias for PARTICLE_EFF_ONE.

function PARTICLE_EFF_PERFECT ##

inline double PARTICLE_EFF_PERFECT(
    const Particle & 
)

Alias for PARTICLE_EFF_ONE.

function PARTICLE_FN1 ##

inline double PARTICLE_FN1(
    const Particle & 
)

Alias for PARTICLE_EFF_ONE.

function PARTICLE_SMEAR_IDENTITY ##

inline Particle PARTICLE_SMEAR_IDENTITY(
    const Particle & p
)

Take a Particle and return it unmodified.

function PARTICLE_SMEAR_PERFECT ##

inline Particle PARTICLE_SMEAR_PERFECT(
    const Particle & p
)

Alias for PARTICLE_SMEAR_IDENTITY.

function efffilt ##

inline bool efffilt(
    const Particle & p,
    const ParticleEffFn & feff
)

Return true if Particlep is chosen to survive a random efficiency selection.

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