This is the base class of all analysis classes in Rivet. More...

#include <Analysis.hh>

Inherited by ALEPH_1991_S2435284, ALEPH_1996_S3196992, ALEPH_1996_S3486095, ALEPH_1999_S4193598, ALEPH_2001_S4656318, ALEPH_2002_S4823664, ALEPH_2004_S5765862, ALICE_2010_S8624100, ALICE_2010_S8625980, ALICE_2010_S8706239, ALICE_2011_S8909580, ALICE_2011_S8945144, ALICE_2012_I1181770, ARGUS_1993_S2653028, ARGUS_1993_S2669951, ARGUS_1993_S2789213, ATLAS_2010_CONF_2010_049, ATLAS_2010_S8591806, ATLAS_2010_S8817804, ATLAS_2010_S8894728, ATLAS_2010_S8914702, ATLAS_2010_S8918562, ATLAS_2010_S8919674, ATLAS_2011_CONF_2011_090, ATLAS_2011_CONF_2011_098, ATLAS_2011_I894867, ATLAS_2011_I919017, ATLAS_2011_I925932, ATLAS_2011_I926145, ATLAS_2011_I930220, ATLAS_2011_I944826, ATLAS_2011_I945498, ATLAS_2011_I954993, ATLAS_2011_S8924791, ATLAS_2011_S8971293, ATLAS_2011_S8983313, ATLAS_2011_S8994773, ATLAS_2011_S9002537, ATLAS_2011_S9019561, ATLAS_2011_S9035664, ATLAS_2011_S9041966, ATLAS_2011_S9108483, ATLAS_2011_S9120807, ATLAS_2011_S9126244, ATLAS_2011_S9128077, ATLAS_2011_S9131140, ATLAS_2011_S9212183, ATLAS_2011_S9212353, ATLAS_2011_S9225137, ATLAS_2012_CONF_2012_001, ATLAS_2012_CONF_2012_103, ATLAS_2012_CONF_2012_104, ATLAS_2012_CONF_2012_105, ATLAS_2012_CONF_2012_109, ATLAS_2012_CONF_2012_153, ATLAS_2012_I1082009, ATLAS_2012_I1082936, ATLAS_2012_I1083318, ATLAS_2012_I1084540, ATLAS_2012_I1091481, ATLAS_2012_I1093734, ATLAS_2012_I1093738, ATLAS_2012_I1094564, ATLAS_2012_I1094568, ATLAS_2012_I1095236, ATLAS_2012_I1112263, ATLAS_2012_I1117704, ATLAS_2012_I1118269, ATLAS_2012_I1119557, ATLAS_2012_I1125575, ATLAS_2012_I1125961, ATLAS_2012_I1126136, ATLAS_2012_I1180197, ATLAS_2012_I1183818, ATLAS_2012_I1186556, ATLAS_2012_I1188891, ATLAS_2012_I1190891, ATLAS_2012_I1204784, ATLAS_2012_I943401, ATLAS_2012_I946427, ATLAS_2013_I1217867, ATLAS_2013_I1230812, ATLAS_2013_I1243871, BABAR_2003_I593379, BABAR_2005_S6181155, BABAR_2007_S6895344, BABAR_2007_S7266081, BELLE_2001_S4598261, BELLE_2006_S6265367, CDF_1988_S1865951, CDF_1990_S2089246, CDF_1993_S2742446, CDF_1994_S2952106, CDF_1996_S3108457, CDF_1996_S3349578, CDF_1996_S3418421, CDF_1997_S3541940, CDF_1998_S3618439, CDF_2000_S4155203, CDF_2000_S4266730, CDF_2001_S4517016, CDF_2001_S4563131, CDF_2001_S4751469, CDF_2004_S5839831, CDF_2005_S6080774, CDF_2005_S6217184, CDF_2006_S6450792, CDF_2006_S6653332, CDF_2007_S7057202, CDF_2008_S7540469, CDF_2008_S7541902, CDF_2008_S7782535, CDF_2008_S7828950, CDF_2008_S8093652, CDF_2008_S8095620, CDF_2009_NOTE_9936, CDF_2009_S8057893, CDF_2009_S8233977, CDF_2009_S8383952, CDF_2009_S8436959, CDF_2010_S8591881_DY, CDF_2010_S8591881_QCD, CDF_2012_NOTE10874, CLEO_2004_S5809304, CMS_2010_S8547297, CMS_2010_S8656010, CMS_2011_I954992, CMS_2011_S8884919, CMS_2011_S8941262, CMS_2011_S8950903, CMS_2011_S8957746, CMS_2011_S8968497, CMS_2011_S8973270, CMS_2011_S8978280, CMS_2011_S9086218, CMS_2011_S9088458, CMS_2011_S9120041, CMS_2011_S9215166, CMS_2012_I1087342, CMS_2012_I1102908, CMS_2012_I1107658, CMS_2012_I1184941, CMS_2012_I1193338, CMS_2012_I941555, CMS_2012_PAS_QCD_11_010, CMS_2013_I1209721, CMS_2013_I1218372, CMS_2013_I1224539_DIJET, CMS_2013_I1224539_WJET, CMS_2013_I1224539_ZJET, CMS_2013_I1258128, CMS_QCD_10_024, D0_1996_S3214044, D0_1996_S3324664, D0_2000_S4480767, D0_2001_S4674421, D0_2004_S5992206, D0_2006_S6438750, D0_2007_S7075677, D0_2008_S6879055, D0_2008_S7554427, D0_2008_S7662670, D0_2008_S7719523, D0_2008_S7837160, D0_2008_S7863608, D0_2009_S8202443, D0_2009_S8320160, D0_2009_S8349509, D0_2010_S8566488, D0_2010_S8570965, D0_2010_S8671338, D0_2010_S8821313, D0_2011_I895662, DELPHI_1995_S3137023, DELPHI_1996_S3430090, DELPHI_1999_S3960137, DELPHI_2000_S4328825, DELPHI_2002_069_CONF_603, DELPHI_2003_WUD_03_11, E735_1998_S3905616, EXAMPLE, EXAMPLE_CUTS, H1_1994_S2919893, H1_1995_S3167097, H1_2000_S4129130, JADE_1998_S3612880, JADE_OPAL_2000_S4300807, LHCB_2010_I867355, LHCB_2010_S8758301, LHCB_2011_I917009, LHCB_2011_I919315, LHCB_2012_I1119400, LHCB_2013_I1208105, LHCB_2013_I1218996, LHCF_2012_I1115479, MC_DIJET, MC_DIPHOTON, MC_GENERIC, MC_HINC, MC_IDENTIFIED, MC_JetAnalysis, MC_JetSplittings, MC_LEADJETUE, MC_PDFS, MC_PHOTONINC, MC_PHOTONJETUE, MC_PHOTONS, MC_PRINTEVENT, MC_SUSY, MC_TTBAR, MC_VH2BB, MC_WINC, MC_WPOL, MC_WWINC, MC_XS, MC_ZINC, MC_ZZINC, OPAL_1993_S2692198, OPAL_1994_S2927284, OPAL_1995_S3198391, OPAL_1996_S3257789, OPAL_1997_S3396100, OPAL_1997_S3608263, OPAL_1998_S3702294, OPAL_1998_S3749908, OPAL_1998_S3780481, OPAL_2000_S4418603, OPAL_2001_S4553896, OPAL_2002_S5361494, OPAL_2004_S6132243, PDG_HADRON_MULTIPLICITIES, PDG_HADRON_MULTIPLICITIES_RATIOS, SFM_1984_S1178091, SLD_1996_S3398250, SLD_1999_S3743934, SLD_2002_S4869273, SLD_2004_S5693039, STAR_2006_S6500200, STAR_2006_S6860818, STAR_2006_S6870392, STAR_2008_S7869363, STAR_2008_S7993412, STAR_2009_UE_HELEN, TASSO_1990_S2148048, TOTEM_2012_002, TOTEM_2012_I1115294, UA1_1990_S2044935, UA5_1982_S875503, UA5_1986_S1583476, UA5_1987_S1640666, UA5_1988_S1867512, UA5_1989_S1926373, and ZEUS_2001_S4815815.

Collaboration diagram for Analysis:

[legend]

List of all members.

Public Member Functions
Analysis &	setCrossSection (double xs)
	Set the cross section from the generator.
AnalysisHandler &	handler () const
	Access the controlling AnalysisHandler object.
const vector< AnalysisObjectPtr > &	analysisObjects () const
	List of registered analysis data objects.
Standard constructors and destructors.
	Analysis (const std::string &name)
	Constructor.
virtual	~Analysis ()
	The destructor.
Main analysis methods
virtual void	init ()
virtual void	analyze (const Event &event)=0
virtual void	finalize ()
Metadata
Metadata is used for querying from the command line and also for building web pages and the analysis pages in the Rivet manual.
const AnalysisInfo &	info () const
	Get the actual AnalysisInfo object in which all this metadata is stored.
virtual std::string	name () const
	Get the name of the analysis.
virtual std::string	inspireId () const
	Get the Inspire ID code for this analysis.
virtual std::string	spiresId () const
	Get the SPIRES ID code for this analysis (~deprecated).
