Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
Rivet::Correlators Class Referenceabstract Projection for calculating correlators for flow measurements. More...
Inheritance diagram for Rivet::Correlators:
Detailed DescriptionProjection for calculating correlators for flow measurements. A projection which calculates Q-vectors and P-vectors, and projects them out as correlators. Implementation follows the description of the ''Generic Framework'': Constructor & Destructor Documentation◆ Correlators()
Constructor
Member Function Documentation◆ addPdgIdPair()
Add a colliding beam pair.
◆ applyProjection() [1/3]
template<typename PROJ = Projection>
Apply the supplied projection on event evt.
◆ applyProjection() [2/3]
template<typename PROJ = Projection>
Apply the supplied projection on event evt.
◆ applyProjection() [3/3]
template<typename PROJ = Projection>
Apply the named projection on event evt.
References Rivet::ProjectionApplier::name(). ◆ beamPairs()
Return the allowed beam pairs on which this projection can operate, not including recursion. Derived classes should ensure that all contained projections are registered in the _projections set for the beam constraint chaining to work.
◆ before()
Determine whether this object should be ordered before the object p given as argument. If p is of a different class than this, the before() function of the corresponding type_info objects is used. Otherwise, if the objects are of the same class, the virtual compare(const Projection &) will be returned. ◆ clone()
◆ compare()
This function is used to define a unique ordering between different Projection objects of the same class. If this is considered to be equivalent to the Projector object, p, in the argument the function should return 0. If this object should be ordered before p a negative value should be returned, otherwise a positive value should be returned. This function must never be called explicitly, but should only be called from the operator<(const Projection &). When implementing the function in concrete sub-classes, it is then guaranteed that the Projection object p in the argument is of the same class as the sub-class and can be safely dynamically casted to that class. When implementing this function in a sub-class, the immediate base class version of the function should be called first. If the base class function returns a non-zero value, that value should be returned immediately. Only if zero is returned should this function check the member variables of the sub-class to determine whether this should be ordered before or after p, or if it is equivalent with p. Implements Rivet::Projection. References Rivet::Projection::mkPCmp(), and Rivet::Kin::p(). ◆ declare() [1/2]
template<typename PROJ >
Register a contained projection (user-facing version)
References Rivet::ProjectionApplier::declareProjection(), and Rivet::ProjectionApplier::name(). Referenced by Rivet::CentralEtHCM::CentralEtHCM(), Rivet::CentralityEstimator::CentralityEstimator(), Rivet::ChargedLeptons::ChargedLeptons(), Rivet::ALICE::CLMultiplicity< INNER >::CLMultiplicity(), Rivet::DISDiffHadron::DISDiffHadron(), Rivet::DISFinalState::DISFinalState(), Rivet::DISKinematics::DISKinematics(), Rivet::DISLepton::DISLepton(), Rivet::GammaGammaFinalState::GammaGammaFinalState(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), Rivet::GeneratedCentrality::GeneratedCentrality(), Rivet::HadronicFinalState::HadronicFinalState(), Rivet::HeavyHadrons::HeavyHadrons(), Rivet::Hemispheres::Hemispheres(), Rivet::InvisibleFinalState::InvisibleFinalState(), Rivet::LeadingParticlesFinalState::LeadingParticlesFinalState(), Rivet::LossyFinalState< FILTER >::LossyFinalState(), Rivet::MC_pPbMinBiasTrigger::MC_pPbMinBiasTrigger(), Rivet::MC_SumETFwdPbCentrality::MC_SumETFwdPbCentrality(), Rivet::ATLAS::MinBiasTrigger::MinBiasTrigger(), Rivet::MissingMomentum::MissingMomentum(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NonHadronicFinalState::NonHadronicFinalState(), Rivet::ParisiTensor::ParisiTensor(), Rivet::PercentileProjection::PercentileProjection(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::SmearedJets::SmearedJets(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedParticles::SmearedParticles(), Rivet::Spherocity::Spherocity(), Rivet::ATLAS::SumET_PB_Centrality::SumET_PB_Centrality(), Rivet::ATLAS::SumET_PBPB_Centrality::SumET_PBPB_Centrality(), Rivet::TauFinder::TauFinder(), Rivet::TriggerCDFRun0Run1::TriggerCDFRun0Run1(), Rivet::TriggerCDFRun2::TriggerCDFRun2(), Rivet::UndressBeamLeptons::UndressBeamLeptons(), Rivet::ALICE::V0AndTrigger::V0AndTrigger(), Rivet::ALICE::V0Trigger< MODE >::V0Trigger(), Rivet::VetoedFinalState::VetoedFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), Rivet::VetoedFinalState::addVetoOnThisFinalState(), and Rivet::CentralityBinner< T, MDist >::setProjection(). ◆ declare() [2/2]
template<typename PROJ >
Register a contained projection (user-facing, arg-reordered version)
References Rivet::ProjectionApplier::declareProjection(), and Rivet::ProjectionApplier::name(). ◆ declareProjection()
template<typename PROJ >
Register a contained projection. The type of the argument is used to instantiate a new projection internally: this new object is applied to events rather than the argument object. Hence you are advised to only use locally-scoped Projection objects in your Projection and Analysis constructors, and to avoid polymorphism (e.g. handling
References Rivet::ProjectionApplier::name(). Referenced by Rivet::ProjectionApplier::declare(). ◆ get()
template<typename PROJ >
Get the named projection, specifying return type via a template argument (user-facing alias).
References Rivet::ProjectionApplier::name(). ◆ getProjection() [1/2]
template<typename PROJ >
Get the named projection, specifying return type via a template argument.
References Rivet::ProjectionHandler::getProjection(), Rivet::ProjectionApplier::getProjHandler(), Rivet::ProjectionApplier::name(), and Rivet::Kin::p(). Referenced by Rivet::CentralityProjection::compare(), and Rivet::pcmp(). ◆ getProjection() [2/2]
Get the named projection (non-templated, so returns as a reference to a Projection base class). References Rivet::ProjectionHandler::getProjection(), Rivet::ProjectionApplier::getProjHandler(), and Rivet::ProjectionApplier::name(). ◆ hVec()
Construct a harmonic vectors from n harmonics and m number of particles.
Referenced by Rivet::CumulantAnalysis::bookECorrelator(), and Rivet::CumulantAnalysis::bookECorrelatorGap(). ◆ intCorrelatorGap()
Integrated correlator of n1 harmonic, for number of powers n1.size() This method imposes an eta gap, correlating with another phase space, where another Correlators projection other should be defined. The harmonics of the other phase space is given as n2. To get e.g. integrated <<4>>_2, n1 should be: n1 = {2, 2} and n2 = {-2, -2} Referenced by Rivet::CumulantAnalysis::ECorrelator::fill(). ◆ mkNamedPCmp()
Shortcut to make a named Cmp<Projection> comparison with the Referenced by Rivet::MC_SumETFwdPbCentrality::compare(), Rivet::MC_pPbMinBiasTrigger::compare(), Rivet::BeamThrust::compare(), Rivet::CentralEtHCM::compare(), Rivet::DISFinalState::compare(), Rivet::EventMixingBase::compare(), Rivet::FParameter::compare(), Rivet::GammaGammaFinalState::compare(), Rivet::HeavyHadrons::compare(), Rivet::Hemispheres::compare(), Rivet::LossyFinalState< FILTER >::compare(), Rivet::PercentileProjection::compare(), Rivet::Spherocity::compare(), Rivet::Thrust::compare(), Rivet::ATLAS::SumET_PB_Centrality::compare(), Rivet::ATLAS::SumET_PBPB_Centrality::compare(), Rivet::ATLAS::MinBiasTrigger::compare(), Rivet::CentralityEstimator::compare(), Rivet::GeneratedCentrality::compare(), Rivet::STAR_BES_Centrality::compare(), and Rivet::BRAHMSCentrality::compare(). ◆ mkPCmp()
Shortcut to make a named Cmp<Projection> comparison with the
Referenced by Rivet::ALICE::PrimaryParticles::compare(), Rivet::SmearedJets::compare(), Rivet::SmearedMET::compare(), Rivet::SmearedParticles::compare(), and compare(). ◆ name()
Get the name of the projection. Implements Rivet::ProjectionApplier. Referenced by Rivet::VetoedFinalState::addVetoOnThisFinalState(), Rivet::Projection::getLog(), and Rivet::Projection::setName(). ◆ project()
Take the information available in the Event and make the calculations necessary to obtain the projection. Note that this function must never be called except inside the Event::applyProjection(Projection *) function. Implements Rivet::Projection. ◆ pTBinnedCorrelators()
pT differential correlator of n harmonic, for number of powers n.size() The method can include overflow/underflow bins in the beginning/end of the returned vector, by toggling overflow = true. Referenced by Rivet::CumulantAnalysis::ECorrelator::fill(). ◆ pTBinnedCorrelatorsGap()
pT differential correlators of n1 harmonic, for number n1.size() This method imposes an eta gap, correlating with another phase space, where another Correlators projection other should be defined. The harmonics of the other phase space is given as n2. To get e.g. differential <<4'>_2, n1 should be: n1 = {2, 2} and n2: n2 = {-2, -2}. To get e.g. differential <<2'>>_4, n1 should be: n1 = {4} and n2: n2 = {-4}. The method can include overflow/underflow bins in the beginning/end of the returned vector, by toggling overflow = true. Referenced by Rivet::CumulantAnalysis::ECorrelator::fill(). The documentation for this class was generated from the following file:
Generated on Fri May 13 2022 23:02:06 for Rivet by  1.9.4
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
