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 filter to PseudoJet pj in-place.
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 filter to container of PseudoJet pjs in-place.
template<typename T, typename U, typename... Args>
std::map< T, U > &	Rivet::ifilterPseudoJets (std::map< T, U > &pjMap, Args &&... args)
	Apply a FastJet::Filter to map pjMap in-place.
PseudoJet	Rivet::filterPseudoJets (const PseudoJet &pj, const fastjet::Filter &filter)
	Apply given FastJet::Filter param filter to PseudoJet pj out-of-place.
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 filter to container of PseudoJet pjs out-of-place.
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 filter to map pjMap out-of-place.

Detailed Description

Function Documentation

filterPseudoJets() [1/2]

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 filter to container of PseudoJet pjs out-of-place.

Note

Sorts by optional param sortFunc, default is sorting by (descending) pT

References ifilterPseudoJets().

filterPseudoJets() [2/2]

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 filter to map pjMap out-of-place.

Note

Sorts by optional param 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 filter to container of PseudoJet pjs in-place.

Parameters

pjs	PseudoJets to filter
filter	Filtering functor
sortFunc	Sorting functor applied to output collection

Note

Sorts output by optional param 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 filter to PseudoJet pj in-place.

Parameters

pj	PseudoJet to filter
filter	filtering functor

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 a FastJet::Filter to map pjMap in-place.

Todo

DOCUMENT PROPERLY

References ifilterPseudoJets().