virtual std::vector< std::string >	authors () const
	Names & emails of paper/analysis authors.
virtual std::string	summary () const
	Get a short description of the analysis.
virtual std::string	description () const
	Get a full description of the analysis.
virtual std::string	runInfo () const
	Information about the events needed as input for this analysis.
virtual std::string	experiment () const
	Experiment which performed and published this analysis.
virtual std::string	collider () const
	Collider on which the experiment ran.
virtual std::string	year () const
	When the original experimental analysis was published.
virtual std::vector< std::string >	references () const
	Journal, and preprint references.
virtual std::string	bibKey () const
	BibTeX citation key for this article.
virtual std::string	bibTeX () const
	BibTeX citation entry for this article.
virtual std::string	status () const
	Whether this analysis is trusted (in any way!)
virtual std::vector< std::string >	todos () const
	Any work to be done on this analysis.
virtual const std::vector < PdgIdPair > &	requiredBeams () const
	Return the allowed pairs of incoming beams required by this analysis.
virtual Analysis &	setRequiredBeams (const std::vector< PdgIdPair > &requiredBeams)
	Declare the allowed pairs of incoming beams required by this analysis.
virtual const std::vector < std::pair< double, double > > &	requiredEnergies () const
	Sets of valid beam energy pairs, in GeV.
virtual Analysis &	setRequiredEnergies (const std::vector< std::pair< double, double > > &requiredEnergies)
	Declare the list of valid beam energy pairs, in GeV.
bool	needsCrossSection () const
Analysis &	setNeedsCrossSection (bool needed=true)
Internal metadata modifying methods
AnalysisInfo &	info ()
	Get the actual AnalysisInfo object in which all this metadata is stored (non-const).
Run conditions
const ParticlePair &	beams () const
	Incoming beams for this run.
const PdgIdPair	beamIds () const
	Incoming beam IDs for this run.
double	sqrtS () const
	Centre of mass energy for this run.
Analysis / beam compatibility testing
bool	isCompatible (const ParticlePair &beams) const
	Check if analysis is compatible with the provided beam particle IDs and energies.
bool	isCompatible (PdgId beam1, PdgId beam2, double e1, double e2) const
	Check if analysis is compatible with the provided beam particle IDs and energies.
bool	isCompatible (const PdgIdPair &beams, const std::pair< double, double > &energies) const
	Check if analysis is compatible with the provided beam particle IDs and energies.
