rivet is hosted by Hepforge, IPPP Durham

Common base class for Projection and Analysis, used for internal polymorphism. More...

#include <ProjectionApplier.hh>

Inheritance diagram for ProjectionApplier:
Collaboration diagram for ProjectionApplier:

List of all members.

Public Member Functions

 ProjectionApplier ()
 Constructor.
virtual ~ProjectionApplier ()
Metadata functions
virtual std::string name () const =0
 Get the name of this Projection or Analysis class.
Projection "getting" functions
std::set< ConstProjectionPtrgetProjections () const
 Get the contained projections, including recursion.
template<typename PROJ >
const PROJ & getProjection (const std::string &name) const
 Get the named projection, specifying return type via a template argument.
const ProjectiongetProjection (const std::string &name) const
Projection applying functions
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const PROJ &proj) const
 Apply the supplied projection on event.
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const Projection &proj) const
 Apply the supplied projection on event.
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const std::string &name) const
 Apply the named projection on event.

Protected Member Functions

LoggetLog () const
ProjectionHandlergetProjHandler () const
 Get a reference to the ProjectionHandler for this thread.
Projection registration functions
template<typename PROJ >
const PROJ & addProjection (const PROJ &proj, const std::string &name)
const Projection_addProjection (const Projection &proj, const std::string &name)
 Untemplated function to do the work...

Protected Attributes

bool _allowProjReg
 Flag to forbid projection registration in analyses until the init phase.

Private Member Functions

const Projection_applyProjection (const Event &evt, const std::string &name) const
const Projection_applyProjection (const Event &evt, const Projection &proj) const

Private Attributes

ProjectionHandler_projhandler
 Pointer to projection handler.

Detailed Description

Common base class for Projection and Analysis, used for internal polymorphism.

Empty interface used for storing Projection and Analysis pointers in the same container (used by the ProjectionHandler)

Definition at line 21 of file ProjectionApplier.hh.


Constructor & Destructor Documentation

Constructor.

Definition at line 10 of file ProjectionApplier.cc.


Member Function Documentation

const Projection & _addProjection ( const Projection proj,
const std::string &  name 
) [protected]

Untemplated function to do the work...

Definition at line 33 of file ProjectionApplier.cc.

References ProjectionApplier::_allowProjReg, ProjectionApplier::getProjHandler(), ProjectionApplier::name(), Projection::name(), and ProjectionHandler::registerProjection().

Referenced by ProjectionApplier::addProjection().

                                                                             {
    if (!_allowProjReg) {
      cerr << "Trying to register projection '"
           << proj.name() << "' before init phase in '" << this->name() << "'." << endl;
      exit(2);
    }
    const Projection& reg = getProjHandler().registerProjection(*this, proj, name);
    return reg;
  }
const Projection & _applyProjection ( const Event evt,
const std::string &  name 
) const [private]

Non-templated version of string-based applyProjection, to work around header dependency issue.

Definition at line 21 of file ProjectionApplier.cc.

References Event::applyProjection(), and ProjectionApplier::getProjection().

Referenced by ProjectionApplier::applyProjection().

                                                                                  {
    return evt.applyProjection(getProjection(name));
  }
const Projection & _applyProjection ( const Event evt,
const Projection proj 
) const [private]

Non-templated version of proj-based applyProjection, to work around header dependency issue.

Definition at line 27 of file ProjectionApplier.cc.

References Event::applyProjection().

                                                                                      {
    return evt.applyProjection(proj);
  }
const PROJ& addProjection ( const PROJ &  proj,
const std::string &  name 
) [inline, protected]

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 ConcreteProjection via a pointer or reference to type Projection) since this will screw up the internal type management.

Definition at line 116 of file ProjectionApplier.hh.

References ProjectionApplier::_addProjection().

