Rivet::CentralityBinner< T, MDist > Class Template Reference
Inheritance diagram for Rivet::CentralityBinner< T, MDist >:
![]()
Detailed Descriptiontemplate<typename T = Histo1DPtr, typename MDist = MergeDistance> class Rivet::CentralityBinner< T, MDist > CentralityBinner contains a series of AnalysisObject of the same quantity each in a different percentiles of another quantity. For example, a CentralityBinner may e.g. contain histograms of the cross section differential in \( p_T \) in different centrality regions for heavy ion collisions based on forward energy flow. Constructor & Destructor Documentation◆ CentralityBinner()
template<typename T = Histo1DPtr, typename MDist = MergeDistance>
Create a new empty CentralityBinner. maxbins is the maximum number of bins used by the binner. Default is 1000, which is typically enough. wlim is the mximum allowed error allowed for the centrality limits before a warning is emitted. Member Function Documentation◆ add()
template<typename T = Histo1DPtr, typename MDist = MergeDistance>
Add an AnalysisObject in the region between cmin and cmax to this set of CentralityBinners. The range represent percentiles and must be between 0 and 100. No overlaping bins are allowed. Note that (cmin=0, cmax=5), means the five percent MOST central events although the internal notation is reversed for convenience. Optionally supply corresponding limits cestmin and cestmax of the centrality extimator. References Rivet::max(), and Rivet::min(). ◆ 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(). ◆ 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(). ◆ edges()
template<typename T = Histo1DPtr, typename MDist = MergeDistance>
Return a map bin edges of the centrality extimator indexed by the corresponing percentile. ◆ estimator()
template<typename T = Histo1DPtr, typename MDist = MergeDistance>
Return the value of the centrality estimator set in the latest call to select(). ◆ finalize()
template<typename T , typename MDist >
At the end of the run, calculate the percentiles and fill the AnalysisObjectss provided with the add() function. This is typically called from the finalize method in an Analysis, but can also be called earlier in which case the the select functions can be continued to run as before with the edges between the centrality regions now fixed. References Rivet::max(), Rivet::min(), and MSG_WARNING. ◆ 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(). ◆ name()
template<typename T = Histo1DPtr, typename MDist = MergeDistance>
Return the class name. Implements Rivet::ProjectionApplier. ◆ normalizePerEvent()
template<typename T = Histo1DPtr, typename MDist = MergeDistance>
Normalize each AnalysisObjects to the sum of event weights in the corresponding centrality bin. ◆ select() [1/2]
template<typename T = Histo1DPtr, typename MDist = MergeDistance>
Return one of the AnalysisObjects in the CentralityBinner for the given event. This version requires that a CentralityEstimator object has been assigned that can compute the value of the centrality estimator from the event. Optionally the weight of the event is given. This should be the weight that will be used to fill the AnalysisObject. If the centrality estimate is less than zero, the _devnull object will be returned. References Rivet::CentralityBinner< T, MDist >::select(). Referenced by Rivet::CentralityBinner< T, MDist >::select(). ◆ select() [2/2]
template<typename T , typename MDist >
Return one of the AnalysisObjecsts in the Setup the CentralityBinner depending on the value of the centrality estimator, cest. Optionally the weight of the event is given. This should be the weight that will be used to fill the AnalysisObject. If the centrality estimate is less than zero, the _devnull object will be returned. ◆ setProjection()
template<typename T = Histo1DPtr, typename MDist = MergeDistance>
Set the centrality projection to be used. Note that this projection must have already been declared to Rivet. References Rivet::ProjectionApplier::declare(), and Rivet::Kin::p(). The documentation for this class was generated from the following file:
Generated on Fri May 13 2022 23:02:06 for Rivet by |