Histogram manipulation
Todo: Should really be protected: only public to keep BinnedHistogram happy for now...
void	normalize (Histo1DPtr histo, double norm=1.0, bool includeoverflows=true)
void	scale (Histo1DPtr histo, double scale)
void	divide (Histo1DPtr h1, Histo1DPtr h2, Scatter2DPtr s) const
void	divide (Profile1DPtr p1, Profile1DPtr p2, Scatter2DPtr s) const
void	divide (const YODA::Histo1D &h1, const YODA::Histo1D &h2, Scatter2DPtr s) const
void	divide (const YODA::Profile1D &p1, const YODA::Profile1D &p2, Scatter2DPtr s) const
void	integrate (Histo1DPtr h, Scatter2DPtr s) const
void	integrate (const Histo1D &h, Scatter2DPtr s) const
Projection "getting" functions
std::set< ConstProjectionPtr >	getProjections () 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 Projection &	getProjection (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
Log &	getLog () const
	Get a Log object based on the name() property of the calling analysis object.
double	crossSection () const
	Get the process cross-section in pb. Throws if this hasn't been set.
double	crossSectionPerEvent () const
size_t	numEvents () const
double	sumOfWeights () const
ProjectionHandler &	getProjHandler () const
	Get a reference to the ProjectionHandler for this thread.
Histogram paths
const std::string	histoDir () const
	Get the canonical histogram "directory" path for this analysis.
const std::string	histoPath (const std::string &hname) const
	Get the canonical histogram path for the named histogram in this analysis.
const std::string	histoPath (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get the canonical histogram path for the numbered histogram in this analysis.
const std::string	makeAxisCode (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get the internal histogram name for given d, x and y (cf. HepData)
Histogram reference data
const YODA::Scatter2D &	refData (const string &hname) const
	Get reference data for a named histo.
const YODA::Scatter2D &	refData (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get reference data for a numbered histo.
1D histogram booking
Histo1DPtr	bookHisto1D (const std::string &name, size_t nbins, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram with nbins uniformly distributed across the range lower - upper .
Histo1DPtr	bookHisto1D (const std::string &name, const std::vector< double > &binedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram with non-uniform bins defined by the vector of bin edges binedges .
Histo1DPtr	bookHisto1D (const std::string &name, const Scatter2D &refscatter, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram with binning from a reference scatter.
Histo1DPtr	bookHisto1D (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram, using the binnings in the reference data histogram.
Histo1DPtr	bookHisto1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
1D profile histogram booking
Book a 2D histogram with binning from a reference scatter.
Profile1DPtr	bookProfile1D (const std::string &name, size_t nbins, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram with nbins uniformly distributed across the range lower - upper .
Profile1DPtr	bookProfile1D (const std::string &name, const std::vector< double > &binedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram with non-uniform bins defined by the vector of bin edges binedges .
Profile1DPtr	bookProfile1D (const std::string &name, const Scatter2D &refscatter, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram with binning from a reference scatter.
Profile1DPtr	bookProfile1D (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram, using the binnings in the reference data histogram.
Profile1DPtr	bookProfile1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
2D scatter booking
Book a 2D profile histogram with binning from a reference scatter.
Scatter2DPtr	bookScatter2D (const std::string &name, bool copy_pts=false, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 2-dimensional data point set with the given name.
Scatter2DPtr	bookScatter2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, bool copy_pts=false, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 2-dimensional data point set, using the binnings in the reference data histogram.
Scatter2DPtr	bookScatter2D (const std::string &name, size_t npts, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 2-dimensional data point set with equally spaced x-points in a range.
Scatter2DPtr	bookScatter2D (const std::string &hname, const std::vector< double > &binedges, const std::string &title, const std::string &xtitle, const std::string &ytitle)
	Book a 2-dimensional data point set based on provided contiguous "bin edges".
Data object registration, retrieval, and removal
void	addAnalysisObject (AnalysisObjectPtr ao)
	Register a data object in the histogram system.
template<typename AO >
const shared_ptr< AO >	getAnalysisObject (const std::string &name) const
template<typename AO >
shared_ptr< AO >	getAnalysisObject (const std::string &name)
void	removeAnalysisObject (const std::string &path)
	Unregister a data object from the histogram system (by name)
void	removeAnalysisObject (AnalysisObjectPtr ao)
	Unregister a data object from the histogram system (by pointer)
const Histo1DPtr	getHisto1D (const std::string &name) const
	Get a named Histo1D object from the histogram system.
Histo1DPtr	getHisto1D (const std::string &name)
	Get a named Histo1D object from the histogram system (non-const)
const Histo1DPtr	getHisto1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get a Histo1D object from the histogram system by axis ID codes (non-const)
Histo1DPtr	getHisto1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId)
	Get a Histo1D object from the histogram system by axis ID codes (non-const)
const Profile1DPtr	getProfile1D (const std::string &name) const
	Get a named Profile1D object from the histogram system.
Profile1DPtr	getProfile1D (const std::string &name)
	Get a named Profile1D object from the histogram system (non-const)
const Profile1DPtr	getProfile1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get a Profile1D object from the histogram system by axis ID codes (non-const)
Profile1DPtr	getProfile1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId)
	Get a Profile1D object from the histogram system by axis ID codes (non-const)
const Scatter2DPtr	getScatter2D (const std::string &name) const
	Get a named Scatter2D object from the histogram system.
Scatter2DPtr	getScatter2D (const std::string &name)
	Get a named Scatter2D object from the histogram system (non-const)
const Scatter2DPtr	getScatter2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get a Scatter2D object from the histogram system by axis ID codes (non-const)
Scatter2DPtr	getScatter2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId)
	Get a Scatter2D object from the histogram system by axis ID codes (non-const)
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
Analysis &	operator= (const Analysis &)
Utility functions
void	_cacheRefData () const
	Get the reference data for this paper and cache it.
Private Attributes
string	_defaultname
	Name passed to constructor (used to find .info analysis data file, and as a fallback)
shared_ptr< AnalysisInfo >	_info
	Pointer to analysis metadata object.
vector< AnalysisObjectPtr >	_analysisobjects
AnalysisHandler *	_analysishandler
	The controlling AnalysisHandler object.
std::map< std::string, Scatter2DPtr >	_refdata
Cross-section variables
double	_crossSection
bool	_gotCrossSection
Friends
class	AnalysisHandler
	The AnalysisHandler is a friend.

Detailed Description

This is the base class of all analysis classes in Rivet.

There are three virtual functions which should be implemented in base classes:

void init() is called by Rivet before a run is started. Here the analysis class should book necessary histograms. The needed projections should probably rather be constructed in the constructor.

void analyze(const Event&) is called once for each event. Here the analysis class should apply the necessary Projections and fill the histograms.

void finalize() is called after a run is finished. Here the analysis class should do whatever manipulations are necessary on the histograms. Writing the histograms to a file is, however, done by the Rivet class.

Definition at line 47 of file Analysis.hh.

Constructor & Destructor Documentation

Analysis ( const std::string & name )

Constructor.

Definition at line 13 of file Analysis.cc.

References ProjectionApplier::_allowProjReg, Analysis::_defaultname, Analysis::_info, AnalysisInfo::make(), and Analysis::name().

    : _crossSection(-1.0),
      _gotCrossSection(false),
      _analysishandler(NULL)
  {
    ProjectionApplier::_allowProjReg = false;
    _defaultname = name;

    AnalysisInfo* ai = AnalysisInfo::make(name);
    assert(ai != 0);
    _info.reset(ai);
    assert(_info.get() != 0);
  }

virtual ~Analysis ( ) [inline, virtual]

The destructor.

Definition at line 65 of file Analysis.hh.

{}

Member Function Documentation

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

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;
  }

void _cacheRefData ( ) const [private]

Get the reference data for this paper and cache it.

Definition at line 175 of file Analysis.cc.

References Analysis::_refdata, Rivet::getRefData(), MSG_TRACE, and Analysis::name().

Referenced by Analysis::refData().

                                     {
    if (_refdata.empty()) {
      MSG_TRACE("Getting refdata cache for paper " << name());
      _refdata = getRefData(name());
    }
  }

void addAnalysisObject ( AnalysisObjectPtr ao ) [protected]

Register a data object in the histogram system.

Todo:: 2D versions of integrate... defined how, exactly?!?

Definition at line 592 of file Analysis.cc.

References Analysis::_analysisobjects.

Referenced by Analysis::bookHisto1D(), Analysis::bookProfile1D(), Analysis::bookScatter2D(), and H1_1995_S3167097::finalize().

                                                       {
    _analysisobjects.push_back(ao);
  }

const PROJ& addProjection	(	const PROJ &	proj,
		const std::string &	name
	)		`[inline, protected, inherited]`

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().

                                                                       {
      const Projection& reg = _addProjection(proj, name);
      const PROJ& rtn = dynamic_cast<const PROJ&>(reg);
      return rtn;
    }

const vector<AnalysisObjectPtr>& analysisObjects ( ) const [inline]

List of registered analysis data objects.

Todo:: Add integrate helpers for 2D histos (defined somehow...)

Definition at line 653 of file Analysis.hh.

References Analysis::_analysisobjects.

Referenced by Analysis::getAnalysisObject().

                                                             {
      return _analysisobjects;
    }

virtual void analyze ( const Event & event ) [pure virtual]

Analyze one event. A concrete class should here apply the necessary projections on the event and fill the relevant histograms. An overridden function must make sure it first calls the base class function.

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

const PROJ& applyProjection	(	const Event &	evt,
		const PROJ &	proj
	)		const `[inline, inherited]`

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, inherited]`

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, inherited]`

Apply the named projection on event.

Definition at line 84 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

                                                                               {
      return pcast<PROJ>(_applyProjection(evt, name));
    }

virtual std::vector<std::string> authors ( ) const [inline, virtual]

Names & emails of paper/analysis authors.

Names and email of authors in 'NAME <EMAIL>' format. The first name in the list should be the primary contact person.

Definition at line 132 of file Analysis.hh.

References AnalysisInfo::authors(), and Analysis::info().

                                                 {
      return info().authors();
    }

const PdgIdPair beamIds ( ) const

Incoming beam IDs for this run.

Definition at line 35 of file Analysis.cc.

References AnalysisHandler::beamIds(), and Analysis::handler().

Referenced by UA5_1982_S875503::finalize(), and UA5_1982_S875503::init().

                                          {
    return handler().beamIds();
  }

const ParticlePair & beams ( ) const

Incoming beams for this run.

Definition at line 31 of file Analysis.cc.

References AnalysisHandler::beams(), and Analysis::handler().

Referenced by BABAR_2005_S6181155::analyze(), BABAR_2007_S6895344::analyze(), BELLE_2006_S6265367::analyze(), CLEO_2004_S5809304::analyze(), OPAL_1994_S2927284::analyze(), SLD_2004_S5693039::analyze(), OPAL_1998_S3780481::analyze(), SLD_1999_S3743934::analyze(), OPAL_1995_S3198391::analyze(), OPAL_1997_S3608263::analyze(), OPAL_2000_S4418603::analyze(), ALEPH_2002_S4823664::analyze(), DELPHI_1999_S3960137::analyze(), OPAL_1996_S3257789::analyze(), OPAL_1998_S3702294::analyze(), DELPHI_1995_S3137023::analyze(), SLD_2002_S4869273::analyze(), ALEPH_2001_S4656318::analyze(), DELPHI_2002_069_CONF_603::analyze(), OPAL_1998_S3749908::analyze(), OPAL_1997_S3396100::analyze(), ALEPH_1999_S4193598::analyze(), MC_WPOL::analyze(), ALEPH_1996_S3486095::analyze(), ALEPH_2004_S5765862::analyze(), DELPHI_1996_S3430090::analyze(), MC_WPOL::init(), and Analysis::isCompatible().

                                            {
    return handler().beams();
  }

virtual std::string bibKey ( ) const [inline, virtual]

BibTeX citation key for this article.

Definition at line 185 of file Analysis.hh.

References AnalysisInfo::bibKey(), and Analysis::info().

                                     {
      return info().bibKey();
    }

virtual std::string bibTeX ( ) const [inline, virtual]

BibTeX citation entry for this article.

Definition at line 190 of file Analysis.hh.

References AnalysisInfo::bibTeX(), and Analysis::info().

                                     {
      return info().bibTeX();
    }

Histo1DPtr bookHisto1D	(	const std::string &	name,
		size_t	nbins,
		double	lower,
		double	upper,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D histogram with nbins uniformly distributed across the range lower - upper .

Definition at line 199 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

                                                         {
    const string path = histoPath(hname);
    Histo1DPtr hist( new Histo1D(nbins, lower, upper, path, title) );
    addAnalysisObject(hist);
    MSG_TRACE("Made histogram " << hname <<  " for " << name());
    hist->setAnnotation("XLabel", xtitle);
    hist->setAnnotation("YLabel", ytitle);
    return hist;
  }

Histo1DPtr bookHisto1D	(	const std::string &	name,
		const std::vector< double > &	binedges,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D histogram with non-uniform bins defined by the vector of bin edges binedges .

Definition at line 214 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

                                                         {
    const string path = histoPath(hname);
    Histo1DPtr hist( new Histo1D(binedges, path, title) );
    addAnalysisObject(hist);
    MSG_TRACE("Made histogram " << hname <<  " for " << name());
    hist->setAnnotation("XLabel", xtitle);
    hist->setAnnotation("YLabel", ytitle);
    return hist;
  }

Histo1DPtr bookHisto1D	(	const std::string &	name,
		const Scatter2D &	refscatter,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D histogram with binning from a reference scatter.

Definition at line 229 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

                                                         {
    const string path = histoPath(hname);
    Histo1DPtr hist( new Histo1D(refscatter, path) );
    addAnalysisObject(hist);
    MSG_TRACE("Made histogram " << hname <<  " for " << name());
    hist->setTitle(title);
    hist->setAnnotation("XLabel", xtitle);
    hist->setAnnotation("YLabel", ytitle);
    return hist;
  }

Histo1DPtr bookHisto1D	(	const std::string &	name,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D histogram, using the binnings in the reference data histogram.

Definition at line 245 of file Analysis.cc.

References Analysis::bookHisto1D(), and Analysis::refData().

                                                         {
    const Scatter2D& refdata = refData(hname);
    return bookHisto1D(hname, refdata, title, xtitle, ytitle);
  }

Histo1DPtr bookHisto1D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D histogram, using the binnings in the reference data histogram.

The paper, dataset and x/y-axis IDs will be used to build the histo name in the HepData standard way.

Definition at line 254 of file Analysis.cc.

References Analysis::bookHisto1D(), and Analysis::makeAxisCode().

                                                         {
    const string axisCode = makeAxisCode(datasetId, xAxisId, yAxisId);
    return bookHisto1D(axisCode, title, xtitle, ytitle);
  }

Profile1DPtr bookProfile1D	(	const std::string &	name,
		size_t	nbins,
		double	lower,
		double	upper,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D profile histogram with nbins uniformly distributed across the range lower - upper .

Todo:: Add booking methods which take a path, titles and *a reference Scatter from which to book*

Definition at line 350 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

Referenced by Analysis::bookProfile1D(), ATLAS_2010_S8894728::init(), ATLAS_2011_S8994773::init(), CMS_2012_PAS_QCD_11_010::init(), ALICE_2011_S8945144::init(), ATLAS_2010_S8591806::init(), CDF_2012_NOTE10874::init(), STAR_2008_S7993412::init(), CDF_2008_S7782535::init(), CMS_2012_I1107658::init(), ATLAS_2013_I1243871::init(), D0_1996_S3324664::init(), CDF_2005_S6217184::init(), MC_GENERIC::init(), MC_PHOTONJETUE::init(), ATLAS_2011_S8924791::init(), MC_LEADJETUE::init(), UA1_1990_S2044935::init(), MC_PHOTONS::init(), STAR_2006_S6860818::init(), STAR_2009_UE_HELEN::init(), ALICE_2010_S8706239::init(), MC_WPOL::init(), ALEPH_2001_S4656318::init(), DELPHI_2002_069_CONF_603::init(), CDF_2009_S8233977::init(), CDF_2010_S8591881_DY::init(), CDF_2010_S8591881_QCD::init(), ATLAS_2010_S8918562::init(), CDF_2001_S4751469::init(), DELPHI_1996_S3430090::init(), CDF_2004_S5839831::init(), H1_1994_S2919893::init(), H1_2000_S4129130::init(), ATLAS_2011_S9126244::initializePlots(), and ATLAS_2012_I1125575::initializeProfiles().

                                                             {
    const string path = histoPath(hname);
    Profile1DPtr prof( new Profile1D(nbins, lower, upper, path, title) );
    addAnalysisObject(prof);
    MSG_TRACE("Made profile histogram " << hname <<  " for " << name());
    prof->setAnnotation("XLabel", xtitle);
    prof->setAnnotation("YLabel", ytitle);
    return prof;
  }

Profile1DPtr bookProfile1D	(	const std::string &	name,
		const std::vector< double > &	binedges,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D profile histogram with non-uniform bins defined by the vector of bin edges binedges .

Definition at line 365 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

                                                             {
    const string path = histoPath(hname);
    Profile1DPtr prof( new Profile1D(binedges, path, title) );
    addAnalysisObject(prof);
    MSG_TRACE("Made profile histogram " << hname <<  " for " << name());
    prof->setAnnotation("XLabel", xtitle);
    prof->setAnnotation("YLabel", ytitle);
    return prof;
  }

Profile1DPtr bookProfile1D	(	const std::string &	name,
		const Scatter2D &	refscatter,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D profile histogram with binning from a reference scatter.

Definition at line 380 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

                                                             {
    const string path = histoPath(hname);
    Profile1DPtr prof( new Profile1D(refscatter, path) );
    addAnalysisObject(prof);
    MSG_TRACE("Made profile histogram " << hname <<  " for " << name());
    prof->setTitle(title);
    prof->setAnnotation("XLabel", xtitle);
    prof->setAnnotation("YLabel", ytitle);
    return prof;
  }

Profile1DPtr bookProfile1D	(	const std::string &	name,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D profile histogram, using the binnings in the reference data histogram.

Definition at line 396 of file Analysis.cc.

References Analysis::bookProfile1D(), and Analysis::refData().

                                                             {
    const Scatter2D& refdata = refData(hname);
    return bookProfile1D(hname, refdata, title, xtitle, ytitle);
  }

Profile1DPtr bookProfile1D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 1D profile histogram, using the binnings in the reference data histogram.

The paper, dataset and x/y-axis IDs will be used to build the histo name in the HepData standard way.

Definition at line 405 of file Analysis.cc.

References Analysis::bookProfile1D(), and Analysis::makeAxisCode().

                                                             {
    const string axisCode = makeAxisCode(datasetId, xAxisId, yAxisId);
    return bookProfile1D(axisCode, title, xtitle, ytitle);
  }

Scatter2DPtr bookScatter2D	(	const std::string &	name,
		bool	copy_pts = `false`,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 2-dimensional data point set with the given name.

Note:: Unlike histogram booking, scatter booking by default makes no attempt to use reference data to pre-fill the data object. If you want this, which is sometimes useful e.g. when the x-position is not really meaningful and can't be extracted from the data, then set the copy_pts parameter to true. This creates points to match the reference data's x values and errors, but with the y values and errors zeroed... assuming that there is a reference histo with the same name: if there isn't, an exception will be thrown.

Definition at line 427 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, Analysis::name(), Analysis::refData(), and Rivet::s.

Referenced by Analysis::bookScatter2D(), OPAL_2002_S5361494::finalize(), DELPHI_2000_S4328825::finalize(), BABAR_2007_S7266081::finalize(), LHCB_2011_I917009::finalize(), ARGUS_1993_S2669951::finalize(), ALEPH_2004_S5765862::finalize(), SLD_2004_S5693039::finalize(), ATLAS_2011_S9126244::finalize(), SLD_1999_S3743934::finalize(), ATLAS_2010_S8894728::init(), ALICE_2012_I1181770::init(), LHCB_2013_I1208105::init(), ALICE_2011_S8909580::init(), CMS_2011_S8978280::init(), ATLAS_2011_S9002537::init(), CMS_2011_S9088458::init(), STAR_2006_S6500200::init(), MC_WINC::init(), ATLAS_2011_S9128077::init(), CDF_2008_S7782535::init(), MC_JetSplittings::init(), MC_JetAnalysis::init(), CMS_2012_I1102908::init(), ATLAS_2011_I944826::init(), MC_GENERIC::init(), CDF_2005_S6217184::init(), ATLAS_2011_I945498::init(), CDF_1994_S2952106::init(), D0_2001_S4674421::init(), ATLAS_2012_I1188891::init(), D0_2008_S7837160::init(), STAR_2006_S6860818::init(), MC_XS::init(), CMS_2013_I1218372::init(), CDF_1996_S3418421::init(), UA5_1988_S1867512::init(), CDF_2008_S7541902::init(), ATLAS_2013_I1230812::init(), ATLAS_2012_I1083318::init(), D0_2008_S7719523::init(), LHCB_2012_I1119400::init(), ATLAS_2012_I1093734::init(), SLD_2004_S5693039::init(), SLD_1999_S3743934::init(), ATLAS_2012_I1094568::initializePlots(), ATLAS_2011_S9126244::initializePlots(), and SLD_1996_S3398250::multiplicity_subtract().

                                                             {
    Scatter2DPtr s;
    const string path = histoPath(hname);
    if (copy_pts) {
      const Scatter2D& refdata = refData(hname);
      s.reset( new Scatter2D(refdata, path) );
      foreach (Point2D& p, s->points()) p.setY(0, 0);
    } else {
      s.reset( new Scatter2D(path) );
    }
    addAnalysisObject(s);
    MSG_TRACE("Made scatter " << hname <<  " for " << name());
    s->setTitle(title);
    s->setAnnotation("XLabel", xtitle);
    s->setAnnotation("YLabel", ytitle);
    return s;
  }

Scatter2DPtr bookScatter2D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId,
		bool	copy_pts = `false`,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 2-dimensional data point set, using the binnings in the reference data histogram.

The paper, dataset and x/y-axis IDs will be used to build the histo name in the HepData standard way.

Note:: Unlike histogram booking, scatter booking by default makes no attempt to use reference data to pre-fill the data object. If you want this, which is sometimes useful e.g. when the x-position is not really meaningful and can't be extracted from the data, then set the copy_pts parameter to true. This creates points to match the reference data's x values and errors, but with the y values and errors zeroed.

Definition at line 417 of file Analysis.cc.

References Analysis::bookScatter2D(), and Analysis::makeAxisCode().

                                                             {
    const string axisCode = makeAxisCode(datasetId, xAxisId, yAxisId);
    return bookScatter2D(axisCode, copy_pts, title, xtitle, ytitle);
  }

Scatter2DPtr bookScatter2D	(	const std::string &	name,
		size_t	npts,
		double	lower,
		double	upper,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)		`[protected]`

Book a 2-dimensional data point set with equally spaced x-points in a range.

The y values and errors will be set to 0.

Definition at line 450 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, Analysis::name(), and Rivet::s.

                                                             {
    const string path = histoPath(hname);
    Scatter2DPtr s( new Scatter2D(path) );
    const double binwidth = (upper-lower)/npts;
    for (size_t pt = 0; pt < npts; ++pt) {
      const double bincentre = lower + (pt + 0.5) * binwidth;
      s->addPoint(bincentre, 0, binwidth/2.0, 0);
    }
    addAnalysisObject(s);
    MSG_TRACE("Made scatter " << hname <<  " for " << name());
    s->setTitle(title);
    s->setAnnotation("XLabel", xtitle);
    s->setAnnotation("YLabel", ytitle);
    return s;
  }

Scatter2DPtr bookScatter2D	(	const std::string &	hname,
		const std::vector< double > &	binedges,
		const std::string &	title,
		const std::string &	xtitle,
		const std::string &	ytitle
	)		`[protected]`

Book a 2-dimensional data point set based on provided contiguous "bin edges".

The y values and errors will be set to 0.

Definition at line 471 of file Analysis.cc.

References Analysis::addAnalysisObject(), Analysis::histoPath(), MSG_TRACE, Analysis::name(), and Rivet::s.

                                                             {
    const string path = histoPath(hname);
    Scatter2DPtr s( new Scatter2D(path) );
    for (size_t pt = 0; pt < binedges.size()-1; ++pt) {
      const double bincentre = (binedges[pt] + binedges[pt+1]) / 2.0;
      const double binwidth = binedges[pt+1] - binedges[pt];
      s->addPoint(bincentre, 0, binwidth/2.0, 0);
    }
    addAnalysisObject(s);
    MSG_TRACE("Made scatter " << hname <<  " for " << name());
    s->setTitle(title);
    s->setAnnotation("XLabel", xtitle);
    s->setAnnotation("YLabel", ytitle);
    return s;
  }

virtual std::string collider ( ) const [inline, virtual]

Collider on which the experiment ran.

Definition at line 170 of file Analysis.hh.

References AnalysisInfo::collider(), and Analysis::info().

                                       {
      return info().collider();
    }

double crossSection ( ) const [protected]

Get the process cross-section in pb. Throws if this hasn't been set.

Definition at line 155 of file Analysis.cc.

References Analysis::_crossSection, Analysis::_gotCrossSection, and Analysis::name().

                                      {
    if (!_gotCrossSection || std::isnan(_crossSection)) {
      string errMsg = "You did not set the cross section for the analysis " + name();
      throw Error(errMsg);
    }
    return _crossSection;
  }

double crossSectionPerEvent ( ) const [protected]

Get the process cross-section per generated event in pb. Throws if this hasn't been set.

Definition at line 163 of file Analysis.cc.

References Analysis::_crossSection, and Analysis::sumOfWeights().

Referenced by CDF_2007_S7057202::finalize(), CDF_1988_S1865951::finalize(), LHCB_2011_I919315::finalize(), MC_PHOTONINC::finalize(), MC_PHOTONJETS::finalize(), ATLAS_2010_S8817804::finalize(), ATLAS_2012_I1082936::finalize(), ATLAS_2011_I930220::finalize(), D0_2009_S8349509::finalize(), UA1_1990_S2044935::finalize(), D0_2001_S4674421::finalize(), MC_WPOL::finalize(), ATLAS_2011_S9128077::finalize(), ATLAS_2013_I1230812::finalize(), and ATLAS_2011_I945498::finalize().

                                              {
    const double sumW = sumOfWeights();
    assert(sumW != 0.0);
    return _crossSection / sumW;
  }

virtual std::string description ( ) const [inline, virtual]

Get a full description of the analysis.

Full textual description of this analysis, what it is useful for, what experimental techniques are applied, etc. Should be treated as a chunk of restructuredText (http://docutils.sourceforge.net/rst.html), with equations to be rendered as LaTeX with amsmath operators.

Definition at line 151 of file Analysis.hh.

References AnalysisInfo::description(), and Analysis::info().

                                          {
      return info().description();
    }

void divide	(	Histo1DPtr	h1,
		Histo1DPtr	h2,
		Scatter2DPtr	s
	)		const

Normalize the given histogram, histo, to area = norm.

Note:: The histogram is no longer invalidated by this procedure. Multiplicatively scale the given histogram, histo, by factor scale.; The histogram is no longer invalidated by this procedure. Helper for histogram division.; Preserves the path information of the target.

Definition at line 495 of file Analysis.cc.

Referenced by D0_2008_S7837160::calc_asymm(), CMS_2011_S9088458::finalize(), CDF_1996_S3418421::finalize(), ALICE_2011_S8909580::finalize(), STAR_2006_S6500200::finalize(), CMS_2011_S8978280::finalize(), MC_WINC::finalize(), ALICE_2012_I1181770::finalize(), LHCB_2011_I917009::finalize(), MC_GENERIC::finalize(), D0_2008_S7719523::finalize(), STAR_2006_S6860818::finalize(), CMS_2013_I1218372::finalize(), ATLAS_2011_S9128077::finalize(), ATLAS_2012_I1188891::finalize(), LHCB_2012_I1119400::finalize(), ATLAS_2011_I944826::finalize(), SLD_2004_S5693039::finalize(), ATLAS_2011_S9126244::finalize(), and SLD_1999_S3743934::finalize().

                                                                          {
    // preserve the path info
    const string path = s->path();
    *s = *h1 / *h2;
    s->setPath(path);
  }

void divide	(	Profile1DPtr	p1,
		Profile1DPtr	p2,
		Scatter2DPtr	s
	)		const

Helper for profile histogram division.

Note:: Preserves the path information of the target.

void divide	(	const YODA::Histo1D &	h1,
		const YODA::Histo1D &	h2,
		Scatter2DPtr	s
	)		const

Helper for histogram division.

Note:: Preserves the path information of the target.

Definition at line 509 of file Analysis.cc.

                                                                                  {
    // preserve the path info
    const string path = s->path();
    *s = h1 / h2;
    s->setPath(path);
  }

void divide	(	const YODA::Profile1D &	p1,
		const YODA::Profile1D &	p2,
		Scatter2DPtr	s
	)		const

Helper for profile histogram division

Note:: Preserves the path information of the target.

Definition at line 516 of file Analysis.cc.

                                                                                      {
    // preserve the path info
    const string path = s->path();
    *s = p1 / p2;
    s->setPath(path);
  }

virtual std::string experiment ( ) const [inline, virtual]

Experiment which performed and published this analysis.

Definition at line 165 of file Analysis.hh.

References AnalysisInfo::experiment(), and Analysis::info().

                                         {
      return info().experiment();
    }

virtual void finalize ( ) [inline, virtual]

Finalize this analysis object. A concrete class should here make all necessary operations on the histograms. Writing the histograms to a file is, however, done by the Rivet class. An overridden function must make sure it first calls the base class function.

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

Definition at line 91 of file Analysis.hh.

{ }

const shared_ptr<AO> getAnalysisObject ( const std::string & name ) const [inline, protected]

Get a data object from the histogram system

Todo:: Use this default function template arg in C++11

Definition at line 670 of file Analysis.hh.

References Analysis::analysisObjects(), and Analysis::histoPath().

                                                                        {
      foreach (const AnalysisObjectPtr& ao, analysisObjects()) {
        if (ao->path() == histoPath(name)) return dynamic_pointer_cast<AO>(ao);
      }
      throw Exception("Data object " + histoPath(name) + " not found");
    }

shared_ptr<AO> getAnalysisObject ( const std::string & name ) [inline, protected]

Get a data object from the histogram system (non-const)

Todo:: Use this default function template arg in C++11

Definition at line 681 of file Analysis.hh.

References Analysis::analysisObjects(), and Analysis::histoPath().

                                                            {
      foreach (const AnalysisObjectPtr& ao, analysisObjects()) {
        if (ao->path() == histoPath(name)) return dynamic_pointer_cast<AO>(ao);
      }
      throw Exception("Data object " + histoPath(name) + " not found");
    }

const Histo1DPtr getHisto1D ( const std::string & name ) const [inline, protected]

Get a named Histo1D object from the histogram system.

Definition at line 696 of file Analysis.hh.

References Analysis::name().

                                                             {
      return getAnalysisObject<Histo1D>(name);
    }

Histo1DPtr getHisto1D ( const std::string & name ) [inline, protected]

Get a named Histo1D object from the histogram system (non-const)

Definition at line 701 of file Analysis.hh.

References Analysis::name().

                                                 {
      return getAnalysisObject<Histo1D>(name);
    }

const Histo1DPtr getHisto1D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		const `[inline, protected]`

Get a Histo1D object from the histogram system by axis ID codes (non-const)

Definition at line 706 of file Analysis.hh.

References Analysis::makeAxisCode().

                                                                                                          {
      return getAnalysisObject<Histo1D>(makeAxisCode(datasetId, xAxisId, yAxisId));
    }

Histo1DPtr getHisto1D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		`[inline, protected]`

Get a Histo1D object from the histogram system by axis ID codes (non-const)

Definition at line 711 of file Analysis.hh.

References Analysis::makeAxisCode().

                                                                                              {
      return getAnalysisObject<Histo1D>(makeAxisCode(datasetId, xAxisId, yAxisId));
    }

Log & getLog ( ) const [protected]

Get a Log object based on the name() property of the calling analysis object.

Reimplemented from ProjectionApplier.

Definition at line 82 of file Analysis.cc.

References Analysis::name().

                              {
    string logname = "Rivet.Analysis." + name();
    return Log::getLog(logname);
  }

const Profile1DPtr getProfile1D ( const std::string & name ) const [inline, protected]

Get a named Profile1D object from the histogram system.

Definition at line 738 of file Analysis.hh.

References Analysis::name().

                                                                 {
      return getAnalysisObject<Profile1D>(name);
    }

Profile1DPtr getProfile1D ( const std::string & name ) [inline, protected]

Get a named Profile1D object from the histogram system (non-const)

Definition at line 743 of file Analysis.hh.

References Analysis::name().

                                                     {
      return getAnalysisObject<Profile1D>(name);
    }

const Profile1DPtr getProfile1D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		const `[inline, protected]`

Get a Profile1D object from the histogram system by axis ID codes (non-const)

Definition at line 748 of file Analysis.hh.

References Analysis::makeAxisCode().

                                                                                                              {
      return getAnalysisObject<Profile1D>(makeAxisCode(datasetId, xAxisId, yAxisId));
    }

Profile1DPtr getProfile1D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		`[inline, protected]`

Get a Profile1D object from the histogram system by axis ID codes (non-const)

Definition at line 753 of file Analysis.hh.

References Analysis::makeAxisCode().

                                                                                                  {
      return getAnalysisObject<Profile1D>(makeAxisCode(datasetId, xAxisId, yAxisId));
    }

const PROJ& getProjection ( const std::string & name ) const [inline, inherited]

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, inherited]

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, inherited]

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().

                                                      {
      return getProjHandler().getChildProjections(*this, ProjectionHandler::DEEP);
    }

ProjectionHandler& getProjHandler ( ) const [inline, protected, inherited]

Get a reference to the ProjectionHandler for this thread.

Definition at line 97 of file ProjectionApplier.hh.

References ProjectionApplier::_projhandler.

Referenced by ProjectionApplier::_addProjection(), ProjectionApplier::getProjection(), ProjectionApplier::getProjections(), and ProjectionApplier::~ProjectionApplier().

                                              {
      return _projhandler;
    }

const Scatter2DPtr getScatter2D ( const std::string & name ) const [inline, protected]

Get a named Scatter2D object from the histogram system.

Definition at line 780 of file Analysis.hh.

References Analysis::name().

                                                                 {
      return getAnalysisObject<Scatter2D>(name);
    }

Scatter2DPtr getScatter2D ( const std::string & name ) [inline, protected]

Get a named Scatter2D object from the histogram system (non-const)

Definition at line 785 of file Analysis.hh.

References Analysis::name().

                                                     {
      return getAnalysisObject<Scatter2D>(name);
    }

const Scatter2DPtr getScatter2D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		const `[inline, protected]`

Get a Scatter2D object from the histogram system by axis ID codes (non-const)

Definition at line 790 of file Analysis.hh.

References Analysis::makeAxisCode().

                                                                                                              {
      return getAnalysisObject<Scatter2D>(makeAxisCode(datasetId, xAxisId, yAxisId));
    }

Scatter2DPtr getScatter2D	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		`[inline, protected]`

Get a Scatter2D object from the histogram system by axis ID codes (non-const)

Definition at line 795 of file Analysis.hh.

References Analysis::makeAxisCode().

                                                                                                  {
      return getAnalysisObject<Scatter2D>(makeAxisCode(datasetId, xAxisId, yAxisId));
    }

AnalysisHandler& handler ( ) const [inline]

Access the controlling AnalysisHandler object.

Definition at line 288 of file Analysis.hh.

References Analysis::_analysishandler.

Referenced by Analysis::beamIds(), Analysis::beams(), Analysis::histoDir(), Analysis::numEvents(), Analysis::sqrtS(), and Analysis::sumOfWeights().

{ return *_analysishandler; }

const string histoDir ( ) const [protected]

Get the canonical histogram "directory" path for this analysis.

Todo:: Cache in a member variable

Definition at line 40 of file Analysis.cc.

References Analysis::handler(), Analysis::name(), and AnalysisHandler::runName().

Referenced by Analysis::histoPath().

                                        {
    /// @todo Cache in a member variable
    string _histoDir;
    if (_histoDir.empty()) {
      _histoDir = "/" + name();
      if (handler().runName().length() > 0) {
        _histoDir = "/" + handler().runName() + _histoDir;
      }
      while (find_first(_histoDir, "//")) {
        replace_all(_histoDir, "//", "/");
      }
    }
    return _histoDir;
  }

const string histoPath ( const std::string & hname ) const [protected]

Get the canonical histogram path for the named histogram in this analysis.

Definition at line 56 of file Analysis.cc.

References Analysis::histoDir().

Referenced by Analysis::bookHisto1D(), Analysis::bookProfile1D(), Analysis::bookScatter2D(), H1_1995_S3167097::finalize(), and Analysis::getAnalysisObject().

                                                            {
    const string path = histoDir() + "/" + hname;
    return path;
  }

const string histoPath	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		const `[protected]`

Get the canonical histogram path for the numbered histogram in this analysis.

Definition at line 62 of file Analysis.cc.

References Analysis::histoDir(), and Analysis::makeAxisCode().

                                                                                                           {
    return histoDir() + "/" + makeAxisCode(datasetId, xAxisId, yAxisId);
  }

const AnalysisInfo& info ( ) const [inline]

Get the actual AnalysisInfo object in which all this metadata is stored.

Definition at line 104 of file Analysis.hh.

References Analysis::_info.

Referenced by Analysis::authors(), Analysis::bibKey(), Analysis::bibTeX(), Analysis::collider(), Analysis::description(), Analysis::experiment(), Analysis::inspireId(), Analysis::name(), Analysis::needsCrossSection(), Analysis::references(), Analysis::requiredBeams(), Analysis::requiredEnergies(), Analysis::runInfo(), Analysis::setNeedsCrossSection(), Analysis::setRequiredBeams(), Analysis::setRequiredEnergies(), Analysis::spiresId(), Analysis::status(), Analysis::summary(), Analysis::todos(), and Analysis::year().

                                     {
      assert(_info.get() != 0 && "No AnalysisInfo object :O");
      return *_info;
    }

AnalysisInfo& info ( ) [inline]

Get the actual AnalysisInfo object in which all this metadata is stored (non-const).

Definition at line 246 of file Analysis.hh.

References Analysis::_info.

                         {
      assert(_info.get() != 0 && "No AnalysisInfo object :O");
      return *_info;
    }

virtual void init ( ) [inline, virtual]

Initialize this analysis object. A concrete class should here book all necessary histograms. An overridden function must make sure it first calls the base class function.

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

Definition at line 78 of file Analysis.hh.

{ }

virtual std::string inspireId ( ) const [inline, virtual]

Get the Inspire ID code for this analysis.

Definition at line 119 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::inspireId().

                                        {
      return info().inspireId();
    }

void integrate	(	Histo1DPtr	h,
		Scatter2DPtr	s
	)		const

Helper for converting a differential histo to an integral one.

Note:: Preserves the path information of the target.

Todo:: 2D versions of scale and normalize...

Definition at line 571 of file Analysis.cc.

                                                             {
    // preserve the path info
    const string path = s->path();
    *s = toIntegralHisto(*h);
    s->setPath(path);
  }

void integrate	(	const Histo1D &	h,
		Scatter2DPtr	s
	)		const

Helper for converting a differential histo to an integral one.

Note:: Preserves the path information of the target.

Definition at line 578 of file Analysis.cc.

                                                                 {
    // preserve the path info
    const string path = s->path();
    *s = toIntegralHisto(h);
    s->setPath(path);
  }

bool isCompatible ( const ParticlePair & beams ) const

Check if analysis is compatible with the provided beam particle IDs and energies.

Definition at line 101 of file Analysis.cc.

Referenced by Analysis::isCompatible().

                                                             {
    return isCompatible(beams.first.pdgId(),  beams.second.pdgId(),
                        beams.first.energy(), beams.second.energy());
  }

bool isCompatible	(	PdgId	beam1,
		PdgId	beam2,
		double	e1,
		double	e2
	)		const

Check if analysis is compatible with the provided beam particle IDs and energies.

Definition at line 107 of file Analysis.cc.

References Analysis::beams(), and Analysis::isCompatible().

                                                                                  {
    PdgIdPair beams(beam1, beam2);
    pair<double,double> energies(e1, e2);
    return isCompatible(beams, energies);
  }

bool isCompatible	(	const PdgIdPair &	beams,
		const std::pair< double, double > &	energies
	)		const

Check if analysis is compatible with the provided beam particle IDs and energies.

const string makeAxisCode	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		const `[protected]`

Get the internal histogram name for given d, x and y (cf. HepData)

Definition at line 67 of file Analysis.cc.

Referenced by Analysis::bookHisto1D(), Analysis::bookProfile1D(), Analysis::bookScatter2D(), Analysis::getHisto1D(), Analysis::getProfile1D(), Analysis::getScatter2D(), Analysis::histoPath(), and Analysis::refData().

                                                                                                              {
    stringstream axisCode;
    axisCode << "d";
    if (datasetId < 10) axisCode << 0;
    axisCode << datasetId;
    axisCode << "-x";
    if (xAxisId < 10) axisCode << 0;
    axisCode << xAxisId;
    axisCode << "-y";
    if (yAxisId < 10) axisCode << 0;
    axisCode << yAxisId;
    return axisCode.str();
  }

virtual std::string name ( ) const [inline, virtual]

Get the name of the analysis.

By default this is computed by combining the results of the experiment, year and Spires ID metadata methods and you should only override it if there's a good reason why those won't work.

Implements ProjectionApplier.

Definition at line 114 of file Analysis.hh.

References Analysis::_defaultname, Analysis::info(), and AnalysisInfo::name().

Referenced by Analysis::_cacheRefData(), Analysis::Analysis(), Analysis::bookHisto1D(), Analysis::bookProfile1D(), Analysis::bookScatter2D(), Analysis::crossSection(), Analysis::getHisto1D(), Analysis::getLog(), Analysis::getProfile1D(), Analysis::getScatter2D(), Analysis::histoDir(), Analysis::normalize(), Analysis::refData(), and Analysis::scale().

                                   {
      return (info().name().empty()) ? _defaultname : info().name();
    }

bool needsCrossSection ( ) const [inline]

Return true if this analysis needs to know the process cross-section.

Todo:: Remove this and require HepMC >= 2.06

Definition at line 229 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::needsCrossSection().

                                   {
      return info().needsCrossSection();
    }

void normalize	(	Histo1DPtr	histo,
		double	norm = `1.0`,
		bool	includeoverflows = `true`
	)

Normalize the given histogram, histo, to area = norm.

Note:: The histogram is no longer invalidated by this procedure.

Definition at line 523 of file Analysis.cc.

References MSG_ERROR, MSG_TRACE, MSG_WARNING, and Analysis::name().

Referenced by CMS_2011_S8950903::finalize(), TOTEM_2012_002::finalize(), D0_2010_S8671338::finalize(), CMS_2011_S8968497::finalize(), D0_2007_S7075677::finalize(), D0_2008_S7554427::finalize(), CDF_2009_NOTE_9936::finalize(), MC_HINC::finalize(), MC_HJETS::finalize(), MC_ZJETS::finalize(), EXAMPLE_CUTS::finalize(), BABAR_2005_S6181155::finalize(), MC_ZINC::finalize(), ALICE_2010_S8624100::finalize(), ATLAS_2011_S8971293::finalize(), ALICE_2010_S8625980::finalize(), CDF_1996_S3418421::finalize(), D0_2009_S8320160::finalize(), CMS_2011_S8957746::finalize(), ATLAS_2012_I1119557::finalize(), DELPHI_1995_S3137023::finalize(), CDF_1993_S2742446::finalize(), D0_1996_S3324664::finalize(), D0_2010_S8821313::finalize(), SLD_2002_S4869273::finalize(), MC_ZZJETS::finalize(), D0_2008_S6879055::finalize(), ATLAS_2012_I1204784::finalize(), CDF_1996_S3108457::finalize(), EXAMPLE::finalize(), ATLAS_2011_I954993::finalize(), CDF_1994_S2952106::finalize(), ATLAS_2011_I925932::finalize(), JADE_1998_S3612880::finalize(), CMS_2013_I1224539_DIJET::finalize(), D0_1996_S3214044::finalize(), ALEPH_2001_S4656318::finalize(), DELPHI_2002_069_CONF_603::finalize(), D0_2004_S5992206::finalize(), OPAL_1997_S3396100::finalize(), MC_PHOTONS::finalize(), CDF_2008_S7541902::finalize(), MC_GENERIC::finalize(), D0_2001_S4674421::finalize(), MC_ZZINC::finalize(), OPAL_2001_S4553896::finalize(), CMS_2013_I1209721::finalize(), ATLAS_2013_I1217867::finalize(), CMS_2012_I1107658::finalize(), TASSO_1990_S2148048::finalize(), STAR_2008_S7869363::finalize(), OPAL_1998_S3780481::finalize(), CMS_2013_I1224539_WJET::finalize(), CMS_2013_I1224539_ZJET::finalize(), CDF_1997_S3541940::finalize(), DELPHI_2003_WUD_03_11::finalize(), JADE_OPAL_2000_S4300807::finalize(), H1_1994_S2919893::finalize(), BELLE_2006_S6265367::finalize(), CDF_2001_S4751469::finalize(), MC_TTBAR::finalize(), ALEPH_2004_S5765862::finalize(), CDF_2004_S5839831::finalize(), CDF_1996_S3349578::finalize(), ATLAS_2012_I1094564::finalize(), ALEPH_1996_S3486095::finalize(), DELPHI_1996_S3430090::finalize(), CMS_2013_I1258128::normalizeByContents(), and ATLAS_2011_I919017::safeinvscale().

                                                                               {
    if (!histo) {
      MSG_ERROR("Failed to normalize histo=NULL in analysis " << name() << " (norm=" << norm << ")");
      return;
    }
    MSG_TRACE("Normalizing histo " << histo->path() << " to " << norm);
    try {
      histo->normalize(norm, includeoverflows);
    } catch (YODA::Exception& we) {
      MSG_WARNING("Could not normalize histo " << histo->path());
      return;
    }
  }

size_t numEvents ( ) const [protected]

Get the number of events seen (via the analysis handler). Use in the finalize phase only.

Definition at line 88 of file Analysis.cc.

References Analysis::handler(), and AnalysisHandler::numEvents().

Referenced by STAR_2008_S7993412::analyze(), STAR_2006_S6870392::analyze(), CDF_2008_S7540469::analyze(), D0_2008_S7863608::analyze(), and D0_2009_S8349509::analyze().

                                   {
    return handler().numEvents();
  }

Analysis& operator= ( const Analysis & ) [private]

The assignment operator is private and must never be called. In fact, it should not even be implemented.

const Scatter2D & refData ( const string & hname ) const [protected]

Get reference data for a named histo.

Definition at line 183 of file Analysis.cc.

References Analysis::_cacheRefData(), Analysis::_refdata, MSG_ERROR, MSG_TRACE, and Analysis::name().

Referenced by ATLAS_2011_S8994773::analyze(), CDF_2001_S4751469::analyze(), ATLAS_2010_S8894728::analyze(), Analysis::bookHisto1D(), Analysis::bookProfile1D(), Analysis::bookScatter2D(), DELPHI_2000_S4328825::finalize(), OPAL_2002_S5361494::finalize(), ATLAS_2011_S9128077::finalize(), ALEPH_2004_S5765862::finalize(), ATLAS_2010_S8894728::init(), ALICE_2011_S8909580::init(), LHCB_2013_I1208105::init(), ATLAS_2011_S9002537::init(), CMS_2011_S9088458::init(), STAR_2006_S6500200::init(), ATLAS_2011_S9128077::init(), CMS_2012_I1102908::init(), CDF_1994_S2952106::init(), D0_2008_S7837160::init(), CDF_1996_S3418421::init(), LHCB_2011_I917009::init(), ATLAS_2012_I1093734::init(), SLD_1999_S3743934::init(), ATLAS_2012_I1125575::initializeHistograms(), ATLAS_2012_I1094568::initializePlots(), ATLAS_2011_S9126244::initializePlots(), and Analysis::refData().

                                                              {
    _cacheRefData();
    MSG_TRACE("Using histo bin edges for " << name() << ":" << hname);
    if (!_refdata[hname]) {
      MSG_ERROR("Can't find reference histogram " << hname);
    }
    return *_refdata[hname];
  }

const Scatter2D & refData	(	unsigned int	datasetId,
		unsigned int	xAxisId,
		unsigned int	yAxisId
	)		const `[protected]`

Get reference data for a numbered histo.

Definition at line 193 of file Analysis.cc.

References Analysis::makeAxisCode(), and Analysis::refData().

                                                                                                             {
    const string hname = makeAxisCode(datasetId, xAxisId, yAxisId);
    return refData(hname);
  }

virtual std::vector<std::string> references ( ) const [inline, virtual]

Journal, and preprint references.

Definition at line 180 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::references().

                                                    {
      return info().references();
    }

void removeAnalysisObject ( const std::string & path ) [protected]

Unregister a data object from the histogram system (by name)

Definition at line 596 of file Analysis.cc.

References Analysis::_analysisobjects.

                                                        {
    for (vector<AnalysisObjectPtr>::iterator it = _analysisobjects.begin();  it != _analysisobjects.end(); ++it) {
      if ((*it)->path() == path) {
        _analysisobjects.erase(it);
        break;
      }
    }
  }

void removeAnalysisObject ( AnalysisObjectPtr ao ) [protected]

Unregister a data object from the histogram system (by pointer)

Definition at line 605 of file Analysis.cc.

References Analysis::_analysisobjects.

                                                          {
    for (vector<AnalysisObjectPtr>::iterator it = _analysisobjects.begin();  it != _analysisobjects.end(); ++it) {
      if (*it == ao) {
        _analysisobjects.erase(it);
        break;
      }
    }
 }

virtual const std::vector<PdgIdPair>& requiredBeams ( ) const [inline, virtual]

Return the allowed pairs of incoming beams required by this analysis.

Definition at line 206 of file Analysis.hh.

References AnalysisInfo::beams(), and Analysis::info().

                                                              {
      return info().beams();
    }

virtual const std::vector<std::pair<double, double> >& requiredEnergies ( ) const [inline, virtual]

Sets of valid beam energy pairs, in GeV.

Definition at line 217 of file Analysis.hh.

References AnalysisInfo::energies(), and Analysis::info().

Referenced by Analysis::setRequiredEnergies().

                                                                                {
      return info().energies();
    }

virtual std::string runInfo ( ) const [inline, virtual]

Information about the events needed as input for this analysis.

Event types, energies, kinematic cuts, particles to be considered stable, etc. etc. Should be treated as a restructuredText bullet list (http://docutils.sourceforge.net/rst.html)

Definition at line 160 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::runInfo().

                                      {
      return info().runInfo();
    }

void scale	(	Histo1DPtr	histo,
		double	scale
	)

Multiplicatively scale the given histogram, histo, by factor scale.

Note:: The histogram is no longer invalidated by this procedure.

Definition at line 538 of file Analysis.cc.

References MSG_ERROR, MSG_TRACE, MSG_WARNING, and Analysis::name().

                                                     {
    if (!histo) {
      MSG_ERROR("Failed to scale histo=NULL in analysis " << name() << " (scale=" << scale << ")");
      return;
    }
    if (std::isnan(scale) || std::isinf(scale)) {
      MSG_ERROR("Failed to scale histo=" << histo->path() << " in analysis: " << name() << " (invalid scale factor = " << scale << ")");
      scale = 0;
    }
    MSG_TRACE("Scaling histo " << histo->path() << " by factor " << scale);
    try {
      histo->scaleW(scale);
    } catch (YODA::Exception& we) {
      MSG_WARNING("Could not scale histo " << histo->path());
      return;
    }
    // // Transforming the histo into a scatter after scaling
    // vector<double> x, y, ex, ey;
    // for (size_t i = 0, N = histo->numBins(); i < N; ++i) {
    //   x.push_back( histo->bin(i).midpoint() );
    //   ex.push_back(histo->bin(i).width()*0.5);
    //   y.push_back(histo->bin(i).height()*scale);
    //   ey.push_back(histo->bin(i).heightErr()*scale);
    // }
    // string title = histo->title();
    // Scatter2DPtr dps( new Scatter2D(x, y, ex, ey, hpath, title) );
    // addAnalysisObject(dps);
  }

Analysis & setCrossSection ( double xs )

Set the cross section from the generator.

Definition at line 149 of file Analysis.cc.

References Analysis::_crossSection, and Analysis::_gotCrossSection.

                                               {
    _crossSection = xs;
    _gotCrossSection = true;
    return *this;
  }

Analysis& setNeedsCrossSection ( bool needed = true ) [inline]

Declare whether this analysis needs to know the process cross-section from the generator.

Todo:: Remove this and require HepMC >= 2.06

Definition at line 234 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::setNeedsCrossSection().

Referenced by ATLAS_2011_I954993::ATLAS_2011_I954993(), MC_JetAnalysis::MC_JetAnalysis(), and MC_JetSplittings::MC_JetSplittings().

                                                     {
      info().setNeedsCrossSection(needed);
      return *this;
    }

virtual Analysis& setRequiredBeams ( const std::vector< PdgIdPair > & requiredBeams ) [inline, virtual]

Declare the allowed pairs of incoming beams required by this analysis.

Definition at line 210 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::setBeams().

                                                                                  {
      info().setBeams(requiredBeams);
      return *this;
    }

virtual Analysis& setRequiredEnergies ( const std::vector< std::pair< double, double > > & requiredEnergies ) [inline, virtual]

Declare the list of valid beam energy pairs, in GeV.

Definition at line 221 of file Analysis.hh.

References Analysis::info(), Analysis::requiredEnergies(), and AnalysisInfo::setEnergies().

                                                                                                       {
      info().setEnergies(requiredEnergies);
      return *this;
    }

virtual std::string spiresId ( ) const [inline, virtual]

Get the SPIRES ID code for this analysis (~deprecated).

Definition at line 124 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::spiresId().

                                       {
      return info().spiresId();
    }

double sqrtS ( ) const

Centre of mass energy for this run.

Definition at line 27 of file Analysis.cc.

References Analysis::handler(), and AnalysisHandler::sqrtS().

Referenced by ATLAS_2011_I894867::analyze(), PDG_HADRON_MULTIPLICITIES::analyze(), PDG_HADRON_MULTIPLICITIES_RATIOS::analyze(), CMS_2012_I1193338::analyze(), TOTEM_2012_002::analyze(), SLD_2004_S5693039::analyze(), CMS_2012_I1184941::analyze(), CMS_2011_I954992::analyze(), ALICE_2012_I1181770::analyze(), CMS_2011_S9215166::analyze(), SFM_1984_S1178091::analyze(), ALICE_2010_S8625980::analyze(), UA1_1990_S2044935::analyze(), CMS_2013_I1218372::analyze(), JADE_1998_S3612880::analyze(), TASSO_1990_S2148048::analyze(), MC_TTBAR::analyze(), ATLAS_2010_S8894728::analyze(), ATLAS_2010_S8918562::analyze(), ALEPH_2004_S5765862::analyze(), CDF_2004_S5839831::analyze(), ALICE_2010_S8625980::finalize(), DELPHI_2000_S4328825::finalize(), OPAL_2002_S5361494::finalize(), JADE_1998_S3612880::finalize(), UA1_1990_S2044935::finalize(), ATLAS_2010_S8918562::finalize(), ATLAS_2012_I1093734::finalize(), ALEPH_2004_S5765862::finalize(), CDF_2004_S5839831::finalize(), PDG_HADRON_MULTIPLICITIES_RATIOS::finalize(), PDG_HADRON_MULTIPLICITIES::finalize(), ATLAS_2010_S8894728::init(), CMS_2010_S8547297::init(), ALICE_2012_I1181770::init(), ATLAS_2011_S8994773::init(), CMS_2011_S8978280::init(), CMS_2011_S9215166::init(), CDF_2012_NOTE10874::init(), CMS_QCD_10_024::init(), MC_DIPHOTON::init(), MC_HINC::init(), SFM_1984_S1178091::init(), MC_WINC::init(), MC_ZINC::init(), MC_ZZINC::init(), ATLAS_2012_I1091481::init(), UA5_1989_S1926373::init(), MC_WWINC::init(), MC_JetSplittings::init(), MC_PHOTONINC::init(), MC_ZZJETS::init(), ATLAS_2011_I944826::init(), MC_JetAnalysis::init(), MC_WWJETS::init(), UA5_1986_S1583476::init(), CDF_1990_S2089246::init(), CDF_1988_S1865951::init(), UA1_1990_S2044935::init(), JADE_OPAL_2000_S4300807::init(), ALICE_2010_S8624100::init(), JADE_1998_S3612880::init(), MC_PHOTONS::init(), ALEPH_2004_S5765862::init(), CMS_2013_I1218372::init(), ALICE_2010_S8625980::init(), MC_WPOL::init(), UA5_1988_S1867512::init(), TASSO_1990_S2148048::init(), LHCB_2011_I917009::init(), ATLAS_2010_S8918562::init(), LHCB_2012_I1119400::init(), OPAL_2004_S6132243::init(), CDF_2004_S5839831::init(), ATLAS_2012_I1093734::init(), PDG_HADRON_MULTIPLICITIES::init(), and PDG_HADRON_MULTIPLICITIES_RATIOS::init().

                               {
    return handler().sqrtS();
  }

virtual std::string status ( ) const [inline, virtual]

Whether this analysis is trusted (in any way!)

Definition at line 195 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::status().

                                     {
      return (info().status().empty()) ? "UNVALIDATED" : info().status();
    }

virtual std::string summary ( ) const [inline, virtual]

Get a short description of the analysis.

Short (one sentence) description used as an index entry. Use description() to provide full descriptive paragraphs of analysis details.

Definition at line 141 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::summary().

                                      {
      return info().summary();
    }

double sumOfWeights ( ) const [protected]

Get the sum of event weights seen (via the analysis handler). Use in the finalize phase only.

Definition at line 93 of file Analysis.cc.

References Analysis::handler(), and AnalysisHandler::sumOfWeights().

                                      {
    return handler().sumOfWeights();
  }

virtual std::vector<std::string> todos ( ) const [inline, virtual]

Any work to be done on this analysis.

Definition at line 200 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::todos().

                                               {
      return info().todos();
    }

virtual std::string year ( ) const [inline, virtual]

When the original experimental analysis was published.

Definition at line 175 of file Analysis.hh.

References Analysis::info(), and AnalysisInfo::year().

                                   {
      return info().year();
    }

Friends And Related Function Documentation

friend class AnalysisHandler [friend]

The AnalysisHandler is a friend.

Definition at line 50 of file Analysis.hh.

Member Data Documentation

bool _allowProjReg [protected, inherited]

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().

AnalysisHandler* _analysishandler [private]

The controlling AnalysisHandler object.

Definition at line 821 of file Analysis.hh.

Referenced by AnalysisHandler::addAnalysis(), and Analysis::handler().

vector<AnalysisObjectPtr> _analysisobjects [private]

Storage of all plot objects

Todo:: Make this a map for fast lookup by path?

Definition at line 812 of file Analysis.hh.

Referenced by Analysis::addAnalysisObject(), Analysis::analysisObjects(), and Analysis::removeAnalysisObject().

double _crossSection [private]

Definition at line 816 of file Analysis.hh.

Referenced by Analysis::crossSection(), Analysis::crossSectionPerEvent(), and Analysis::setCrossSection().

string _defaultname [private]

Name passed to constructor (used to find .info analysis data file, and as a fallback)

Definition at line 805 of file Analysis.hh.

Referenced by Analysis::Analysis(), and Analysis::name().

bool _gotCrossSection [private]

Definition at line 817 of file Analysis.hh.

Referenced by Analysis::crossSection(), and Analysis::setCrossSection().

shared_ptr<AnalysisInfo> _info [private]

Pointer to analysis metadata object.

Definition at line 808 of file Analysis.hh.

Referenced by Analysis::Analysis(), and Analysis::info().

std::map<std::string, Scatter2DPtr> _refdata [mutable, private]

Collection of cached refdata to speed up many autobookings: the reference data file should only be read once.

Definition at line 825 of file Analysis.hh.

Referenced by Analysis::_cacheRefData(), and Analysis::refData().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation