Rivet API documentation

Rivet 4.1.3
Trimming operations for Rivet::Jets

Functions

JetRivet::itrimJetsFrac (Jet &jet, const double frac)
 Trim subjets with insufficient pT fraction.
template<typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
CONTAINER & Rivet::itrimJetsFrac (CONTAINER &jets, const double frac, const JetSorter &sortFunc=cmpMomByPt)
 Trim subjets with insufficient pT fraction.
template<typename T, typename U>
std::map< T, U > & Rivet::itrimJetsFrac (std::map< T, U > &jetMap, const double frac, const JetSorter &sortFunc=cmpMomByPt)
Jet Rivet::trimJetsFrac (const Jet &jet, double frac)
 Trim subjets with insufficient pT fraction.
template<typename... Args, typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
CONTAINER Rivet::trimJetsFrac (const CONTAINER &jets, Args &&... args)
 Trim subjets with insufficient pT fraction.
template<typename T, typename U, typename... Args>
std::map< T, U > Rivet::trimJetsFrac (const std::map< T, U > &jetMap, Args &&... args)

Detailed Description

Function Documentation

◆ itrimJetsFrac() [1/2]

template<typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
CONTAINER & Rivet::itrimJetsFrac ( CONTAINER & jets,
const double frac,
const JetSorter & sortFunc = cmpMomByPt )

Trim subjets with insufficient pT fraction.

Parameters
frac
Note
Sorts by optional
Parameters
sortFunc,defaultis sorting by (descending) pT
Note
Works on (almost) arbritrary containers of Jet

TODO: Does not work on set<Jet> because of const restrictions of set. Fix if necessary.

References cmpMomByPt(), isortBy(), and itrimJetsFrac().

◆ itrimJetsFrac() [2/2]

Jet & Rivet::itrimJetsFrac ( Jet & jet,
const double frac )

Trim subjets with insufficient pT fraction.

Removes subjet constituents of pT less than

Parameters
frac*(jetpt)in-place.
Note
Mainly useful for reclustered jets.
Warning
Keeps all tags(), which might be incorrect, depending on use case. TODO: Fix this behaviour if necessary.

Referenced by itrimJetsFrac(), trimJetsFrac(), and trimJetsFrac().

◆ trimJetsFrac() [1/2]

template<typename... Args, typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
CONTAINER Rivet::trimJetsFrac ( const CONTAINER & jets,
Args &&... args )

Trim subjets with insufficient pT fraction.

Note
Sorts by optional
Parameters
sortFunc,defaultis sorting by (descending) pT
Note
Works on (almost) arbritrary containers of Jet

TODO: Does not work on set<Jet> because of const restrictions of set. Fix if necessary.

References itrimJetsFrac().

◆ trimJetsFrac() [2/2]

Jet Rivet::trimJetsFrac ( const Jet & jet,
double frac )
inline

Trim subjets with insufficient pT fraction.

Removes subjet constituents of pT less than

Parameters
frac*(jetpt)out-of-place.
Note
Mainly useful for reclustered jets.
Warning
Keeps all tags(), which might be incorrect, depending on use case. TODO: Fix this behaviour if necessary.

References itrimJetsFrac().