Referenced by VetoedFinalState::addVetoOnThisFinalState(), BeamThrust::BeamThrust(), CDF_2009_S8057893::CDF_2009_S8057893::init(), CentralEtHCM::CentralEtHCM(), ChargedFinalState::ChargedFinalState(), ChargedLeptons::ChargedLeptons(), DISFinalState::DISFinalState(), DISKinematics::DISKinematics(), DISLepton::DISLepton(), DressedLeptons::DressedLeptons(), FinalState::FinalState(), FoxWolframMoments::FoxWolframMoments(), FParameter::FParameter(), HadronicFinalState::HadronicFinalState(), HeavyHadrons::HeavyHadrons(), Hemispheres::Hemispheres(), IdentifiedFinalState::IdentifiedFinalState(), CMS_2010_S8656010::init(), CMS_2010_S8547297::init(), ATLAS_2010_S8894728::init(), ALICE_2012_I1181770::init(), ATLAS_2011_S8994773::init(), CMS_2011_S8950903::init(), CMS_2012_PAS_QCD_11_010::init(), ATLAS_2010_CONF_2010_049::init(), ATLAS_2011_I894867::init(), LHCB_2013_I1208105::init(), ALICE_2011_S8909580::init(), CMS_2011_S8941262::init(), CMS_2011_S8968497::init(), CMS_2011_S8973270::init(), CMS_2011_S8978280::init(), CMS_2011_S9086218::init(), CMS_2011_S9215166::init(), TOTEM_2012_I1115294::init(), CMS_2012_I1087342::init(), CMS_2012_I1184941::init(), CMS_2012_I1193338::init(), ALICE_2011_S8945144::init(), CDF_2007_S7057202::init(), TOTEM_2012_002::init(), CMS_2011_I954992::init(), CMS_2011_S8957746::init(), ATLAS_2010_S8591806::init(), ATLAS_2011_S9002537::init(), D0_2011_I895662::init(), CMS_2011_S9088458::init(), LHCF_2012_I1115479::init(), ATLAS_2011_I930220::init(), D0_2010_S8570965::init(), MC_JETS::init(), MC_KTSPLITTINGS::init(), CDF_2012_NOTE10874::init(), STAR_2006_S6500200::init(), STAR_2008_S7993412::init(), UA5_1987_S1640666::init(), CMS_2013_I1209721::init(), CMS_QCD_10_024::init(), CDF_1997_S3541940::init(), SFM_1984_S1178091::init(), ARGUS_1993_S2789213::init(), ATLAS_2012_I1204784::init(), CMS_2013_I1258128::init(), BABAR_2007_S7266081::init(), ATLAS_2011_S9128077::init(), CDF_1993_S2742446::init(), CDF_2000_S4155203::init(), CDF_2005_S6080774::init(), MC_DIJET::init(), MC_DIPHOTON::init(), CDF_2006_S6450792::init(), MC_HINC::init(), MC_WINC::init(), MC_ZINC::init(), MC_ZZINC::init(), MC_ZKTSPLITTINGS::init(), STAR_2006_S6870392::init(), UA5_1982_S875503::init(), UA5_1989_S1926373::init(), D0_2008_S6879055::init(), D0_2010_S8821313::init(), MC_HJETS::init(), MC_HKTSPLITTINGS::init(), MC_PHOTONINC::init(), CDF_2008_S8093652::init(), MC_WKTSPLITTINGS::init(), MC_WWINC::init(), MC_ZJETS::init(), CDF_2008_S7782535::init(), ARGUS_1993_S2669951::init(), MC_ZZJETS::init(), MC_ZZKTSPLITTINGS::init(), ATLAS_2012_I1091481::init(), ALEPH_1991_S2435284::init(), CMS_2012_I1102908::init(), MC_WWKTSPLITTINGS::init(), ATLAS_2012_I1183818::init(), ATLAS_2013_I1243871::init(), D0_2008_S7863608::init(), ATLAS_2011_S9035664::init(), D0_2010_S8671338::init(), CMS_2012_I1107658::init(), E735_1998_S3905616::init(), MC_PHOTONJETS::init(), MC_PHOTONKTSPLITTINGS::init(), MC_WJETS::init(), MC_WWJETS::init(), ATLAS_2011_I944826::init(), ALEPH_1996_S3196992::init(), D0_2009_S8202443::init(), DELPHI_1999_S3960137::init(), CDF_1990_S2089246::init(), UA5_1986_S1583476::init(), CDF_1988_S1865951::init(), EXAMPLE_CUTS::init(), ALEPH_2002_S4823664::init(), MC_GENERIC::init(), CDF_2005_S6217184::init(), MC_IDENTIFIED::init(), MC_LEADJETUE::init(), MC_TTBAR::init(), MC_PHOTONJETUE::init(), OPAL_1995_S3198391::init(), OPAL_1996_S3257789::init(), OPAL_1997_S3608263::init(), OPAL_1998_S3702294::init(), OPAL_1998_S3749908::init(), OPAL_2000_S4418603::init(), ATLAS_2011_S8924791::init(), ATLAS_2010_S8817804::init(), D0_1996_S3324664::init(), D0_2007_S7075677::init(), ATLAS_2011_I945498::init(), ATLAS_2011_I954993::init(), ATLAS_2012_I1119557::init(), D0_2001_S4674421::init(), D0_2008_S7554427::init(), CDF_1994_S2952106::init(), H1_1995_S3167097::init(), MC_QCD_PARTONS::init(), UA1_1990_S2044935::init(), ZEUS_2001_S4815815::init(), ATLAS_2012_I1188891::init(), D0_2008_S7837160::init(), ATLAS_2011_S9131140::init(), LHCB_2011_I919315::init(), CDF_2008_S7540469::init(), CDF_2008_S7828950::init(), JADE_OPAL_2000_S4300807::init(), DELPHI_1995_S3137023::init(), STAR_2006_S6860818::init(), STAR_2009_UE_HELEN::init(), CMS_2012_I941555::init(), ALICE_2010_S8624100::init(), JADE_1998_S3612880::init(), OPAL_1997_S3396100::init(), EXAMPLE::init(), CDF_2008_S8095620::init(), D0_1996_S3214044::init(), MC_PHOTONS::init(), MC_SUSY::init(), ATLAS_2011_I925932::init(), ALEPH_2004_S5765862::init(), ATLAS_2012_I1125575::init(), CMS_2013_I1218372::init(), ALICE_2010_S8625980::init(), D0_2000_S4480767::init(), ALICE_2010_S8706239::init(), LHCB_2013_I1218996::init(), CDF_2009_NOTE_9936::init(), CDF_1996_S3108457::init(), CDF_2001_S4563131::init(), CDF_2009_S8383952::init(), ATLAS_2011_I926145::init(), CDF_1998_S3618439::init(), CDF_2009_S8436959::init(), CDF_2000_S4266730::init(), ATLAS_2011_S8971293::init(), D0_2009_S8320160::init(), D0_2009_S8349509::init(), SLD_2002_S4869273::init(), ALEPH_2001_S4656318::init(), MC_WPOL::init(), DELPHI_2002_069_CONF_603::init(), ATLAS_2010_S8919674::init(), CDF_1996_S3349578::init(), D0_2006_S6438750::init(), CDF_2001_S4517016::init(), ATLAS_2012_I1082936::init(), D0_2010_S8566488::init(), SLD_1996_S3398250::init(), CDF_1996_S3418421::init(), UA5_1988_S1867512::init(), D0_2008_S7662670::init(), ATLAS_2011_S9108483::init(), CDF_2006_S6653332::init(), CDF_2008_S7541902::init(), ATLAS_2012_I1083318::init(), ATLAS_2012_I1125961::init(), ATLAS_2013_I1230812::init(), ATLAS_2012_I1095236::init(), ATLAS_2012_CONF_2012_109::init(), ATLAS_2011_S9212183::init(), ATLAS_2011_CONF_2011_090::init(), ATLAS_2012_I1082009::init(), ATLAS_2011_S9019561::init(), ATLAS_2012_I1190891::init(), OPAL_2002_S5361494::init(), ATLAS_2012_I943401::init(), ATLAS_2012_I1180197::init(), ATLAS_2012_I1117704::init(), ATLAS_2011_S9225137::init(), ATLAS_2013_I1217867::init(), ATLAS_2012_I1112263::init(), ATLAS_2011_S9212353::init(), ATLAS_2012_CONF_2012_001::init(), ATLAS_2012_CONF_2012_103::init(), ATLAS_2012_CONF_2012_104::init(), ATLAS_2012_I946427::init(), TASSO_1990_S2148048::init(), DELPHI_2000_S4328825::init(), ATLAS_2011_S8983313::init(), ATLAS_2012_CONF_2012_105::init(), CMS_2013_I1224539_DIJET::init(), ATLAS_2012_I1186556::init(), ATLAS_2012_I1084540::init(), ATLAS_2012_I1126136::init(), ATLAS_2011_CONF_2011_098::init(), CMS_2013_I1224539_ZJET::init(), CMS_2013_I1224539_WJET::init(), CDF_2009_S8233977::init(), CDF_2010_S8591881_DY::init(), ATLAS_2012_CONF_2012_153::init(), CDF_2010_S8591881_QCD::init(), D0_2004_S5992206::init(), ATLAS_2010_S8914702::init(), LHCB_2011_I917009::init(), CDF_2001_S4751469::init(), ATLAS_2011_S9120807::init(), D0_2008_S7719523::init(), ATLAS_2010_S8918562::init(), LHCB_2012_I1119400::init(), ATLAS_2012_I1094568::init(), ATLAS_2011_S9041966::init(), DELPHI_1996_S3430090::init(), ALEPH_1996_S3486095::init(), ALEPH_1999_S4193598::init(), ATLAS_2012_I1093738::init(), OPAL_2004_S6132243::init(), OPAL_1994_S2927284::init(), STAR_2008_S7869363::init(), ATLAS_2011_S9126244::init(), BABAR_2007_S6895344::init(), MC_VH2BB::init(), BABAR_2005_S6181155::init(), BELLE_2001_S4598261::init(), ATLAS_2011_I919017::init(), OPAL_2001_S4553896::init(), DELPHI_2003_WUD_03_11::init(), CDF_2004_S5839831::init(), BABAR_2003_I593379::init(), ARGUS_1993_S2653028::init(), CLEO_2004_S5809304::init(), OPAL_1998_S3780481::init(), OPAL_1993_S2692198::init(), ATLAS_2012_I1093734::init(), ATLAS_2012_I1094564::init(), H1_1994_S2919893::init(), H1_2000_S4129130::init(), SLD_2004_S5693039::init(), BELLE_2006_S6265367::init(), SLD_1999_S3743934::init(), PDG_HADRON_MULTIPLICITIES::init(), PDG_HADRON_MULTIPLICITIES_RATIOS::init(), JetAlg::JetAlg(), JetShape::JetShape(), LeadingParticlesFinalState::LeadingParticlesFinalState(), LossyFinalState< ConstRandomFilter >::LossyFinalState(), MergedFinalState::MergedFinalState(), MissingMomentum::MissingMomentum(), NeutralFinalState::NeutralFinalState(), NonHadronicFinalState::NonHadronicFinalState(), ParisiTensor::ParisiTensor(), PrimaryHadrons::PrimaryHadrons(), Sphericity::Sphericity(), Spherocity::Spherocity(), Thrust::Thrust(), TriggerCDFRun0Run1::TriggerCDFRun0Run1(), TriggerCDFRun2::TriggerCDFRun2(), TriggerUA5::TriggerUA5(), VetoedFinalState::VetoedFinalState(), VisibleFinalState::VisibleFinalState(), WFinder::WFinder(), and ZFinder::ZFinder().

                                                                       {
      const Projection& reg = _addProjection(proj, name);
      const PROJ& rtn = dynamic_cast<const PROJ&>(reg);
      return rtn;
    }
const PROJ& applyProjection ( const Event evt,
const PROJ &  proj 
) const [inline]

Apply the supplied projection on event.

Definition at line 70 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

Referenced by DISFinalState::project().

                                                                          {
      return pcast<PROJ>(_applyProjection(evt, proj));
    }
const PROJ& applyProjection ( const Event evt,
const Projection proj 
) const [inline]

Apply the supplied projection on event.

Definition at line 77 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

                                                                                {
      return pcast<PROJ>(_applyProjection(evt, proj));
    }
const PROJ& applyProjection ( const Event evt,
const std::string &  name 
) const [inline]

Apply the named projection on event.

Definition at line 84 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

                                                                               {
      return pcast<PROJ>(_applyProjection(evt, name));
    }
Log& getLog ( ) const [inline, protected]

Reimplemented in Analysis, and Projection.

Definition at line 92 of file ProjectionApplier.hh.

                        {
      return Log::getLog("Rivet.ProjectionHandler");
    }
const PROJ& getProjection ( const std::string &  name) const [inline]

Get the named projection, specifying return type via a template argument.

Definition at line 52 of file ProjectionApplier.hh.

References ProjectionHandler::getProjection(), and ProjectionApplier::getProjHandler().

Referenced by ProjectionApplier::_applyProjection(), Rivet::pcmp(), and Hemispheres::project().

                                                           {
      const Projection& p = getProjHandler().getProjection(*this, name);
      return pcast<PROJ>(p);
    }
const Projection& getProjection ( const std::string &  name) const [inline]

Get the named projection (non-templated, so returns as a reference to a Projection base class).

Definition at line 60 of file ProjectionApplier.hh.

References ProjectionHandler::getProjection(), and ProjectionApplier::getProjHandler().

                                                                 {
      return getProjHandler().getProjection(*this, name);
    }
std::set<ConstProjectionPtr> getProjections ( ) const [inline]

Get the contained projections, including recursion.

Definition at line 45 of file ProjectionApplier.hh.

References ProjectionHandler::DEEP, ProjectionHandler::getChildProjections(), and ProjectionApplier::getProjHandler().

Referenced by Projection::beamPairs().

virtual std::string name ( ) const [pure virtual]

Member Data Documentation

bool _allowProjReg [protected]

Flag to forbid projection registration in analyses until the init phase.

Definition at line 143 of file ProjectionApplier.hh.

Referenced by ProjectionApplier::_addProjection(), and Analysis::Analysis().

Pointer to projection handler.

Definition at line 149 of file ProjectionApplier.hh.

Referenced by ProjectionApplier::getProjHandler().


The documentation for this class was generated from the following files: