Rivet API documentation

Rivet 4.1.3
ParticleBase-container physics utils

Functions

template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::sumPt (const CONTAINER &c)
 Return the pT sum of a collection of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::sumE (const CONTAINER &c)
 Return the energy sum of a collection of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::sumEt (const CONTAINER &c)
 Return the ET sum of a collection of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::sumMass (const CONTAINER &c)
 Return the mass sum of a collection of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
FourMomentum Rivet::sumP4 (const CONTAINER &c)
 Return the four-momentum sum of a collection of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
Vector3 Rivet::sumP3 (const CONTAINER &c)
 Return the four-momentum sum of a collection of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
Vector3 Rivet::sumPtVec (const CONTAINER &c)
 Return the four-momentum sum of a collection of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::deltaPhiMin (const CONTAINER &c)
 Calculate the minimum phi separation in a collection of particle-like objects.
template<typename CONTAINER1, typename CONTAINER2, typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaPhiMin (const CONTAINER1 &c1, const CONTAINER2 &c2)
 Calculate the minimum phi separation between two collections of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::deltaEtaMin (const CONTAINER &c)
 Calculate the minimum pseudorapidity separation in a collection of particle-like objects.
template<typename CONTAINER1, typename CONTAINER2, typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaEtaMin (const CONTAINER1 &c1, const CONTAINER2 &c2)
 Calculate the minimum pseudorapidity separation between two collections of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::deltaRapMin (const CONTAINER &c)
 Calculate the minimum rapidity separation in a collection of particle-like objects.
template<typename CONTAINER1, typename CONTAINER2, typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaRapMin (const CONTAINER1 &c1, const CONTAINER2 &c2)
 Calculate the minimum pseudorapidity separation between two collections of particle-like objects.
template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::deltaRMin (const CONTAINER &c)
 Calculate the minimum rapidity separation in a collection of particle-like objects.
template<typename CONTAINER1, typename CONTAINER2, typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaRMin (const CONTAINER1 &c1, const CONTAINER2 &c2)
 Calculate the minimum pseudorapidity separation between two collections of particle-like objects.
template<typename CONTAINER, typename PVEC, typename = isCIterable<CONTAINER>>
double Rivet::mTmin (const CONTAINER &psvis, const PVEC &pinvis)
 Get the minimum transverse mass of a pair of vectors, one of them taken from a list.

Detailed Description

Function Documentation

◆ deltaEtaMin() [1/2]

template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::deltaEtaMin ( const CONTAINER & c)
inline

Calculate the minimum pseudorapidity separation in a collection of particle-like objects.

Note
Returns positive values
Todo
Generalise to min of any 2-ParticleBase function?

References deltaEta().

◆ deltaEtaMin() [2/2]

template<typename CONTAINER1, typename CONTAINER2, typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaEtaMin ( const CONTAINER1 & c1,
const CONTAINER2 & c2 )
inline

Calculate the minimum pseudorapidity separation between two collections of particle-like objects.

Note
Returns positive value
Warning
Assumes the two vectors are mutually exclusive, so does not protect against self-comparisons.
Todo
Generalise to min of any 2-ParticleBase function?

References deltaEta().

◆ deltaPhiMin() [1/2]

template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::deltaPhiMin ( const CONTAINER & c)
inline

Calculate the minimum phi separation in a collection of particle-like objects.

Note
Returns in the range 0..pi
Todo
Generalise to min of any 2-ParticleBase function?

References deltaPhi().

◆ deltaPhiMin() [2/2]

template<typename CONTAINER1, typename CONTAINER2, typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaPhiMin ( const CONTAINER1 & c1,
const CONTAINER2 & c2 )
inline

Calculate the minimum phi separation between two collections of particle-like objects.

Note
Returns in the range 0..pi
Warning
Assumes the two vectors are mutually exclusive, so does not protect against self-comparisons.
Todo
Generalise to min of any 2-ParticleBase function?

References deltaPhi().

◆ deltaRapMin() [1/2]

template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::deltaRapMin ( const CONTAINER & c)
inline

Calculate the minimum rapidity separation in a collection of particle-like objects.

Note
Returns positive values
Todo
Generalise to min of any 2-ParticleBase function?

References deltaRap().

◆ deltaRapMin() [2/2]

template<typename CONTAINER1, typename CONTAINER2, typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaRapMin ( const CONTAINER1 & c1,
const CONTAINER2 & c2 )
inline

Calculate the minimum pseudorapidity separation between two collections of particle-like objects.

Note
Returns positive values
Warning
Assumes the two vectors are mutually exclusive, so does not protect against self-comparisons.
Todo
Generalise to min of any 2-ParticleBase function?

References deltaRap().

◆ deltaRMin() [1/2]

template<typename CONTAINER, typename = isCIterable<CONTAINER>>
double Rivet::deltaRMin ( const CONTAINER & c)
inline

Calculate the minimum rapidity separation in a collection of particle-like objects.

Note
Returns positive values
Todo
Generalise to min of any 2-ParticleBase function?

References deltaR().

◆ deltaRMin() [2/2]

template<typename CONTAINER1, typename CONTAINER2, typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaRMin ( const CONTAINER1 & c1,
const CONTAINER2 & c2 )
inline

Calculate the minimum pseudorapidity separation between two collections of particle-like objects.

Note
Returns positive values
Warning
Assumes the two vectors are mutually exclusive, so does not protect against self-comparisons.
Todo
Generalise to min of any 2-ParticleBase function?

References deltaR().