Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

NRivet
NALICE
CV0Multiplicity
CCLMultiplicity
CV0Trigger
CV0AndTrigger	Trigger projection for the ALICE V0-AND (a.k.a. CINT7) requirement
CPrimaryParticles	Standard ALICE primary particle definition
NATLAS	Common projections for ATLAS trigger conditions and centrality
CSumET_PB_Centrality	Centrality projection for pPb collisions (one sided)
CSumET_PBPB_Centrality	Centrality projection for PbPb collisions (two sided)
CMinBiasTrigger	ATLAS min bias trigger conditions
CMC_SumETFwdPbCentrality
CMC_pPbMinBiasTrigger
CMC_JETS_BASE	Base class providing common functionality for MC jet validation analyses
CMC_KTSPLITTINGS_BASE	Base class providing common functionality for MC jet-structure validation analyses
CMC_PARTICLES_BASE	Base class providing common functionality for MC particle species validation analyses
CAnalysis	This is the base class of all analysis classes in Rivet
CAnalysisHandler	The key class for coordination of Analysis objects and the event loop
CAnalysisInfo	Holder of analysis metadata
CAnalysisLoader	Internal class which loads and registers analyses from plugin libs
CDressedLepton	A charged lepton meta-particle created by clustering photons close to the bare lepton
CEvent	Representation of a HepMC event, and enabler of Projection caching
CJets	Specialised vector of Jet objects
CJet	Representation of a clustered jet of particles
CLorentzTransform	Object implementing Lorentz transform calculations and boosts
CMatrix3	Specialisation of MatrixN to aid 3 dimensional rotations
CMatrix	General \( N \)-dimensional mathematical matrix object
CVector2	Two-dimensional specialisation of Vector
CVector3	Three-dimensional specialisation of Vector
CThreeMomentum	Specialized version of the ThreeVector with momentum functionality
CFourVector	Specialisation of VectorN to a general (non-momentum) Lorentz 4-vector
CFourMomentum	Specialized version of the FourVector with momentum/energy functionality
CVector	A minimal base class for \( N \)-dimensional vectors
CParticles	Specialised vector of Particle objects
CParticle	Particle representation, either from a HepMC::GenEvent or reconstructed
CParticleBase	Base class for particle-like things like Particle and Jet
CProjection	Base class for all Rivet projections
CProjectionApplier	Common base class for Projection and Analysis, used for internal polymorphism
CProjectionHandler	The projection handler is a central repository for projections to be used in a Rivet analysis run
CAxesDefinition	Base class for projections which define a spatial basis
CBeam	Project out the incoming beams
CBeamThrust	Calculator of the beam-thrust observable
CCentralEtHCM	Summed \( E_\perp \) of central particles in HCM system
CCentralityProjection	Used together with the percentile-based analysis objects Percentile and PercentileXaxis
CChargedFinalState	Project only charged final state particles
CChargedLeptons	Get charged final-state leptons
CConstRandomFilter	Functor used to implement constant random lossiness
CConstLossyFinalState	Randomly lose a constant fraction of particles
CDecayedParticles	Find the decay products of particles in the projection for subsquent analyses
CDileptonFinder	Convenience finder of leptonically decaying Zs
CDISDiffHadron	Get the incoming and outgoing hadron in a diffractive ep event
CDISFinalState	Final state particles boosted to the hadronic center of mass system
CDISKinematics	Get the DIS kinematic variables and relevant boosts for an event
CDISLepton	Get the incoming and outgoing leptons in a DIS event
CDISRapidityGap	Get the incoming and outgoing hadron in a diffractive ep event
CEventMixingBase
CEventMixingFinalState	EventMixingFinalState has multiplicity as the mixing observable
CEventMixingCentrality	EventMixingCentrality has centrality as the mixing observable
CFastJets	Find jets using jet algorithms via the FastJet package
CmapJetAlg2Plugin
CmapJetAlg2Plugin< JetAlg::SISCONE, X >	Populate "map"
CmapJetAlg2Plugin< JetAlg::PXCONE, X >
CmapJetAlg2Plugin< JetAlg::CDFJETCLU, X >
CmapJetAlg2Plugin< JetAlg::CDFMIDPOINT, X >
CmapJetAlg2Plugin< JetAlg::D0ILCONE, X >
CmapJetAlg2Plugin< JetAlg::JADE, X >
CmapJetAlg2Plugin< JetAlg::TRACKJET, X >
CmapJetAlg2Plugin< JetAlg::VARIABLER, X >
CFinalPartons
CFinalState	Project out all final-state particles in an event. Probably the most important projection in Rivet!
CFParameter	Calculator of the \( F \)-parameter observable
CGammaGammaFinalState	Final state particles boosted to the hadronic center of mass system
CGammaGammaKinematics	Get the gamma gamma kinematic variables and relevant boosts for an event
CGammaGammaLeptons	Get the incoming and outgoing leptons in a gamma gamma collision event in e+e-
CGeneratedPercentileProjection
CHadronicFinalState	Project only hadronic final state particles
CHeavyHadrons	Project out the last pre-decay b and c hadrons
CHemispheres	Calculate the hemisphere masses and broadenings
CHepMCHeavyIon
CIdentifiedFinalState	Produce a final state which only contains specified particle IDs
CImpactParameterProjection
CInitialQuarks	Project out quarks from the hard process in \( e^+ e^- \to Z^0 \) events
CInvisibleFinalState	Final state modifier excluding particles which are experimentally visible
CInvMassFinalState	Identify particles which can be paired to fit within a given invariant mass window
CJetScheme	Convenience container of params for simple jet definitions
CJetFinder	Abstract base class for projections which can return a set of Jets
CJetShape	Calculate transverse jet profiles
CLeadingParticlesFinalState	Get the highest-pT occurrences of FS particles with the specified PDG IDs
CLeptonFinder	Reconstruct leptons, generally including "dressing" with clustered photons
CLossyFinalState	Templated FS projection which can lose some of the supplied particles
CMergedFinalState	Get final state particles merged from two FinalState projections
CMETFinder	Interface for projections that find missing transverse energy/momentum
CMissingMomentum	Calculate missing \( E \), \( E_\perp \) etc. as complements to the total visible momentum
CNeutralFinalState	Project only neutral final state particles
CNonHadronicFinalState	Project only hadronic final state particles
CNonPromptFinalState	Find final state particles NOT directly connected to the hard process
CParisiTensor	Calculate the Parisi event shape tensor (or linear momentum tensor)
CParticleFinder	Base class for projections which return subsets of an event's particles
CPartonicTops	Convenience finder of partonic top quarks
CPercentileProjection	Class for projections that reports the percentile for a given SingleValueProjection when initialized with a Histo1D of the distribution in the SingleValueProjection
CPrimaryHadrons	Project out the first hadrons from hadronisation
CPrimaryParticles	Project out primary particles according to definition
CPromptFinalState	Find final state particles directly connected to the hard process
CSTAR_BES_Centrality
CBRAHMSCentrality	BRAHMS Centrality projection
CSingleValueProjection	Base class for projections returning a single floating point value
CSmearedJets	Wrapper projection for smearing Jets with detector resolutions and efficiencies
CSmearedMET	Wrapper projection for smearing missing (transverse) energy/momentum with detector resolutions
CSmearedParticles	Wrapper projection for smearing Jets with detector resolutions and efficiencies
CSphericity	Calculate the sphericity event shape
CSpherocity	Get the transverse spherocity scalars for hadron-colliders
CTauFinder	Convenience finder of unstable taus
CThrust	Get the e+ e- thrust basis and the thrust, thrust major and thrust minor scalars
CTriggerCDFRun0Run1	Access to the min bias triggers used by CDF in Run 0 and Run 1
CTriggerCDFRun2	Access to the min bias triggers used by CDF in Run 0 and Run 1
CTriggerProjection	Base class for projections returning a bool corresponding to a trigger
CTriggerUA5	Access to the min bias triggers used by UA5
CUndressBeamLeptons	Incoming lepton beams with collinear photons subtracted
CUnstableParticles	Project out all physical-but-decayed particles in an event
CUserCentEstimate
CVetoedFinalState	FS modifier to exclude classes of particles from the final state
CVisibleFinalState	Final state modifier excluding particles which are not experimentally visible
CRun	Interface to handle a run of events read from a HepMC stream or file
CSimpleAnalysis	Simplified analysis API with predefined physics objects
CCentralityEstimator	Base class for projections profile observable value vs the collision centrality
CCentralityBinner
CGeneratedCentrality
CCorrelators	Projection for calculating correlators for flow measurements
CCumulantAnalysis	Tools for flow analyses
CECorrelator	A helper class to calculate all event averages of correlators
CCutflow	A tracker of numbers & fractions of events passing sequential cuts
CFillCollector< Cutflow >	FillCollector specialisation for all Cutflow-like AO
CCutflows	A container for several Cutflow objects, with some convenient batch access
CError	Generic runtime Rivet error
CRangeError	Error for e.g. use of invalid bin ranges
CLogicError	Error specialisation for places where alg logic has failed
CPidError	Error specialisation for failures relating to particle ID codes
CInfoError	Error specialisation for failures relating to analysis info
CBeamError	Error specialisation for failures relating to beams
CSmearError	Error specialisation for failures relating to event smearing
CWeightError	Errors relating to event/bin weights
CUserError	Error specialisation for where the problem is between the chair and the computer
CLookupError	Error relating to looking up analysis objects in the register
CDataError	Error relating to provided data mismatching expectations
CIOError	Error for I/O failures
CReadError	Error for read failures
CWriteError	Error for write failures
CATLAS_RUN2_EMTOPO_PT_RES
CATLAS_RUN2_JET_PHI_RES
CATLAS_RUN2_ELECTRON_ET_RES
CATLAS_RUN2_MUON_PT_RES
CATLAS_RUN2_PHOTON_ET_RES
CATLAS_RUN2_TAU_1p0n_PT_RES
CATLAS_RUN2_MUON_PHI_RES	Returns 0.001 as in SimpleAnalysisFramework/src/ObjectResolutions.cxx
CATLAS_RUN2_ELECTRON_PHI_RES	Returns 0.004 as in SimpleAnalysisFramework/src/ObjectResolutions.cxx
CATLAS_RUN2_PHOTON_PHI_RES	Returns 0.004 as in SimpleAnalysisFramework/src/ObjectResolutions.cxx
CATLAS_RUN2_TAU_PHI_RES
CHistoGroup
CJET_EFF_CONST	Take a Jet and return a constant efficiency
CJET_BTAG_EFFS	B-tagging efficiency functor, for more readable b-tag effs and mistag rates
CJetEffSmearFn	Functor for simultaneous efficiency-filtering and smearing of Jets
CJetEffFilter	A functor to return true if Jet j survives a random efficiency selection
CBoolJetFunctor	Base type for Jet -> bool functors
CBoolJetAND	Functor for and-combination of selector logic
CBoolJetOR	Functor for or-combination of selector logic
CBoolJetNOT	Functor for inverting selector logic
CHasBTag	B-tagging functor, with a tag selection cut as the stored state
CHasCTag	C-tagging functor, with a tag selection cut as the stored state
CHasTauTag	Tau-tagging functor, with a tag selection cut as the stored state
CHasNoTag	Anti-B/C-tagging functor, with a tag selection cut as the stored state
CLog	Logging system for controlled & formatted writing to stdout
CMendelMin	A genetic algorithm functional minimizer
CP4SmearParams	Struct for holding momentum-smearing parameters
CP4_EFF_CONST	Take a FourMomentum and return a constant number
CP3_EFF_CONST	Take a Vector3 and return a constant number
CMETSmearParams	Struct for holding MET-smearing parameters
CObjectBasedMET
CBoolParticleBaseFunctor	Base type for Particle -> bool functors
CPtGtr	Transverse momentum greater-than functor
CPtLess	Transverse momentum less-than functor
CPtInRange	Transverse momentum in-range functor
CEtaGtr	Pseudorapidity greater-than functor
CEtaLess	Pseudorapidity less-than functor
CEtaInRange	Pseudorapidity in-range functor
CAbsEtaGtr	Abs pseudorapidity greater-than functor
CAbsEtaLess	Abs pseudorapidity momentum less-than functor
CAbsEtaInRange	Abs pseudorapidity in-range functor
CRapGtr	Rapidity greater-than functor
CRapLess	Rapidity momentum less-than functor
CRapInRange	Rapidity in-range functor
CAbsRapGtr	Abs rapidity greater-than functor
CAbsRapLess	Abs rapidity momentum less-than functor
CAbsRapInRange	Abs rapidity in-range functor
CDeltaRGtr	\( \Delta R \) (with respect to another 4-momentum, vec) greater-than functor
CDeltaRLess	\( \Delta R \) (with respect to another 4-momentum, vec) less-than functor
CDeltaRInRange	\( \Delta R \) (with respect to another 4-momentum, vec) in-range functor
CDeltaPhiGtr	\( |\Delta \phi| \) (with respect to another momentum, vec) greater-than functor
CDeltaPhiLess	\( |\Delta \phi| \) (with respect to another momentum, vec) less-than functor
CDeltaPhiInRange	\( \Delta \phi \) (with respect to another 4-momentum, vec) in-range functor
CDeltaEtaGtr	\( |\Delta \eta| \) (with respect to another momentum, vec) greater-than functor
CDeltaEtaLess	\( |\Delta \eta| \) (with respect to another momentum, vec) less-than functor
CDeltaEtaInRange	\( \Delta \eta \) (with respect to another 4-momentum, vec) in-range functor
CDeltaRapGtr	\( |\Delta y| \) (with respect to another momentum, vec) greater-than functor
CDeltaRapLess	\( |\Delta y| \) (with respect to another momentum, vec) less-than functor
CDeltaRapInRange	\( \Delta y \) (with respect to another 4-momentum, vec) in-range functor
CDoubleParticleBaseFunctor	Base type for Particle -> double functors
CDeltaRWRT	Calculator of \( \Delta R \) with respect to a given momentum
CDeltaPhiWRT	Calculator of \( \Delta \phi \) with respect to a given momentum
CDeltaEtaWRT	Calculator of \( \Delta \eta \) with respect to a given momentum
CAbsDeltaEtaWRT	Calculator of \( |\Delta \eta| \) with respect to a given momentum
CDeltaRapWRT	Calculator of \( \Delta y \) with respect to a given momentum
CAbsDeltaRapWRT	Calculator of \( |\Delta y| \) with respect to a given momentum
CPARTICLE_EFF_CONST	Take a Particle and return a constant number
CParticleEffSmearFn	Functor for simultaneous efficiency-filtering and smearing of Particles
CParticleEffFilter	A functor to return true if Particle p survives a random efficiency selection
CBoolParticleFunctor	Base type for Particle -> bool functors
CBoolParticleAND	Functor for and-combination of selector logic
CBoolParticleOR	Functor for or-combination of selector logic
CBoolParticleNOT	Functor for inverting selector logic
CHasPID	PID matching functor
CHasAbsPID	|PID| matching functor
CFirstParticleWith	Determine whether a particle is the first in a decay chain to meet the cut/function
CFirstParticleWithout	Determine whether a particle is the first in a decay chain not to meet the cut/function
CLastParticleWith	Determine whether a particle is the last in a decay chain to meet the cut/function
CLastParticleWithout	Determine whether a particle is the last in a decay chain not to meet the cut/function
CHasParticleAncestorWith	Determine whether a particle has an ancestor which meets the cut/function
CHasParticleAncestorWithout	Determine whether a particle has an ancestor which doesn't meet the cut/function
CHasParticleParentWith	Determine whether a particle has an parent which meets the cut/function
CHasParticleParentWithout	Determine whether a particle has an parent which doesn't meet the cut/function
CHasParticleChildWith	Determine whether a particle has a child which meets the cut/function
CHasParticleChildWithout	Determine whether a particle has a child which doesn't meet the cut/function
CHasParticleDescendantWith	Determine whether a particle has a descendant which meets the cut/function
CHasParticleDescendantWithout	Determine whether a particle has a descendant which doesn't meet the cut/function
CPercentileBase	PercentileBase is the base class of all Percentile classes
CPercentileTBase	PercentileTBase is the base class of all Percentile classes
CPercentile	The Percentile class for centrality binning
CPercentileXaxis	The PercentileXaxis class for centrality binning
CProjectionTreeGenerator	Class that deals with generating projection trees (for debugging etc.)
CResolutionFunctor
CHTT	Wrapper class for configuring use of HEPTopTagger
CInputParameters
CRivetONNXrt	Simple interface class to take care of basic ONNX networks
CTypeBaseHandle	A polymorphic base type for the AO type handles
CTypeHandle	The type-specific handle that can perform type-specific operations for objects of type T
CFillCollector	FillCollectors which are used to temporarily cache unaggregated fills until collapsed by the Multiplexers via a call to collapseEventGroup()
CFillCollector< YODA::Counter >	FillCollector specialisation for Counter
CFillCollector< YODA::BinnedDbn< DbnN, AxisT... > >	FillCollector specialisation for all BinnedDbn-like AOs
CFillCollector< YODA::BinnedDbn< 1, AxisT > >	FillCollector specialisation for Histo1D
CFillCollector< YODA::BinnedDbn< 2, AxisT1, AxisT2 > >	FillCollector specialisation for Histo2D
CFillCollector< YODA::BinnedDbn< 3, AxisT1, AxisT2, AxisT3 > >	FillCollector specialisation for Histo3D
CFillCollector< YODA::BinnedDbn< 2, AxisT > >	FillCollector specialisation for Profile1D
CFillCollector< YODA::BinnedDbn< 3, AxisT1, AxisT2 > >	FillCollector specialisation for Histo2D
CFillCollector< YODA::BinnedDbn< 4, AxisT1, AxisT2, AxisT3 > >	FillCollector specialisation for Histo3D
CFillCollector< YODA::Estimate0D >	FillCollector specialisation for Estimate
CFillCollector< YODA::BinnedEstimate< AxisT... > >	FillCollector specialisation for BinnedEstimate
CFillCollector< YODA::ScatterND< N > >	FillCollector specialisation for ScatterND
CMultiplexedAO	Multiplexer base class
CMultiplexer	Type-specific multiplexed YODA analysis object
CMultiplexPtr
Cbad_lexical_cast	Exception class for throwing from lexical_cast when a parse goes wrong
Cstringstream	STL class
Cvalarray	STL class
Cstring	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Cifstream	STL class
Cofstream	STL class
Carray	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Cvector	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Clist	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Cset	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Cmultiset	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Cmap	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Cmultimap	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Cpair	STL class
Cunique_ptr	STL class
Cshared_ptr	STL class
Ccomplex	STL class
CCounter
CEstimate0D
Carray	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Costream	STL class
Costringstream	STL class
Cpair	STL class
Cstring	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class
Cvector	STL class
Citerator	STL iterator class
Cconst_iterator	STL iterator class
Creverse_iterator	STL iterator class
Cconst_reverse_iterator	STL iterator class