Rivet API documentation

Rivet 4.1.3

Typedefs
typedef std::pair< PseudoJets, Particles >	Rivet::FastJets::PJetsParts

Functions
template<typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
static CONTAINER	Rivet::FastJets::reclusterJets (const CONTAINER &jetsIn, const fastjet::JetDefinition &jDef)
	Recluster Rivet::Jets.
template<typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
static CONTAINER	Rivet::FastJets::reclusterJets (const CONTAINER &jetsIn, const fastjet::JetDefinition &jDef, const fastjet::Filter &filter)
	Recluster Rivet::Jets.
template<typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
static CONTAINER	Rivet::FastJets::reclusterJets (const CONTAINER &jetsIn, const FJPluginPtr &jetAlg)
	Apply the.
template<typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
static CONTAINER	Rivet::FastJets::reclusterJets (const CONTAINER &jetsIn, const FJPluginPtr &jetAlg, const fastjet::Filter &filter)
	Apply the.
template<JetAlg JETALG, typename... Args, typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
static CONTAINER	Rivet::FastJets::reclusterJets (const CONTAINER &jetsIn, Args &&... args)
	Apply the `JETALG` (given as an template-enum JetAlg and arbitrary param `args`...) to the given `jetsIn` jet collection.
template<JetAlg JETALG, typename... Args, typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>
static CONTAINER	Rivet::FastJets::reclusterJets (const CONTAINER &jetsIn, const fastjet::Filter &filter, Args &&... args)
	Apply the `JETALG` (given as an template-enum JetAlg and arbitrary param `args`...) to the given `jetsIn` jet collection.
template<typename T, typename U, typename... Args>
static std::map< T, U >	Rivet::FastJets::reclusterJets (const std::map< T, U > &jetsMap, Args &&... args)
	Apply the `args`... to the given param `jetsMap` map of jets.
template<JetAlg JETALG, typename T, typename U, typename... Args>
static std::map< T, U >	Rivet::FastJets::reclusterJets (const std::map< T, U > &jetsMap, Args &&... args)
	Apply the `JETALG` (given as an template-enum JetAlg and arbitrary param `args`...) to the given `jetsMap` map of jets.

Detailed Description

Function Documentation

◆ reclusterJets() [1/8]

template<JetAlg JETALG, typename... Args, typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>

CONTAINER Rivet::FastJets::reclusterJets	(	const CONTAINER &	jetsIn,
		Args &&...	args )

inlinestatic

Apply the JETALG (given as an template-enum JetAlg and arbitrary param args...) to the given jetsIn jet collection.

Parameters

jetsIn	Collection of jets to recluster
args	Extra arguments to the reclustering algorithm

Returns: jet collection with FastJet jet algorithm applied

References mkJetDef(), mkPlugin(), and reclusterJets().

◆ reclusterJets() [2/8]

template<JetAlg JETALG, typename... Args, typename CONTAINER, typename = std::enable_if_t< is_citerable_v<CONTAINER>, Jet >>

CONTAINER Rivet::FastJets::reclusterJets	(	const CONTAINER &	jetsIn,
		const fastjet::Filter &	filter,
		Args &&...	args )

inlinestatic

Apply the JETALG (given as an template-enum JetAlg and arbitrary param args...) to the given jetsIn jet collection.

Parameters

jetsIn	Collection of jets to recluster
args	Extra arguments to the reclustering algorithm
filter	a FastJet::Filter to be applied before re-assigning the tags Needed as separate function because FastJet doesn't grant us any easy initialisation check for filters

Returns: jet collection with FastJet jet algorithm applied

References mkJetDef(), mkPlugin(), and reclusterJets().

◆ reclusterJets() [3/8]

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

CONTAINER Rivet::FastJets::reclusterJets	(	const CONTAINER &	jetsIn,
		const fastjet::JetDefinition &	jDef )

inlinestatic

Recluster Rivet::Jets.

Parameters

jetsIn	according to fastjet::JetDefinition
jDef

Returns: jet collection with FastJet jet algorithm applied

Note: forwards the particles and tags of the original jets to the reclustered jets, i.e. R=0.8 jets reclustered from R=0.4 jets will still have the particles/tags of the R=0.4 jets as constituents, not the R=0.4 jets themselves as constituents. This means that the number of constituents (omitting the filter) is preserved; Returned jets are sorted by (descending) pT

References mkTaggedJets(), and reclusterJetsParts().

Referenced by Rivet::Analysis::reclusterJets(), reclusterJets(), reclusterJets(), reclusterJets(), reclusterJets(), and reclusterJets().

◆ reclusterJets() [4/8]

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

CONTAINER Rivet::FastJets::reclusterJets	(	const CONTAINER &	jetsIn,
		const fastjet::JetDefinition &	jDef,
		const fastjet::Filter &	filter )

inlinestatic

Recluster Rivet::Jets.

Parameters

jetsIn	according to fastjet::JetDefinition
jDef

Returns: jet collection with FastJet jet algorithm applied

Parameters

filter a FastJet::Filter to be applied before re-assigning the tags Needed as separate function because FastJet doesn't grant us any easy initialisation check for filters

Note: Returned jets are sorted by (descending) pT

References Rivet::ifilterPseudoJets(), mkTaggedJets(), and reclusterJetsParts().

◆ reclusterJets() [5/8]

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

CONTAINER Rivet::FastJets::reclusterJets	(	const CONTAINER &	jetsIn,
		const FJPluginPtr &	jetAlg )

inlinestatic

Apply the.

Parameters

jetAlg	(given as shared pointer to JetDefinition::Plugin) to the given
jetsIn	jet collection.

Returns: jet collection with FastJet jet algorithm applied

References reclusterJets().

◆ reclusterJets() [6/8]

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

CONTAINER Rivet::FastJets::reclusterJets	(	const CONTAINER &	jetsIn,
		const FJPluginPtr &	jetAlg,
		const fastjet::Filter &	filter )

inlinestatic

Apply the.

Parameters

jetAlg	(given as shared pointer to JetDefinition::Plugin) to the given
jetsIn	jet collection.

Returns: jet collection with FastJet jet algorithm applied

Parameters

filter a FastJet::Filter to be applied before re-assigning the tags Needed as separate function because FastJet doesn't grant us any easy initialisation check for filters

References reclusterJets().

◆ reclusterJets() [7/8]

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

std::map< T, U > Rivet::FastJets::reclusterJets	(	const std::map< T, U > &	jetsMap,
		Args &&...	args )

inlinestatic

Apply the JETALG (given as an template-enum JetAlg and arbitrary param args...) to the given jetsMap map of jets.

Parameters

jetsMap	Collection of jets to recluster
args	Extra arguments to the reclustering algorithm

Returns: map of jets with FastJet jet algorithm applied

References reclusterJets().

◆ reclusterJets() [8/8]

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

std::map< T, U > Rivet::FastJets::reclusterJets	(	const std::map< T, U > &	jetsMap,
		Args &&...	args )

inlinestatic

Apply the args... to the given param jetsMap map of jets.

Parameters

jetsMap	Collection of jets to recluster
args	Extra arguments to the reclustering algorithm

Returns: map of jets with FastJet jet algorithm applied

References reclusterJets().

Rivet API documentation

Typedefs

Functions

Detailed Description

Function Documentation

◆ reclusterJets() [1/8]

◆ reclusterJets() [2/8]

◆ reclusterJets() [3/8]

◆ reclusterJets() [4/8]

◆ reclusterJets() [5/8]

◆ reclusterJets() [6/8]

◆ reclusterJets() [7/8]

◆ reclusterJets() [8/8]