rivet is hosted by Hepforge, IPPP Durham
Rivet 4.1.0
ParticleBase-container physics utils

Functions

template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::sumPt (CONTAINER &&c)
 Return the pT sum of a collection of particle-like objects.
 
template<typename CONTAINER , typename = isCIterable<CONTAINER>>
FourMomentum Rivet::sumP4 (CONTAINER &&c)
 Return the four-momentum sum of a collection of particle-like objects.
 
template<typename CONTAINER , typename = isCIterable<CONTAINER>>
Vector3 Rivet::sumP3 (CONTAINER &&c)
 Return the four-momentum sum of a collection of particle-like objects.
 
template<typename CONTAINER , typename = isCIterable<CONTAINER>>
Vector3 Rivet::sumPtVec (CONTAINER &&c)
 Return the four-momentum sum of a collection of particle-like objects.
 
template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::deltaPhiMin (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 (CONTAINER1 &&c1, CONTAINER2 &&c2)
 Calculate the minimum phi separation between two collections of particle-like objects.
 
template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::deltaEtaMin (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 (CONTAINER1 &&c1, CONTAINER2 &&c2)
 Calculate the minimum pseudorapidity separation between two collections of particle-like objects.
 
template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::deltaRapMin (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 (CONTAINER1 &&c1, CONTAINER2 &&c2)
 Calculate the minimum pseudorapidity separation between two collections of particle-like objects.
 
template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::deltaRMin (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 (CONTAINER1 &&c1, CONTAINER2 &&c2)
 Calculate the minimum pseudorapidity separation between two collections of particle-like objects.
 

Detailed Description

Function Documentation

◆ deltaEtaMin() [1/2]

template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::deltaEtaMin ( 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 Rivet::deltaEta().

◆ deltaEtaMin() [2/2]

template<typename CONTAINER1 , typename CONTAINER2 , typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaEtaMin ( CONTAINER1 &&  c1,
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 Rivet::deltaEta().

◆ deltaPhiMin() [1/2]

template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::deltaPhiMin ( 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 Rivet::deltaPhi().

◆ deltaPhiMin() [2/2]

template<typename CONTAINER1 , typename CONTAINER2 , typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaPhiMin ( CONTAINER1 &&  c1,
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 Rivet::deltaPhi().

◆ deltaRapMin() [1/2]

template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::deltaRapMin ( 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 Rivet::deltaRap().

◆ deltaRapMin() [2/2]

template<typename CONTAINER1 , typename CONTAINER2 , typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaRapMin ( CONTAINER1 &&  c1,
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 Rivet::deltaRap().

◆ deltaRMin() [1/2]

template<typename CONTAINER , typename = isCIterable<CONTAINER>>
double Rivet::deltaRMin ( 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 Rivet::deltaR().

◆ deltaRMin() [2/2]

template<typename CONTAINER1 , typename CONTAINER2 , typename = isCIterable<CONTAINER1, CONTAINER2>>
double Rivet::deltaRMin ( CONTAINER1 &&  c1,
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 Rivet::deltaR().