Analysis Class Reference

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_2004_S5765862, ALICE_2010_S8624100, ALICE_2010_S8625980, ALICE_2010_S8706239, ALICE_2011_S8909580, ALICE_2011_S8945144, 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_I919017, ATLAS_2011_I925932, ATLAS_2011_S8924791, ATLAS_2011_S8971293, ATLAS_2011_S8983313, ATLAS_2011_S8994773, ATLAS_2011_S9002537, ATLAS_2011_S9019561, ATLAS_2011_S9041966, ATLAS_2011_S9108483, ATLAS_2011_S9120807, ATLAS_2011_S9126244, ATLAS_2011_S9128077, ATLAS_2011_S9131140, ATLAS_2011_S9212183, ATLAS_2011_S9225137, 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_LEADINGJETS, CDF_2008_NOTE_9351, 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, CMS_2010_S8547297, CMS_2010_S8656010, CMS_2011_S8884919, CMS_2011_S8950903, CMS_2011_S8957746, CMS_2011_S8968497, CMS_2011_S8978280, CMS_2011_S9086218, CMS_2011_S9088458, CMS_2011_S9120041, 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, DELPHI_1995_S3137023, DELPHI_1996_S3430090, DELPHI_2002_069_CONF_603, DELPHI_2003_WUD_03_11, E735_1998_S3905616, ExampleAnalysis, H1_1994_S2919893, H1_1995_S3167097, H1_2000_S4129130, JADE_1998_S3612880, JADE_OPAL_2000_S4300807, LHCB_2010_S8758301, MC_DIJET, MC_DIPHOTON, MC_GENERIC, MC_JetAnalysis, MC_LEADINGJETS, MC_PHOTONJETUE, MC_SUSY, MC_TTBAR, MC_VH2BB, MC_WPOL, MC_XS, OPAL_1993_S2692198, OPAL_1998_S3780481, OPAL_2001_S4553896, OPAL_2004_S6132243, PDG_HADRON_MULTIPLICITIES, PDG_HADRON_MULTIPLICITIES_RATIOS, SFM_1984_S1178091, STAR_2006_S6500200, STAR_2006_S6860818, STAR_2006_S6870392, STAR_2008_S7869363, STAR_2008_S7993412, STAR_2009_UE_HELEN, TASSO_1990_S2148048, 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
AnalysisHandler &	handler () const
	Access the controlling AnalysisHandler object.
void	normalize (AIDA::IHistogram1D *&histo, double norm=1.0)
void	scale (AIDA::IHistogram1D *&histo, double scale)
void	normalize (AIDA::IHistogram2D *&histo, double norm=1.0)
void	scale (AIDA::IHistogram2D *&histo, double scale)
Analysis &	setCrossSection (double xs)
	Set the cross section from the generator.
Standard constructors and destructors.

	Analysis (const std::string &name)
	Constructor.
virtual	~Analysis ()
	The destructor.
Main analysis methods

virtual void	init ()=0
virtual void	analyze (const Event &event)=0
virtual void	finalize ()=0
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
	Return true if this analysis needs to know the process cross-section.
Analysis &	setNeedsCrossSection (bool needed=true)
	Declare whether this analysis needs to know the process cross-section from the generator.
Internal metadata modifiying methods

AnalysisInfo &	info ()
	Get the actual AnalysisInfo object in which all this metadata is stored (non-const).
virtual Analysis &	setBeams (PdgId beam1, PdgId beam2)
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.
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.
AIDA analysis infrastructure.

AIDA::IAnalysisFactory &	analysisFactory ()
	Access the AIDA analysis factory of the controlling AnalysisHandler object.
AIDA::ITree &	tree ()
	Access the AIDA tree of the controlling AnalysisHandler object.
AIDA::IHistogramFactory &	histogramFactory ()
	Access the AIDA histogram factory of the controlling AnalysisHandler object.
AIDA::IDataPointSetFactory &	datapointsetFactory ()
	Access the AIDA histogram factory of the controlling AnalysisHandler object.
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	makeAxisCode (size_t datasetId, size_t xAxisId, size_t yAxisId) const
	Get the internal histogram name for given d, x and y (cf. HepData).
Internal histogram booking (for use by Analysis sub-classes).

const BinEdges &	binEdges (const std::string &hname) const
	Get bin edges for a named histo (using ref AIDA caching).
const BinEdges &	binEdges (size_t datasetId, size_t xAxisId, size_t yAxisId) const
	Get bin edges for a numbered histo (using ref AIDA caching).
BinEdges	logBinEdges (size_t nbins, double lower, double upper)
	Get bin edges with logarithmic widths.
AIDA::IHistogram1D *	bookHistogram1D (const std::string &name, size_t nbins, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
AIDA::IHistogram1D *	bookHistogram1D (const std::string &name, const std::vector< double > &binedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
AIDA::IHistogram2D *	bookHistogram2D (const std::string &name, size_t nxbins, double xlower, double xupper, size_t nybins, double ylower, double yupper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")
AIDA::IHistogram2D *	bookHistogram2D (const std::string &name, const std::vector< double > &xbinedges, const std::vector< double > &ybinedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")
AIDA::IHistogram1D *	bookHistogram1D (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
AIDA::IHistogram1D *	bookHistogram1D (size_t datasetId, size_t xAxisId, size_t yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
Internal profile histogram booking (for use by Analysis sub-classes).

AIDA::IProfile1D *	bookProfile1D (const std::string &name, size_t nbins, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
AIDA::IProfile1D *	bookProfile1D (const std::string &name, const std::vector< double > &binedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
AIDA::IProfile1D *	bookProfile1D (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
AIDA::IProfile1D *	bookProfile1D (size_t datasetId, size_t xAxisId, size_t yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
Internal data point set booking (for use by Analysis sub-classes).

AIDA::IDataPointSet *	bookDataPointSet (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
AIDA::IDataPointSet *	bookDataPointSet (const std::string &name, size_t npts, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
AIDA::IDataPointSet *	bookDataPointSet (size_t datasetId, size_t xAxisId, size_t yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
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
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.
bool	_allowProjReg
	Flag to forbid projection registration in analyses until the init phase.
Private Member Functions
Analysis &	operator= (const Analysis &)
Utility functions

void	_makeHistoDir ()
	Make the histogram directory.
void	_cacheBinEdges () const
	Get the bin edges for this paper from the reference AIDA file, and cache them.
void	_cacheXAxisData () const
	Get the x-axis points for this paper from the reference AIDA file, and cache them.
Private Attributes
AnalysisHandler *	_analysishandler
	The controlling AnalysisHandler object.
bool	_madeHistoDir
	Flag to indicate whether the histogram directory is present.
map< string, vector< DPSXPoint > >	_dpsData
map< string, BinEdges >	_histBinEdges
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 51 of file Analysis.hh.

Constructor & Destructor Documentation

Analysis ( const std::string & name )

Constructor.

Definition at line 14 of file Analysis.cc.

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

00015     : _crossSection(-1.0),
00016       _gotCrossSection(false),
00017       _analysishandler(NULL),
00018       _madeHistoDir(false)
00019   {
00020     ProjectionApplier::_allowProjReg = false;
00021     _defaultname = name;
00022 
00023     AnalysisInfo* ai = AnalysisInfo::make(name);
00024     assert(ai != 0);
00025     _info.reset(ai);
00026     assert(_info.get() != 0);
00027   }

virtual ~Analysis ( ) [inline, virtual]

The destructor.

Definition at line 69 of file Analysis.hh.

00069 {}

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

00034                                                                              {
00035     if (!_allowProjReg) {
00036       cerr << "Trying to register projection '"
00037            << proj.name() << "' before init phase in '" << this->name() << "'." << endl;
00038       exit(2);
00039     }
00040     const Projection& reg = getProjHandler().registerProjection(*this, proj, name);
00041     return reg;
00042   }

void _cacheBinEdges ( ) const [private]

Get the bin edges for this paper from the reference AIDA file, and cache them.

Definition at line 186 of file Analysis.cc.

References Analysis::_cacheXAxisData(), Analysis::_dpsData, Analysis::_histBinEdges, Rivet::getBinEdges(), MSG_TRACE, and Analysis::name().

Referenced by Analysis::binEdges().

00186                                       {
00187     _cacheXAxisData();
00188     if (_histBinEdges.empty()) {
00189       MSG_TRACE("Getting histo bin edges from AIDA for paper " << name());
00190       _histBinEdges = getBinEdges(_dpsData);
00191     }
00192   }

void _cacheXAxisData ( ) const [private]

Get the x-axis points for this paper from the reference AIDA file, and cache them.

Definition at line 195 of file Analysis.cc.

References Analysis::_dpsData, Rivet::getDPSXValsErrs(), MSG_TRACE, and Analysis::name().

Referenced by Analysis::_cacheBinEdges(), and Analysis::bookDataPointSet().

00195                                        {
00196     if (_dpsData.empty()) {
00197       MSG_TRACE("Getting DPS x-axis data from AIDA for paper " << name());
00198       _dpsData = getDPSXValsErrs(name());
00199     }
00200   }

void _makeHistoDir ( ) [private]

Make the histogram directory.

Definition at line 466 of file Analysis.cc.

References Analysis::_madeHistoDir, Analysis::histoDir(), Analysis::name(), and Analysis::tree().

Referenced by Analysis::bookDataPointSet(), Analysis::bookHistogram1D(), Analysis::bookHistogram2D(), and Analysis::bookProfile1D().

00466                                {
00467     if (!_madeHistoDir) {
00468       if (! name().empty()) {
00469         // vector<string> dirs;
00470         // split(dirs, histoDir(), "/");
00471         // string pathpart;
00472         // foreach (const string& d, dirs) {
00473         //tree().mkdir();
00474         //}
00475         tree().mkdirs(histoDir());
00476       }
00477       _madeHistoDir = true;
00478     }
00479   }

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 113 of file ProjectionApplier.hh.

References ProjectionApplier::_addProjection().

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

IAnalysisFactory & analysisFactory ( ) [protected]

Access the AIDA analysis factory of the controlling AnalysisHandler object.

Definition at line 30 of file Analysis.cc.

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

00030                                               {
00031     return handler().analysisFactory();
00032   }

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 MC_JetAnalysis, ALEPH_1991_S2435284, ALEPH_1996_S3196992, ALEPH_1996_S3486095, ALEPH_2004_S5765862, ALICE_2010_S8624100, ALICE_2010_S8625980, ALICE_2010_S8706239, ALICE_2011_S8909580, ALICE_2011_S8945144, 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_I919017, ATLAS_2011_I925932, ATLAS_2011_S8924791, ATLAS_2011_S8971293, ATLAS_2011_S8983313, ATLAS_2011_S8994773, ATLAS_2011_S9002537, ATLAS_2011_S9019561, ATLAS_2011_S9041966, ATLAS_2011_S9108483, ATLAS_2011_S9120807, ATLAS_2011_S9126244, ATLAS_2011_S9128077, ATLAS_2011_S9131140, ATLAS_2011_S9212183, ATLAS_2011_S9225137, 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_LEADINGJETS, CDF_2008_NOTE_9351, CDF_2008_S7540469, CDF_2008_S7541902, CDF_2008_S7782535, CDF_2008_S7828950, CDF_2008_S8093652, CDF_2008_S8095620, CDF_2009_NOTE_9936, CDF_2009_S8233977, CDF_2009_S8383952, CDF_2009_S8436959, CDF_2010_S8591881_DY, CDF_2010_S8591881_QCD, CMS_2010_S8547297, CMS_2010_S8656010, CMS_2011_S8884919, CMS_2011_S8950903, CMS_2011_S8957746, CMS_2011_S8968497, CMS_2011_S8978280, CMS_2011_S9086218, CMS_2011_S9088458, CMS_2011_S9120041, 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, DELPHI_1995_S3137023, DELPHI_1996_S3430090, DELPHI_2002_069_CONF_603, DELPHI_2003_WUD_03_11, E735_1998_S3905616, ExampleAnalysis, H1_1994_S2919893, H1_1995_S3167097, H1_2000_S4129130, JADE_1998_S3612880, JADE_OPAL_2000_S4300807, LHCB_2010_S8758301, MC_DIJET, MC_DIPHOTON, MC_GENERIC, MC_HJETS, MC_JETS, MC_LEADINGJETS, MC_PHOTONJETS, MC_PHOTONJETUE, MC_SUSY, MC_TTBAR, MC_VH2BB, MC_WJETS, MC_WPOL, MC_WWJETS, MC_XS, MC_ZJETS, MC_ZZJETS, OPAL_1993_S2692198, OPAL_1998_S3780481, OPAL_2001_S4553896, OPAL_2004_S6132243, PDG_HADRON_MULTIPLICITIES, PDG_HADRON_MULTIPLICITIES_RATIOS, SFM_1984_S1178091, STAR_2006_S6500200, STAR_2006_S6860818, STAR_2006_S6870392, STAR_2008_S7869363, STAR_2008_S7993412, STAR_2009_UE_HELEN, TASSO_1990_S2148048, UA1_1990_S2044935, UA5_1982_S875503, UA5_1986_S1583476, UA5_1987_S1640666, UA5_1988_S1867512, UA5_1989_S1926373, and ZEUS_2001_S4815815.

const PROJ& applyProjection	(	const Event &	evt,
		const std::string &	name
	)			const `[inline, inherited]`

Apply the named projection on event.

Definition at line 81 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

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

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

Apply the supplied projection on event.

Definition at line 74 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

00074                                                                                 {
00075       return pcast<PROJ>(_applyProjection(evt, proj));
00076     }

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

Apply the supplied projection on event.

Definition at line 67 of file ProjectionApplier.hh.

References ProjectionApplier::_applyProjection().

Referenced by DISFinalState::project().

00067                                                                           {
00068       return pcast<PROJ>(_applyProjection(evt, proj));
00069     }

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 136 of file Analysis.hh.

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

00136                                                  {
00137       return info().authors();
00138     }

const PdgIdPair beamIds ( ) const

Incoming beam IDs for this run.

Definition at line 58 of file Analysis.cc.

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

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

00058                                           {
00059     return handler().beamIds();
00060   }

const ParticlePair & beams ( ) const

Incoming beams for this run.

Definition at line 54 of file Analysis.cc.

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

Referenced by OPAL_1998_S3780481::analyze(), MC_WPOL::analyze(), DELPHI_2002_069_CONF_603::analyze(), DELPHI_1996_S3430090::analyze(), DELPHI_1995_S3137023::analyze(), BELLE_2006_S6265367::analyze(), ALEPH_2004_S5765862::analyze(), ALEPH_1996_S3486095::analyze(), MC_WPOL::init(), and Analysis::isCompatible().

00054                                             {
00055     return handler().beams();
00056   }

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

BibTeX citation key for this article.

Definition at line 189 of file Analysis.hh.

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

00189                                      {
00190       return info().bibKey();
00191     }

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

BibTeX citation entry for this article.

Definition at line 194 of file Analysis.hh.

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

00194                                      {
00195       return info().bibTeX();
00196     }

const BinEdges & binEdges	(	size_t	datasetId,
		size_t	xAxisId,
		size_t	yAxisId
	)			const `[protected]`

Get bin edges for a numbered histo (using ref AIDA caching).

Definition at line 218 of file Analysis.cc.

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

00218                                                                                            {
00219     const string hname = makeAxisCode(datasetId, xAxisId, yAxisId);
00220     return binEdges(hname);
00221   }

const BinEdges & binEdges ( const std::string & hname ) const [protected]

Get bin edges for a named histo (using ref AIDA caching).

Definition at line 203 of file Analysis.cc.

References Analysis::_cacheBinEdges(), Analysis::_histBinEdges, Analysis::getLog(), MSG_TRACE, Analysis::name(), and Log::TRACE.

Referenced by ATLAS_2011_S8994773::analyze(), ATLAS_2010_S8894728::analyze(), Analysis::binEdges(), Analysis::bookHistogram1D(), Analysis::bookProfile1D(), ATLAS_2011_S9126244::finalize(), D0_2008_S7837160::init(), CMS_2011_S9088458::init(), CDF_1994_S2952106::init(), ATLAS_2011_S9128077::init(), ATLAS_2011_S9002537::init(), ATLAS_2010_S8894728::init(), ALICE_2011_S8909580::init(), and ATLAS_2011_S9126244::initializePlots().

00203                                                               {
00204     _cacheBinEdges();
00205     MSG_TRACE("Using histo bin edges for " << name() << ":" << hname);
00206     const BinEdges& edges = _histBinEdges.find(hname)->second;
00207     if (getLog().isActive(Log::TRACE)) {
00208       stringstream edges_ss;
00209       foreach (const double be, edges) {
00210         edges_ss << " " << be;
00211       }
00212       MSG_TRACE("Edges:" << edges_ss.str());
00213     }
00214     return edges;
00215   }

IDataPointSet * bookDataPointSet	(	size_t	datasetId,
		size_t	xAxisId,
		size_t	yAxisId,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)			`[protected]`

Book a 2-dimensional data point set based on the corresponding AIDA data file. The binnings (x-errors) will be obtained by reading the bundled AIDA data record file of the same filename as the analysis' name() property. Book a 2-dimensional data point set based on the paper, dataset and x/y-axis IDs in the corresponding HepData record. The binnings (x-errors) will be obtained by reading the bundled AIDA data record file of the same filename as the analysis' name() property.

Definition at line 440 of file Analysis.cc.

References Analysis::_cacheXAxisData(), Analysis::_dpsData, Analysis::bookDataPointSet(), Analysis::makeAxisCode(), MSG_TRACE, and Analysis::name().

00442                                                                                         {
00443     // Get the bin edges (only read the AIDA file once)
00444     _cacheXAxisData();
00445     // Build the axis code
00446     const string axisCode = makeAxisCode(datasetId, xAxisId, yAxisId);
00447     //const map<string, vector<DPSXPoint> > xpoints = getDPSXValsErrs(papername);
00448     MSG_TRACE("Using DPS x-positions for " << name() << ":" << axisCode);
00449     IDataPointSet* dps = bookDataPointSet(axisCode, title, xtitle, ytitle);
00450     const vector<DPSXPoint> xpts = _dpsData.find(axisCode)->second;
00451     for (size_t pt = 0; pt < xpts.size(); ++pt) {
00452       dps->addPoint();
00453       IMeasurement* meas = dps->point(pt)->coordinate(0);
00454       meas->setValue(xpts[pt].val);
00455       meas->setErrorPlus(xpts[pt].errplus);
00456       meas->setErrorMinus(xpts[pt].errminus);
00457     }
00458     MSG_TRACE("Made DPS " << axisCode <<  " for " << name());
00459     return dps;
00460   }

IDataPointSet * bookDataPointSet	(	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 points in a range. (NB. this returns a pointer rather than a reference since it will have to be stored in the analysis class - there's no point in forcing users to explicitly get the pointer from a reference before they can use it!)

Definition at line 422 of file Analysis.cc.

References Analysis::bookDataPointSet().

00425                                                                                         {
00426     IDataPointSet* dps = bookDataPointSet(hname, title, xtitle, ytitle);
00427     for (size_t pt = 0; pt < npts; ++pt) {
00428       const double binwidth = (upper-lower)/npts;
00429       const double bincentre = lower + (pt + 0.5) * binwidth;
00430       dps->addPoint();
00431       IMeasurement* meas = dps->point(pt)->coordinate(0);
00432       meas->setValue(bincentre);
00433       meas->setErrorPlus(binwidth/2.0);
00434       meas->setErrorMinus(binwidth/2.0);
00435     }
00436     return dps;
00437   }

IDataPointSet * bookDataPointSet	(	const std::string &	name,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)			`[protected]`

Book a 2-dimensional data point set. (NB. this returns a pointer rather than a reference since it will have to be stored in the analysis class - there's no point in forcing users to explicitly get the pointer from a reference before they can use it!)

Definition at line 407 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::datapointsetFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

Referenced by Analysis::bookDataPointSet(), ALEPH_2004_S5765862::finalize(), UA5_1988_S1867512::init(), STAR_2006_S6860818::init(), OPAL_1993_S2692198::init(), MC_XS::init(), MC_JetAnalysis::init(), JADE_OPAL_2000_S4300807::init(), D0_2001_S4674421::init(), CMS_2011_S9088458::init(), CDF_2008_S7782535::init(), CDF_2008_S7541902::init(), CDF_2005_S6217184::init(), CDF_1996_S3418421::init(), CDF_1994_S2952106::init(), ATLAS_2011_S9128077::init(), ATLAS_2011_S9002537::init(), ATLAS_2010_S8894728::init(), ALEPH_2004_S5765862::init(), and ATLAS_2011_S9126244::initializePlots().

00408                                                                                         {
00409     _makeHistoDir();
00410     const string path = histoPath(hname);
00411     if (path.find(" ") != string::npos) {
00412       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00413     }
00414     IDataPointSet* dps = datapointsetFactory().create(path, title, 2);
00415     MSG_TRACE("Made data point set " << hname <<  " for " << name());
00416     dps->setXTitle(xtitle);
00417     dps->setYTitle(ytitle);
00418     return dps;
00419   }

IHistogram1D * bookHistogram1D	(	size_t	datasetId,
		size_t	xAxisId,
		size_t	yAxisId,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)			`[protected]`

Book a 1D histogram based on the paper, dataset and x/y-axis IDs in the corresponding HepData record. The binnings will be obtained by reading the bundled AIDA data record file of the same filename as the analysis' name() property.

Definition at line 237 of file Analysis.cc.

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

00240   {
00241     const string axisCode = makeAxisCode(datasetId, xAxisId, yAxisId);
00242     return bookHistogram1D(axisCode, title, xtitle, ytitle);
00243   }

IHistogram1D * bookHistogram1D	(	const std::string &	name,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)			`[protected]`

Book a 1D histogram based on the name in the corresponding AIDA file. The binnings will be obtained by reading the bundled AIDA data record file with the same filename as the analysis' name() property.

Definition at line 246 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::binEdges(), Analysis::histogramFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

00248   {
00249     // Get the bin edges (only read the AIDA file once)
00250     const BinEdges edges = binEdges(hname);
00251     _makeHistoDir();
00252     const string path = histoPath(hname);
00253     if (path.find(" ") != string::npos) {
00254       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00255     }
00256     IHistogram1D* hist = histogramFactory().createHistogram1D(path, title, edges);
00257     MSG_TRACE("Made histogram " << hname <<  " for " << name());
00258     hist->setXTitle(xtitle);
00259     hist->setYTitle(ytitle);
00260     return hist;
00261   }

IHistogram1D * bookHistogram1D	(	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 . (NB. this returns a pointer rather than a reference since it will have to be stored in the analysis class - there's no point in forcing users to explicitly get the pointer from a reference before they can use it!)

Definition at line 281 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::histogramFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

00284                                                                                       {
00285     _makeHistoDir();
00286     const string path = histoPath(hname);
00287     if (path.find(" ") != string::npos) {
00288       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00289     }
00290     IHistogram1D* hist = histogramFactory().createHistogram1D(path, title, binedges);
00291     MSG_TRACE("Made histogram " << hname <<  " for " << name());
00292     hist->setXTitle(xtitle);
00293     hist->setYTitle(ytitle);
00294     return hist;
00295   }

IHistogram1D * bookHistogram1D	(	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 . (NB. this returns a pointer rather than a reference since it will have to be stored in the analysis class - there's no point in forcing users to explicitly get the pointer from a reference before they can use it!)

Definition at line 264 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::histogramFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

00267                                                                                       {
00268     _makeHistoDir();
00269     const string path = histoPath(hname);
00270     if (path.find(" ") != string::npos) {
00271       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00272     }
00273     IHistogram1D* hist = histogramFactory().createHistogram1D(path, title, nbins, lower, upper);
00274     MSG_TRACE("Made histogram " << hname <<  " for " << name());
00275     hist->setXTitle(xtitle);
00276     hist->setYTitle(ytitle);
00277     return hist;
00278   }

IHistogram2D * bookHistogram2D	(	const std::string &	name,
		const std::vector< double > &	xbinedges,
		const std::vector< double > &	ybinedges,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`,
		const std::string &	ztitle = `""`
	)			`[protected]`

Book a 2D histogram with non-uniform bins defined by the vectorx of bin edges xbinedges and ybinedges. (NB. this returns a pointer rather than a reference since it will have to be stored in the analysis class - there's no point in forcing users to explicitly get the pointer from a reference before they can use it!)

Definition at line 320 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::histogramFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

00324                                                             {
00325     _makeHistoDir();
00326     const string path = histoPath(hname);
00327     if (path.find(" ") != string::npos) {
00328       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00329     }
00330     IHistogram2D* hist =
00331       histogramFactory().createHistogram2D(path, title, xbinedges, ybinedges);
00332     MSG_TRACE("Made 2D histogram " << hname <<  " for " << name());
00333     hist->setXTitle(xtitle);
00334     hist->setYTitle(ytitle);
00335     hist->setZTitle(ztitle);
00336     return hist;
00337   }

IHistogram2D * bookHistogram2D	(	const std::string &	name,
		size_t	nxbins,
		double	xlower,
		double	xupper,
		size_t	nybins,
		double	ylower,
		double	yupper,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`,
		const std::string &	ztitle = `""`
	)			`[protected]`

Book a 2D histogram with nxbins and nybins uniformly distributed across the ranges xlower - xupper and ylower - yupper respectively along the x- and y-axis. (NB. this returns a pointer rather than a reference since it will have to be stored in the analysis class - there's no point in forcing users to explicitly get the pointer from a reference before they can use it!)

Definition at line 298 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::histogramFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

00302                                                             {
00303     _makeHistoDir();
00304     const string path = histoPath(hname);
00305     if (path.find(" ") != string::npos) {
00306       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00307     }
00308     IHistogram2D* hist =
00309       histogramFactory().createHistogram2D(path, title, nxbins, xlower, xupper,
00310                        nybins, ylower, yupper);
00311     MSG_TRACE("Made 2D histogram " << hname <<  " for " << name());
00312     hist->setXTitle(xtitle);
00313     hist->setYTitle(ytitle);
00314     hist->setZTitle(ztitle);
00315     return hist;
00316   }

IProfile1D * bookProfile1D	(	size_t	datasetId,
		size_t	xAxisId,
		size_t	yAxisId,
		const std::string &	title = `""`,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)			`[protected]`

Book a 1D profile histogram based on the paper, dataset and x/y-axis IDs in the corresponding HepData record. The binnings will be obtained by reading the bundled AIDA data record file of the same filename as the analysis' name() property.

Definition at line 343 of file Analysis.cc.

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

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

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

Book a 1D profile histogram based on the name in the corresponding AIDA file. The binnings will be obtained by reading the bundled AIDA data record file with the same filename as the analysis' name() property.

Definition at line 351 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::binEdges(), Analysis::histogramFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

00353   {
00354     // Get the bin edges (only read the AIDA file once)
00355     const BinEdges edges = binEdges(hname);
00356     _makeHistoDir();
00357     const string path = histoPath(hname);
00358     if (path.find(" ") != string::npos) {
00359       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00360     }
00361     IProfile1D* prof = histogramFactory().createProfile1D(path, title, edges);
00362     MSG_TRACE("Made profile histogram " << hname <<  " for " << name());
00363     prof->setXTitle(xtitle);
00364     prof->setYTitle(ytitle);
00365     return prof;
00366   }

IProfile1D * 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 . (NB. this returns a pointer rather than a reference since it will have to be stored in the analysis class - there's no point in forcing users to explicitly get the pointer from a reference before they can use it!)

Definition at line 386 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::histogramFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

00389                                                                                   {
00390     _makeHistoDir();
00391     const string path = histoPath(hname);
00392     if (path.find(" ") != string::npos) {
00393       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00394     }
00395     IProfile1D* prof = histogramFactory().createProfile1D(path, title, binedges);
00396     MSG_TRACE("Made profile histogram " << hname <<  " for " << name());
00397     prof->setXTitle(xtitle);
00398     prof->setYTitle(ytitle);
00399     return prof;
00400   }

IProfile1D * 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 . (NB. this returns a pointer rather than a reference since it will have to be stored in the analysis class - there's no point in forcing users to explicitly get the pointer from a reference before they can use it!)

Definition at line 369 of file Analysis.cc.

References Analysis::_makeHistoDir(), Analysis::histogramFactory(), Analysis::histoPath(), MSG_TRACE, and Analysis::name().

Referenced by Analysis::bookProfile1D(), UA1_1990_S2044935::init(), STAR_2009_UE_HELEN::init(), STAR_2008_S7993412::init(), STAR_2006_S6860818::init(), MC_WPOL::init(), MC_PHOTONJETUE::init(), MC_LEADINGJETS::init(), MC_GENERIC::init(), H1_2000_S4129130::init(), H1_1994_S2919893::init(), DELPHI_2002_069_CONF_603::init(), DELPHI_1996_S3430090::init(), D0_1996_S3324664::init(), CMS_2011_S9120041::init(), CMS_2011_S8884919::init(), CDF_2010_S8591881_QCD::init(), CDF_2010_S8591881_DY::init(), CDF_2009_S8233977::init(), CDF_2008_S7782535::init(), CDF_2008_NOTE_9351::init(), CDF_2008_LEADINGJETS::init(), CDF_2005_S6217184::init(), CDF_2004_S5839831::init(), CDF_2001_S4751469::init(), ATLAS_2011_S8994773::init(), ATLAS_2011_S8924791::init(), ATLAS_2010_S8918562::init(), ATLAS_2010_S8894728::init(), ATLAS_2010_S8591806::init(), ALICE_2011_S8945144::init(), ALICE_2010_S8706239::init(), and ATLAS_2011_S9126244::initializePlots().

00372                                                                                   {
00373     _makeHistoDir();
00374     const string path = histoPath(hname);
00375     if (path.find(" ") != string::npos) {
00376       throw Error("Histogram path '" + path + "' is invalid: spaces are not permitted in paths");
00377     }
00378     IProfile1D* prof = histogramFactory().createProfile1D(path, title, nbins, lower, upper);
00379     MSG_TRACE("Made profile histogram " << hname <<  " for " << name());
00380     prof->setXTitle(xtitle);
00381     prof->setYTitle(ytitle);
00382     return prof;
00383   }

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

Collider on which the experiment ran.

Definition at line 174 of file Analysis.hh.

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

00174                                        {
00175       return info().collider();
00176     }

double crossSection ( ) const [protected]

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

Definition at line 166 of file Analysis.cc.

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

Referenced by STAR_2006_S6870392::finalize(), MC_ZZJETS::finalize(), MC_ZJETS::finalize(), MC_XS::finalize(), MC_WWJETS::finalize(), MC_WJETS::finalize(), MC_VH2BB::finalize(), MC_JetAnalysis::finalize(), MC_HJETS::finalize(), MC_DIPHOTON::finalize(), LHCB_2010_S8758301::finalize(), D0_2010_S8570965::finalize(), D0_2010_S8566488::finalize(), D0_2008_S7863608::finalize(), D0_2008_S7719523::finalize(), D0_2008_S7662670::finalize(), D0_2006_S6438750::finalize(), D0_2000_S4480767::finalize(), CMS_2011_S9086218::finalize(), CDF_2009_S8436959::finalize(), CDF_2009_S8383952::finalize(), CDF_2009_S8233977::finalize(), CDF_2008_S8093652::finalize(), CDF_2008_S7828950::finalize(), CDF_2008_S7541902::finalize(), CDF_2008_S7540469::finalize(), CDF_2006_S6653332::finalize(), CDF_2006_S6450792::finalize(), CDF_2005_S6080774::finalize(), CDF_2001_S4563131::finalize(), CDF_2001_S4517016::finalize(), CDF_2000_S4266730::finalize(), CDF_2000_S4155203::finalize(), CDF_1998_S3618439::finalize(), ATLAS_2011_S9212183::finalize(), ATLAS_2011_S9120807::finalize(), ATLAS_2011_S9108483::finalize(), ATLAS_2011_S9041966::finalize(), ATLAS_2011_I919017::finalize(), ATLAS_2011_CONF_2011_098::finalize(), ATLAS_2011_CONF_2011_090::finalize(), ATLAS_2010_S8919674::finalize(), ATLAS_2010_S8914702::finalize(), and ATLAS_2010_CONF_2010_049::finalize().

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

double crossSectionPerEvent ( ) const [protected]

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

Definition at line 174 of file Analysis.cc.

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

Referenced by UA1_1990_S2044935::finalize(), MC_WPOL::finalize(), MC_PHOTONJETS::finalize(), D0_2010_S8671338::finalize(), D0_2009_S8349509::finalize(), D0_2001_S4674421::finalize(), CDF_2007_S7057202::finalize(), CDF_1988_S1865951::finalize(), ATLAS_2011_S9128077::finalize(), and ATLAS_2010_S8817804::finalize().

00174                                               {
00175     const double sumW = sumOfWeights();
00176     assert(sumW != 0.0);
00177     return _crossSection / sumW;
00178   }

IDataPointSetFactory & datapointsetFactory ( ) [protected]

Access the AIDA histogram factory of the controlling AnalysisHandler object.

Definition at line 45 of file Analysis.cc.

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

Referenced by Analysis::bookDataPointSet(), and Analysis::scale().

00045                                                       {
00046     return handler().datapointsetFactory();
00047   }

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 155 of file Analysis.hh.

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

00155                                           {
00156       return info().description();
00157     }

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

Experiment which performed and published this analysis.

Definition at line 169 of file Analysis.hh.

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

00169                                          {
00170       return info().experiment();
00171     }

virtual void finalize ( ) [pure 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.

Implemented in MC_JetAnalysis, ALEPH_1991_S2435284, ALEPH_1996_S3196992, ALEPH_1996_S3486095, ALEPH_2004_S5765862, ALICE_2010_S8624100, ALICE_2010_S8625980, ALICE_2010_S8706239, ALICE_2011_S8909580, ALICE_2011_S8945144, 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_I919017, ATLAS_2011_I925932, ATLAS_2011_S8924791, ATLAS_2011_S8971293, ATLAS_2011_S8983313, ATLAS_2011_S8994773, ATLAS_2011_S9002537, ATLAS_2011_S9019561, ATLAS_2011_S9041966, ATLAS_2011_S9108483, ATLAS_2011_S9120807, ATLAS_2011_S9126244, ATLAS_2011_S9128077, ATLAS_2011_S9131140, ATLAS_2011_S9212183, ATLAS_2011_S9225137, 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_LEADINGJETS, CDF_2008_NOTE_9351, CDF_2008_S7540469, CDF_2008_S7541902, CDF_2008_S7782535, CDF_2008_S7828950, CDF_2008_S8093652, CDF_2008_S8095620, CDF_2009_NOTE_9936, CDF_2009_S8233977, CDF_2009_S8383952, CDF_2009_S8436959, CDF_2010_S8591881_DY, CDF_2010_S8591881_QCD, CMS_2010_S8547297, CMS_2010_S8656010, CMS_2011_S8884919, CMS_2011_S8950903, CMS_2011_S8957746, CMS_2011_S8968497, CMS_2011_S8978280, CMS_2011_S9086218, CMS_2011_S9088458, CMS_2011_S9120041, 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, DELPHI_1995_S3137023, DELPHI_1996_S3430090, DELPHI_2002_069_CONF_603, DELPHI_2003_WUD_03_11, E735_1998_S3905616, ExampleAnalysis, H1_1994_S2919893, H1_1995_S3167097, H1_2000_S4129130, JADE_1998_S3612880, JADE_OPAL_2000_S4300807, LHCB_2010_S8758301, MC_DIJET, MC_DIPHOTON, MC_GENERIC, MC_HJETS, MC_JETS, MC_LEADINGJETS, MC_PHOTONJETS, MC_PHOTONJETUE, MC_SUSY, MC_TTBAR, MC_VH2BB, MC_WJETS, MC_WPOL, MC_WWJETS, MC_XS, MC_ZJETS, MC_ZZJETS, OPAL_1993_S2692198, OPAL_1998_S3780481, OPAL_2001_S4553896, OPAL_2004_S6132243, PDG_HADRON_MULTIPLICITIES, PDG_HADRON_MULTIPLICITIES_RATIOS, SFM_1984_S1178091, STAR_2006_S6500200, STAR_2006_S6860818, STAR_2006_S6870392, STAR_2008_S7869363, STAR_2008_S7993412, STAR_2009_UE_HELEN, TASSO_1990_S2148048, UA1_1990_S2044935, UA5_1982_S875503, UA5_1986_S1583476, UA5_1987_S1640666, UA5_1988_S1867512, UA5_1989_S1926373, and ZEUS_2001_S4815815.

Log & getLog ( ) const [protected]

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

Reimplemented from ProjectionApplier.

Definition at line 97 of file Analysis.cc.

References Analysis::name().

Referenced by Analysis::binEdges().

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

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 57 of file ProjectionApplier.hh.

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

00057                                                                  {
00058       return getProjHandler().getProjection(*this, name);
00059     }

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

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

Definition at line 49 of file ProjectionApplier.hh.

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

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

00049                                                            {
00050       const Projection& p = getProjHandler().getProjection(*this, name);
00051       return pcast<PROJ>(p);
00052     }

std::set<ConstProjectionPtr> getProjections ( ) const [inline, inherited]

Get the contained projections, including recursion.

Definition at line 42 of file ProjectionApplier.hh.

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

Referenced by Projection::beamPairs().

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

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

Get a reference to the ProjectionHandler for this thread.

Definition at line 94 of file ProjectionApplier.hh.

References ProjectionApplier::_projhandler.

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

00094                                               {
00095       return _projhandler;
00096     }

AnalysisHandler& handler ( ) const [inline]

Access the controlling AnalysisHandler object.

Definition at line 296 of file Analysis.hh.

References Analysis::_analysishandler.

Referenced by Analysis::analysisFactory(), Analysis::beamIds(), Analysis::beams(), Analysis::datapointsetFactory(), Analysis::histoDir(), Analysis::histogramFactory(), Analysis::numEvents(), Analysis::sqrtS(), Analysis::sumOfWeights(), and Analysis::tree().

00296 { return *_analysishandler; }

const string histoDir ( ) const [protected]

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

Todo:: This doesn't change: calc and cache at first use!

Definition at line 63 of file Analysis.cc.

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

Referenced by Analysis::_makeHistoDir(), STAR_2006_S6860818::finalize(), STAR_2006_S6500200::finalize(), MC_WJETS::finalize(), D0_2008_S7837160::finalize(), D0_2008_S7719523::finalize(), CMS_2011_S8978280::finalize(), ATLAS_2011_S9128077::finalize(), and Analysis::histoPath().

00063                                         {
00064     /// @todo This doesn't change: calc and cache at first use!
00065     string path = "/" + name();
00066     if (handler().runName().length() > 0) {
00067       path = "/" + handler().runName() + path;
00068     }
00069     while (find_first(path, "//")) {
00070       replace_all(path, "//", "/");
00071     }
00072     return path;
00073   }

IHistogramFactory & histogramFactory ( ) [protected]

Access the AIDA histogram factory of the controlling AnalysisHandler object.

Definition at line 40 of file Analysis.cc.

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

Referenced by Analysis::bookHistogram1D(), Analysis::bookHistogram2D(), Analysis::bookProfile1D(), STAR_2006_S6860818::finalize(), STAR_2006_S6500200::finalize(), MC_WJETS::finalize(), MC_JetAnalysis::finalize(), MC_GENERIC::finalize(), H1_1995_S3167097::finalize(), D0_2008_S7837160::finalize(), D0_2008_S7719523::finalize(), CMS_2011_S9088458::finalize(), CMS_2011_S8978280::finalize(), ATLAS_2011_S9128077::finalize(), ATLAS_2011_S9126244::finalize(), ATLAS_2011_S9002537::finalize(), ALICE_2011_S8909580::finalize(), and ATLAS_2011_S9126244::finalizeQ0GapFraction().

00040                                                 {
00041     return handler().histogramFactory();
00042   }

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

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

Definition at line 76 of file Analysis.cc.

References Analysis::histoDir().

Referenced by Analysis::bookDataPointSet(), Analysis::bookHistogram1D(), Analysis::bookHistogram2D(), Analysis::bookProfile1D(), MC_JetAnalysis::finalize(), MC_GENERIC::finalize(), ATLAS_2011_S9126244::finalize(), and ALICE_2011_S8909580::finalize().

00076                                                             {
00077     const string path = histoDir() + "/" + hname;
00078     return path;
00079   }

AnalysisInfo& info ( ) [inline]

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

Definition at line 248 of file Analysis.hh.

References Analysis::_info.

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

const AnalysisInfo& info ( ) const [inline]

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

Definition at line 108 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().

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

virtual void init ( ) [pure 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.

Implemented in MC_JetAnalysis, ALEPH_1991_S2435284, ALEPH_1996_S3196992, ALEPH_1996_S3486095, ALEPH_2004_S5765862, ALICE_2010_S8624100, ALICE_2010_S8625980, ALICE_2010_S8706239, ALICE_2011_S8909580, ALICE_2011_S8945144, 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_I919017, ATLAS_2011_I925932, ATLAS_2011_S8924791, ATLAS_2011_S8971293, ATLAS_2011_S8983313, ATLAS_2011_S8994773, ATLAS_2011_S9002537, ATLAS_2011_S9019561, ATLAS_2011_S9041966, ATLAS_2011_S9108483, ATLAS_2011_S9120807, ATLAS_2011_S9126244, ATLAS_2011_S9128077, ATLAS_2011_S9131140, ATLAS_2011_S9212183, ATLAS_2011_S9225137, 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_LEADINGJETS, CDF_2008_NOTE_9351, CDF_2008_S7540469, CDF_2008_S7541902, CDF_2008_S7782535, CDF_2008_S7828950, CDF_2008_S8093652, CDF_2008_S8095620, CDF_2009_NOTE_9936, CDF_2009_S8233977, CDF_2009_S8383952, CDF_2009_S8436959, CDF_2010_S8591881_DY, CDF_2010_S8591881_QCD, CMS_2010_S8547297, CMS_2010_S8656010, CMS_2011_S8884919, CMS_2011_S8950903, CMS_2011_S8957746, CMS_2011_S8968497, CMS_2011_S8978280, CMS_2011_S9086218, CMS_2011_S9088458, CMS_2011_S9120041, 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, DELPHI_1995_S3137023, DELPHI_1996_S3430090, DELPHI_2002_069_CONF_603, DELPHI_2003_WUD_03_11, E735_1998_S3905616, ExampleAnalysis, H1_1994_S2919893, H1_1995_S3167097, H1_2000_S4129130, JADE_1998_S3612880, JADE_OPAL_2000_S4300807, LHCB_2010_S8758301, MC_DIJET, MC_DIPHOTON, MC_GENERIC, MC_HJETS, MC_JETS, MC_LEADINGJETS, MC_PHOTONJETS, MC_PHOTONJETUE, MC_SUSY, MC_TTBAR, MC_VH2BB, MC_WJETS, MC_WPOL, MC_WWJETS, MC_XS, MC_ZJETS, MC_ZZJETS, OPAL_1993_S2692198, OPAL_1998_S3780481, OPAL_2001_S4553896, OPAL_2004_S6132243, PDG_HADRON_MULTIPLICITIES, PDG_HADRON_MULTIPLICITIES_RATIOS, SFM_1984_S1178091, STAR_2006_S6500200, STAR_2006_S6860818, STAR_2006_S6870392, STAR_2008_S7869363, STAR_2008_S7993412, STAR_2009_UE_HELEN, TASSO_1990_S2148048, UA1_1990_S2044935, UA5_1982_S875503, UA5_1986_S1583476, UA5_1987_S1640666, UA5_1988_S1867512, UA5_1989_S1926373, and ZEUS_2001_S4815815.

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

Get the Inspire ID code for this analysis.

Definition at line 123 of file Analysis.hh.

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

00123                                         {
00124       return info().inspireId();
00125     }

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.

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 122 of file Analysis.cc.

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

00122                                                                                   {
00123     PdgIdPair beams(beam1, beam2);
00124     pair<double,double> energies(e1, e2);
00125     return isCompatible(beams, energies);
00126   }

bool isCompatible ( const ParticlePair & beams ) const

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

Definition at line 116 of file Analysis.cc.

Referenced by Analysis::isCompatible().

00116                                                              {
00117     return isCompatible(beams.first.pdgId(),  beams.second.pdgId(),
00118                         beams.first.energy(), beams.second.energy());
00119   }

BinEdges logBinEdges	(	size_t	nbins,
		double	lower,
		double	upper
	)			`[protected]`

Get bin edges with logarithmic widths.

Definition at line 224 of file Analysis.cc.

Referenced by MC_ZZJETS::init(), MC_ZJETS::init(), MC_WWJETS::init(), MC_WPOL::init(), MC_WJETS::init(), MC_PHOTONJETS::init(), MC_JetAnalysis::init(), MC_HJETS::init(), and MC_DIPHOTON::init().

00224                                                                          {
00225     assert(lower>0.0);
00226     assert(upper>lower);
00227     double loglower=log10(lower);
00228     double logupper=log10(upper);
00229     vector<double> binedges;
00230     double stepwidth=(logupper-loglower)/double(nbins);
00231     for (size_t i=0; i<=nbins; ++i) {
00232       binedges.push_back(pow(10.0, loglower+double(i)*stepwidth));
00233     }
00234     return binedges;
00235   }

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

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

Definition at line 82 of file Analysis.cc.

Referenced by Analysis::binEdges(), Analysis::bookDataPointSet(), Analysis::bookHistogram1D(), Analysis::bookProfile1D(), and ATLAS_2011_S9126244::finalize().

00082                                                                                             {
00083     stringstream axisCode;
00084     axisCode << "d";
00085     if (datasetId < 10) axisCode << 0;
00086     axisCode << datasetId;
00087     axisCode << "-x";
00088     if (xAxisId < 10) axisCode << 0;
00089     axisCode << xAxisId;
00090     axisCode << "-y";
00091     if (yAxisId < 10) axisCode << 0;
00092     axisCode << yAxisId;
00093     return axisCode.str();
00094   }

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 118 of file Analysis.hh.

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

Referenced by Analysis::_cacheBinEdges(), Analysis::_cacheXAxisData(), Analysis::_makeHistoDir(), Analysis::binEdges(), Analysis::bookDataPointSet(), Analysis::bookHistogram1D(), Analysis::bookHistogram2D(), Analysis::bookProfile1D(), Analysis::crossSection(), Analysis::getLog(), Analysis::histoDir(), Analysis::normalize(), HistoHandler::registerAnalysisObject(), and Analysis::scale().

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

bool needsCrossSection ( ) const [inline]

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

Definition at line 232 of file Analysis.hh.

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

00232                                    {
00233       return info().needsCrossSection();
00234     }

void normalize	(	AIDA::IHistogram2D *&	histo,
		double	norm = `1.0`
	)

Normalize the given histogram, histo. After this call the histogram will have been transformed to a DataPointSet with the same name and path. It has the same effect as scale(histo, norm/sumOfWeights).

Parameters:

	histo	The histogram to be normalised.
	norm	The new area of the histogram.

Warning:: The old histogram will be deleted, and its pointer set to zero.

Definition at line 552 of file Analysis.cc.

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

00553 00554 00555 00556 00557     } 00558 00559 00560 00561 00562 00563 00564 00565 00566 00567 00568 00569     } 00570 00571 00572 00573     } 00574 00575 00576 00577   }

class="fragment">00552 { if (!histo) { MSG_ERROR("Failed to normalize histo=NULL in analysis " << name() << " (norm=" << norm << ")"); return; const string hpath = tree().findPath(dynamic_cast<const AIDA::IManagedObject&>(*histo)); MSG_TRACE("Normalizing histo " << hpath << " to " << norm); double oldintg = 0.0; int nxBins = histo->xAxis().bins(); int nyBins = histo->yAxis().bins(); for (int ixBin = 0; ixBin != nxBins; ++ixBin) for (int iyBin = 0; iyBin != nyBins; ++iyBin) { // Leaving out factor of binWidth because AIDA's "height" // already includes a width factor. oldintg += histo->binHeight(ixBin, iyBin); // * histo->axis().binWidth(iBin); if (oldintg == 0.0) { MSG_WARNING("Histo " << hpath << " has null integral during normalization"); return; // Scale by the normalisation factor. scale(histo, norm/oldintg);

void normalize	(	AIDA::IHistogram1D *&	histo,
		double	norm = `1.0`
	)

Normalize the given histogram, histo. After this call the histogram will have been transformed to a DataPointSet with the same name and path. It has the same effect as scale(histo, norm/sumOfWeights).

Parameters:

	histo	The histogram to be normalised.
	norm	The new area of the histogram.

Warning:: The old histogram will be deleted, and its pointer set to zero.

Definition at line 482 of file Analysis.cc.

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

Referenced by TASSO_1990_S2148048::finalize(), STAR_2008_S7869363::finalize(), OPAL_2001_S4553896::finalize(), OPAL_1998_S3780481::finalize(), JADE_1998_S3612880::finalize(), H1_1994_S2919893::finalize(), ExampleAnalysis::finalize(), DELPHI_2003_WUD_03_11::finalize(), DELPHI_2002_069_CONF_603::finalize(), DELPHI_1996_S3430090::finalize(), DELPHI_1995_S3137023::finalize(), D0_2010_S8821313::finalize(), D0_2010_S8671338::finalize(), D0_2009_S8320160::finalize(), D0_2008_S7554427::finalize(), D0_2008_S6879055::finalize(), D0_2007_S7075677::finalize(), D0_2004_S5992206::finalize(), D0_2001_S4674421::finalize(), D0_1996_S3324664::finalize(), D0_1996_S3214044::finalize(), CMS_2011_S9120041::finalize(), CMS_2011_S8968497::finalize(), CMS_2011_S8957746::finalize(), CMS_2011_S8950903::finalize(), CMS_2011_S8884919::finalize(), CDF_2009_NOTE_9936::finalize(), CDF_2004_S5839831::finalize(), CDF_2001_S4751469::finalize(), CDF_1997_S3541940::finalize(), CDF_1996_S3418421::finalize(), CDF_1996_S3349578::finalize(), CDF_1996_S3108457::finalize(), CDF_1994_S2952106::finalize(), CDF_1993_S2742446::finalize(), ATLAS_2011_S8971293::finalize(), ALICE_2010_S8625980::finalize(), ALICE_2010_S8624100::finalize(), ALEPH_2004_S5765862::finalize(), ALEPH_1996_S3486095::finalize(), and ATLAS_2011_I919017::safeinvscale().

00482                                                                 {
00483     if (!histo) {
00484       MSG_ERROR("Failed to normalize histo=NULL in analysis "
00485                 << name() << " (norm=" << norm << ")");
00486       return;
00487     }
00488     const string hpath = tree().findPath(dynamic_cast<const AIDA::IManagedObject&>(*histo));
00489     MSG_TRACE("Normalizing histo " << hpath << " to " << norm);
00490 
00491     double oldintg = 0.0;
00492     int nBins = histo->axis().bins();
00493     for (int iBin = 0; iBin != nBins; ++iBin) {
00494       // Leaving out factor of binWidth because AIDA's "height" already includes a width factor.
00495       oldintg += histo->binHeight(iBin); // * histo->axis().binWidth(iBin);
00496     }
00497     if (oldintg == 0.0) {
00498       MSG_WARNING("Histo " << hpath << " has null integral during normalization");
00499       return;
00500     }
00501 
00502     // Scale by the normalisation factor.
00503     scale(histo, norm/oldintg);
00504   }

size_t numEvents ( ) const [protected]

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

Definition at line 103 of file Analysis.cc.

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

Referenced by LHCB_2010_S8758301::finalize().

00103                                    {
00104     return handler().numEvents();
00105   }

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

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

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

Journal, and preprint references.

Definition at line 184 of file Analysis.hh.

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

00184                                                     {
00185       return info().references();
00186     }

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

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

Definition at line 210 of file Analysis.hh.

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

00210                                                               {
00211       return info().beams();
00212     }

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

Sets of valid beam energy pairs, in GeV.

Definition at line 221 of file Analysis.hh.

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

Referenced by Analysis::setRequiredEnergies().

00221                                                                                 {
00222       return info().energies();
00223     }

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 164 of file Analysis.hh.

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

00164                                       {
00165       return info().runInfo();
00166     }

void scale	(	AIDA::IHistogram2D *&	histo,
		double	scale
	)

Multiplicatively scale the given histogram, histo. After this call the histogram will have been transformed to a DataPointSet with the same name and path.

Parameters:

	histo	The histogram to be scaled.
	scale	The factor used to multiply the histogram bin heights.

Warning:: The old histogram will be deleted, and its pointer set to zero.

Definition at line 580 of file Analysis.cc.

References Analysis::datapointsetFactory(), MSG_ERROR, MSG_TRACE, Analysis::name(), and Analysis::tree().

00580                                                              {
00581     if (!histo) {
00582       MSG_ERROR("Failed to scale histo=NULL in analysis "
00583                 << name() << " (scale=" << scale << ")");
00584       return;
00585     }
00586     const string hpath =
00587       tree().findPath(dynamic_cast<const AIDA::IManagedObject&>(*histo));
00588     MSG_TRACE("Scaling histo " << hpath);
00589 
00590     vector<double> x, y, z, ex, ey, ez;
00591     for (size_t ix = 0, Nx = histo->xAxis().bins(); ix < Nx; ++ix)
00592       for (size_t iy = 0, Ny = histo->yAxis().bins(); iy < Ny; ++iy) {
00593     x.push_back(0.5 * (histo->xAxis().binLowerEdge(ix) +
00594                histo->xAxis().binUpperEdge(ix)));
00595     ex.push_back(histo->xAxis().binWidth(ix)*0.5);
00596     y.push_back(0.5 * (histo->yAxis().binLowerEdge(iy) +
00597                histo->yAxis().binUpperEdge(iy)));
00598     ey.push_back(histo->yAxis().binWidth(iy)*0.5);
00599 
00600     // "Bin height" is a misnomer in the AIDA spec: width is neglected.
00601     // We'd like to do this: y.push_back(histo->binHeight(i) * scale);
00602     z.push_back(histo->binHeight(ix, iy)*scale/
00603             (histo->xAxis().binWidth(ix)*histo->yAxis().binWidth(iy)));
00604     // "Bin error" is a misnomer in the AIDA spec: width is neglected.
00605     // We'd like to do this: ey.push_back(histo->binError(i) * scale);
00606     ez.push_back(histo->binError(ix, iy)*scale/
00607              (histo->xAxis().binWidth(ix)*histo->yAxis().binWidth(iy)));
00608     }
00609 
00610     string title = histo->title();
00611     string xtitle = histo->xtitle();
00612     string ytitle = histo->ytitle();
00613     string ztitle = histo->ztitle();
00614 
00615     tree().mkdir("/tmpnormalize");
00616     tree().mv(hpath, "/tmpnormalize");
00617 
00618     if (hpath.find(" ") != string::npos) {
00619       throw Error("Histogram path '" + hpath + "' is invalid: spaces are not permitted in paths");
00620     }
00621     AIDA::IDataPointSet* dps =
00622       datapointsetFactory().createXYZ(hpath, title, x, y, z, ex, ey, ez);
00623     dps->setXTitle(xtitle);
00624     dps->setYTitle(ytitle);
00625     dps->setZTitle(ztitle);
00626 
00627     tree().rm(tree().findPath(dynamic_cast<AIDA::IManagedObject&>(*histo)));
00628     tree().rmdir("/tmpnormalize");
00629 
00630     // Set histo pointer to null - it can no longer be used.
00631     histo = 0;
00632   }

void scale	(	AIDA::IHistogram1D *&	histo,
		double	scale
	)

Multiplicatively scale the given histogram, histo. After this call the histogram will have been transformed to a DataPointSet with the same name and path.

Parameters:

	histo	The histogram to be scaled.
	scale	The factor used to multiply the histogram bin heights.

Warning:: The old histogram will be deleted, and its pointer set to zero.

Definition at line 507 of file Analysis.cc.

References Analysis::datapointsetFactory(), MSG_ERROR, MSG_TRACE, Analysis::name(), and Analysis::tree().

Referenced by UA5_1989_S1926373::finalize(), UA5_1987_S1640666::finalize(), UA5_1986_S1583476::finalize(), UA5_1982_S875503::finalize(), UA1_1990_S2044935::finalize(), STAR_2006_S6870392::finalize(), STAR_2006_S6860818::finalize(), STAR_2006_S6500200::finalize(), SFM_1984_S1178091::finalize(), PDG_HADRON_MULTIPLICITIES_RATIOS::finalize(), PDG_HADRON_MULTIPLICITIES::finalize(), OPAL_2004_S6132243::finalize(), OPAL_1998_S3780481::finalize(), MC_ZZJETS::finalize(), MC_ZJETS::finalize(), MC_XS::finalize(), MC_WWJETS::finalize(), MC_WPOL::finalize(), MC_WJETS::finalize(), MC_VH2BB::finalize(), MC_TTBAR::finalize(), MC_PHOTONJETS::finalize(), MC_JetAnalysis::finalize(), MC_HJETS::finalize(), MC_GENERIC::finalize(), MC_DIPHOTON::finalize(), LHCB_2010_S8758301::finalize(), JADE_OPAL_2000_S4300807::finalize(), H1_2000_S4129130::finalize(), H1_1994_S2919893::finalize(), E735_1998_S3905616::finalize(), DELPHI_1996_S3430090::finalize(), D0_2010_S8671338::finalize(), D0_2010_S8570965::finalize(), D0_2009_S8349509::finalize(), D0_2009_S8202443::finalize(), D0_2008_S7863608::finalize(), D0_2008_S7719523::finalize(), D0_2008_S7662670::finalize(), D0_2006_S6438750::finalize(), D0_2000_S4480767::finalize(), CMS_2011_S8978280::finalize(), CMS_2010_S8656010::finalize(), CMS_2010_S8547297::finalize(), CDF_2009_S8436959::finalize(), CDF_2009_S8383952::finalize(), CDF_2009_S8233977::finalize(), CDF_2008_S8093652::finalize(), CDF_2008_S7540469::finalize(), CDF_2007_S7057202::finalize(), CDF_2006_S6450792::finalize(), CDF_2005_S6080774::finalize(), CDF_2001_S4563131::finalize(), CDF_2000_S4266730::finalize(), CDF_2000_S4155203::finalize(), CDF_1998_S3618439::finalize(), CDF_1990_S2089246::finalize(), CDF_1988_S1865951::finalize(), ATLAS_2011_S9212183::finalize(), ATLAS_2011_S9131140::finalize(), ATLAS_2011_S9128077::finalize(), ATLAS_2011_S9120807::finalize(), ATLAS_2011_S9108483::finalize(), ATLAS_2011_S9041966::finalize(), ATLAS_2011_I925932::finalize(), ATLAS_2011_CONF_2011_098::finalize(), ATLAS_2011_CONF_2011_090::finalize(), ATLAS_2010_S8919674::finalize(), ATLAS_2010_S8914702::finalize(), ATLAS_2010_S8591806::finalize(), ATLAS_2010_CONF_2010_049::finalize(), ALICE_2011_S8945144::finalize(), ALICE_2011_S8909580::finalize(), ALICE_2010_S8706239::finalize(), ALICE_2010_S8625980::finalize(), ALEPH_2004_S5765862::finalize(), ALEPH_1996_S3486095::finalize(), ALEPH_1996_S3196992::finalize(), ALEPH_1991_S2435284::finalize(), Analysis::normalize(), ATLAS_2011_I919017::safeinvscale(), and BinnedHistogram< T >::scale().

00507                                                              {
00508     if (!histo) {
00509       MSG_ERROR("Failed to scale histo=NULL in analysis "
00510                 << name() << " (scale=" << scale << ")");
00511       return;
00512     }
00513     const string hpath = tree().findPath(dynamic_cast<const AIDA::IManagedObject&>(*histo));
00514     MSG_TRACE("Scaling histo " << hpath);
00515 
00516     vector<double> x, y, ex, ey;
00517     for (size_t i = 0, N = histo->axis().bins(); i < N; ++i) {
00518       x.push_back(0.5 * (histo->axis().binLowerEdge(i) + histo->axis().binUpperEdge(i)));
00519       ex.push_back(histo->axis().binWidth(i)*0.5);
00520 
00521       // "Bin height" is a misnomer in the AIDA spec: width is neglected.
00522       // We'd like to do this: y.push_back(histo->binHeight(i) * scale);
00523       y.push_back(histo->binHeight(i)*scale/histo->axis().binWidth(i));
00524 
00525       // "Bin error" is a misnomer in the AIDA spec: width is neglected.
00526       // We'd like to do this: ey.push_back(histo->binError(i) * scale);
00527       ey.push_back(histo->binError(i)*scale/histo->axis().binWidth(i));
00528     }
00529 
00530     string title = histo->title();
00531     string xtitle = histo->xtitle();
00532     string ytitle = histo->ytitle();
00533 
00534     tree().mkdir("/tmpnormalize");
00535     tree().mv(hpath, "/tmpnormalize");
00536 
00537     if (hpath.find(" ") != string::npos) {
00538       throw Error("Histogram path '" + hpath + "' is invalid: spaces are not permitted in paths");
00539     }
00540     AIDA::IDataPointSet* dps = datapointsetFactory().createXY(hpath, title, x, y, ex, ey);
00541     dps->setXTitle(xtitle);
00542     dps->setYTitle(ytitle);
00543 
00544     tree().rm(tree().findPath(dynamic_cast<AIDA::IManagedObject&>(*histo)));
00545     tree().rmdir("/tmpnormalize");
00546 
00547     // Set histo pointer to null - it can no longer be used.
00548     histo = 0;
00549   }

virtual Analysis& setBeams	(	PdgId	beam1,
		PdgId	beam2
	)			`[inline, virtual]`

Set the required beams

Deprecated:: To be removed in 2.0.0. Use .info file and AnalysisInfo class instead

Todo:: Print out a warning to use setRequiredBeams() instead (and really to use .info files)

Definition at line 255 of file Analysis.hh.

References Analysis::setRequiredBeams().

00255                                                          {
00256       /// @todo Print out a warning to use setRequiredBeams() instead (and really to use .info files)
00257       return setRequiredBeams(std::vector<PdgIdPair>(1, make_pair(beam1, beam2)));
00258     }

Analysis & setCrossSection ( double xs )

Set the cross section from the generator.

Definition at line 160 of file Analysis.cc.

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

00160                                                {
00161     _crossSection = xs;
00162     _gotCrossSection = true;
00163     return *this;
00164   }

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

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

Definition at line 236 of file Analysis.hh.

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

Referenced by ATLAS_2011_S9108483::ATLAS_2011_S9108483(), LHCB_2010_S8758301::LHCB_2010_S8758301(), and MC_JetAnalysis::MC_JetAnalysis().

00236                                                      {
00237       info().setNeedsCrossSection(needed);
00238       return *this;
00239     }

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

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

Definition at line 214 of file Analysis.hh.

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

Referenced by Analysis::setBeams().

00214                                                                                   {
00215       info().setBeams(requiredBeams);
00216       return *this;
00217     }

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 225 of file Analysis.hh.

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

00225                                                                                                        {
00226       info().setEnergies(requiredEnergies);
00227       return *this;
00228     }

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

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

Definition at line 128 of file Analysis.hh.

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

00128                                        {
00129       return info().spiresId();
00130     }

double sqrtS ( ) const

Centre of mass energy for this run.

Definition at line 50 of file Analysis.cc.

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

Referenced by UA1_1990_S2044935::analyze(), TASSO_1990_S2148048::analyze(), SFM_1984_S1178091::analyze(), PDG_HADRON_MULTIPLICITIES_RATIOS::analyze(), PDG_HADRON_MULTIPLICITIES::analyze(), MC_TTBAR::analyze(), JADE_1998_S3612880::analyze(), CMS_2011_S9120041::analyze(), CDF_2004_S5839831::analyze(), ATLAS_2010_S8918562::analyze(), ATLAS_2010_S8894728::analyze(), ALICE_2010_S8625980::analyze(), ALEPH_2004_S5765862::analyze(), UA1_1990_S2044935::finalize(), PDG_HADRON_MULTIPLICITIES_RATIOS::finalize(), PDG_HADRON_MULTIPLICITIES::finalize(), JADE_1998_S3612880::finalize(), CMS_2011_S8978280::finalize(), CDF_2004_S5839831::finalize(), ATLAS_2010_S8918562::finalize(), ALICE_2010_S8625980::finalize(), ALEPH_2004_S5765862::finalize(), UA5_1989_S1926373::init(), UA5_1988_S1867512::init(), UA5_1986_S1583476::init(), UA1_1990_S2044935::init(), TASSO_1990_S2148048::init(), SFM_1984_S1178091::init(), PDG_HADRON_MULTIPLICITIES_RATIOS::init(), PDG_HADRON_MULTIPLICITIES::init(), OPAL_2004_S6132243::init(), MC_ZZJETS::init(), MC_ZJETS::init(), MC_WWJETS::init(), MC_WPOL::init(), MC_WJETS::init(), MC_PHOTONJETS::init(), MC_JetAnalysis::init(), MC_HJETS::init(), MC_DIPHOTON::init(), JADE_OPAL_2000_S4300807::init(), JADE_1998_S3612880::init(), CMS_2011_S8978280::init(), CMS_2011_S8884919::init(), CMS_2010_S8547297::init(), CDF_2004_S5839831::init(), CDF_1990_S2089246::init(), CDF_1988_S1865951::init(), ATLAS_2011_S8994773::init(), ATLAS_2010_S8918562::init(), ATLAS_2010_S8894728::init(), ALICE_2010_S8625980::init(), ALICE_2010_S8624100::init(), and ALEPH_2004_S5765862::init().

00050                                {
00051     return handler().sqrtS();
00052   }

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

Whether this analysis is trusted (in any way!).

Definition at line 199 of file Analysis.hh.

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

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

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 145 of file Analysis.hh.

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

00145                                       {
00146       return info().summary();
00147     }

double sumOfWeights ( ) const [protected]

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

Definition at line 108 of file Analysis.cc.

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

00108                                       {
00109     return handler().sumOfWeights();
00110   }

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

Any work to be done on this analysis.

Definition at line 204 of file Analysis.hh.

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

00204                                                {
00205       return info().todos();
00206     }

ITree & tree ( ) [protected]

Access the AIDA tree of the controlling AnalysisHandler object.

Definition at line 35 of file Analysis.cc.

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

Referenced by Analysis::_makeHistoDir(), Analysis::normalize(), and Analysis::scale().

00035                         {
00036     return handler().tree();
00037   }

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

When the original experimental analysis was published.

Definition at line 179 of file Analysis.hh.

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

00179                                    {
00180       return info().year();
00181     }

Friends And Related Function Documentation

friend class AnalysisHandler [friend]

The AnalysisHandler is a friend.

Definition at line 54 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 140 of file ProjectionApplier.hh.

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

AnalysisHandler* _analysishandler [private]

The controlling AnalysisHandler object.

Definition at line 562 of file Analysis.hh.

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

double _crossSection [private]

Definition at line 557 of file Analysis.hh.

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

string _defaultname [protected]

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

Definition at line 547 of file Analysis.hh.

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

map<string, vector<DPSXPoint> > _dpsData [mutable, private]

Collection of x-axis point data to speed up many autobookings: the reference data file should only be read once.

Todo:: Reduce memory occupancy, or clear after initialisation?

Definition at line 570 of file Analysis.hh.

Referenced by Analysis::_cacheBinEdges(), Analysis::_cacheXAxisData(), and Analysis::bookDataPointSet().

bool _gotCrossSection [private]

Definition at line 558 of file Analysis.hh.

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

map<string, BinEdges> _histBinEdges [mutable, private]

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

Todo:: Reduce memory occupancy, or clear after initialisation?

Definition at line 575 of file Analysis.hh.

Referenced by Analysis::_cacheBinEdges(), and Analysis::binEdges().

shared_ptr<AnalysisInfo> _info [protected]

Pointer to analysis metadata object.

Definition at line 550 of file Analysis.hh.

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

bool _madeHistoDir [mutable, private]

Flag to indicate whether the histogram directory is present.

Definition at line 565 of file Analysis.hh.

Referenced by Analysis::_makeHistoDir().

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

Analysis Class Reference

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