Unbound functions for filtering jets

Functions
Jets &	Rivet::iselect (Jets &jets, const Cut &c)
	Filter a jet collection in-place to the subset that passes the supplied Cut.
Jets	Rivet::select (const Jets &jets, const Cut &c)
	Filter a jet collection in-place to the subset that passes the supplied Cut.
Jets	Rivet::select (const Jets &jets, const Cut &c, Jets &out)
	Filter a jet collection in-place to the subset that passes the supplied Cut.
Jets &	Rivet::idiscard (Jets &jets, const Cut &c)
	Filter a jet collection in-place to the subset that fails the supplied Cut.
Jets	Rivet::discard (const Jets &jets, const Cut &c)
	Filter a jet collection in-place to the subset that fails the supplied Cut.
Jets	Rivet::discard (const Jets &jets, const Cut &c, Jets &out)
	Filter a jet collection in-place to the subset that fails the supplied Cut.
PseudoJet &	Rivet::ifilterPseudoJets (PseudoJet &pj, const fastjet::Filter &filter)
	Apply given FastJet::Filter.
template<typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, PseudoJet >>
CONTAINER &	Rivet::ifilterPseudoJets (CONTAINER &pjs, const fastjet::Filter &filter, const JetSorter &sortFunc=cmpMomByPt)
	Apply given FastJet::Filter.
template<typename T, typename U, typename... Args>
std::map< T, U > &	Rivet::ifilterPseudoJets (std::map< T, U > &pjMap, Args &&... args)
	Apply given FastJet::Filter.
PseudoJet	Rivet::filterPseudoJets (const PseudoJet &pj, const fastjet::Filter &filter)
	Apply given FastJet::Filter.
template<typename... Args, typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, PseudoJet >>
CONTAINER	Rivet::filterPseudoJets (const CONTAINER &pjs, Args &&... args)
	Apply given FastJet::Filter.
template<typename T, typename U, typename... Args>
std::map< T, U >	Rivet::filterPseudoJets (const std::map< T, U > &pjMap, Args &&... args)
	Apply given FastJet::Filter.

Detailed Description

Function Documentation

filterPseudoJets() [1/3]

template<typename... Args, typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, PseudoJet >>

CONTAINER Rivet::filterPseudoJets	(	const CONTAINER &	pjs,
		Args &&...	args )

Apply given FastJet::Filter.

Parameters

filter	to container of PseudoJet
pjs	out-of-place

Note

Sorts by optional

Parameters

sortFunc,default

is sorting by (descending) pT

References ifilterPseudoJets().

filterPseudoJets() [2/3]

PseudoJet Rivet::filterPseudoJets ( const PseudoJet & pj, const fastjet::Filter & filter )

inline

Apply given FastJet::Filter.

Parameters

filter	to PseudoJet
pj	out-of-place

References ifilterPseudoJets().

filterPseudoJets() [3/3]

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

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

Apply given FastJet::Filter.

Parameters

filter	to map
pjMap	out-of-place

Note

Sorts by optional

Parameters

sortFunc,default

is sorting by (descending) pT

References ifilterPseudoJets().

ifilterPseudoJets() [1/3]

template<typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, PseudoJet >>

CONTAINER & Rivet::ifilterPseudoJets	(	CONTAINER &	pjs,
		const fastjet::Filter &	filter,
		const JetSorter &	sortFunc = cmpMomByPt )

Apply given FastJet::Filter.

Parameters

filter	to container of PseudoJet
pjs	in-place

Note

Sorts by optional

Parameters

sortFunc,default

is sorting by (descending) pT

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

ifilterPseudoJets() [2/3]

PseudoJet & Rivet::ifilterPseudoJets	(	PseudoJet &	pj,
		const fastjet::Filter &	filter )

Apply given FastJet::Filter.

Parameters

filter	to PseudoJet
pj	in-place

Note

Can be any kind of filtering/ grooming algorithm, e.g. trimming.

Referenced by filterPseudoJets(), filterPseudoJets(), filterPseudoJets(), ifilterPseudoJets(), ifilterPseudoJets(), and Rivet::FastJets::reclusterJets().

ifilterPseudoJets() [3/3]

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

std::map< T, U > & Rivet::ifilterPseudoJets	(	std::map< T, U > &	pjMap,
		Args &&...	args )

Apply given FastJet::Filter.

Parameters

filter	to map
pjMap	in-place

Note

Sorts by optional

Parameters

sortFunc,default

is sorting by (descending) pT

References ifilterPseudoJets().