Trimming operations for Rivet::Jets

Functions
Jet &	Rivet::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 frac over a whole jet collection.
template<typename T, typename U>
std::map< T, U > &	Rivet::itrimJetsFrac (std::map< T, U > &jetMap, const double frac, const JetSorter &sortFunc=cmpMomByPt)
	Trim subjets with insufficient pT fraction frac over a whole jet collection.
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 on a whole jet collection.
template<typename T, typename U, typename... Args>
std::map< T, U >	Rivet::trimJetsFrac (const std::map< T, U > &jetMap, Args &&... args)
	Trim subjets with insufficient pT fraction on a whole jet collection.

Detailed Description

Function Documentation

itrimJetsFrac() [1/3]

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 frac over a whole jet collection.

Sorts by optional param sortFunc, default is sorting by (descending) pT. Works on (almost) arbitrary unkeyed containers of Jet.

Parameters

jets	Jet collection to trim
frac	Required momentum fraction to keep
sortFunc	Sorting functor to apply after

Todo

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

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

itrimJetsFrac() [2/3]

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

Trim subjets with insufficient pT fraction.

Removes subjet constituents of pT less than frac*(jetpt) in-place.

Parameters

jet	Jet to trim
frac	Required momentum fraction to keep

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(), itrimJetsFrac(), trimJetsFrac(), trimJetsFrac(), and trimJetsFrac().

itrimJetsFrac() [3/3]

template<typename T, typename U>

std::map< T, U > & Rivet::itrimJetsFrac	(	std::map< T, U > &	jetMap,
		const double	frac,
		const JetSorter &	sortFunc = cmpMomByPt )

Trim subjets with insufficient pT fraction frac over a whole jet collection.

Sorts by optional param sortFunc, default is sorting by (descending) pT. Works on (almost) arbitrary unkeyed containers of Jet.

Parameters

jetMap	Jet collection to trim
frac	Required momentum fraction to keep
sortFunc	Sorting functor to apply after

Todo

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

References cmpMomByPt(), and itrimJetsFrac().

trimJetsFrac() [1/3]

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 on a whole jet collection.

Sorts by optional param sortFunc, default is sorting by (descending) pT. Works on (almost) arbritrary containers of Jet.

Parameters

jets	Jet collection to trim
args	Additional args to forward to the in-place function

Todo

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

References itrimJetsFrac().

trimJetsFrac() [2/3]

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

inline

Trim subjets with insufficient pT fraction.

Removes subjet constituents of pT less than param frac*(jetpt) out-of-place. Mainly useful for reclustered jets.

Parameters

jet	Jet to trim
frac	Required momentum fraction to keep

Warning

Keeps all tags(), which might be incorrect, depending on use case.

Todo

Fix this behaviour if necessary.

References itrimJetsFrac().

trimJetsFrac() [3/3]

template<typename T, typename U, typename... Args>

std::map< T, U > Rivet::trimJetsFrac	(	const std::map< T, U > &	jetMap,
		Args &&...	args )

Trim subjets with insufficient pT fraction on a whole jet collection.

Sorts by optional param sortFunc, default is sorting by (descending) pT. Works on (almost) arbritrary containers of Jet.

Parameters

jetMap	Jet collection to trim
args	Additional args to forward to the in-place function

Todo

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

References itrimJetsFrac().