checkmate is hosted by Hepforge, IPPP Durham
AnalysisBase Documentation  1.2.0
Miscellaneous

Other useful helper functions and variables. More...

Functions

void AnalysisBase::setInformation (std::string s)
 Sets the header that is printed on top of all output files. More...
 
void AnalysisBase::setLuminosity (double l)
 Sets the luminosity. More...
 
void AnalysisBase::setAnalysisName (std::string name)
 Sets the analysis name to denote the name of the output files. More...
 
double AnalysisBase::normalize (double x)
 Normalises number to luminosity and cross section. More...
 
void AnalysisBase::ignore (std::string ignore_what)
 Does not read out unneeded ROOT information. More...
 

Variables

ExRootResult * AnalysisBase::result
 Object to ExRootAnalysis for internal studies. More...
 
double AnalysisBase::weight
 Current event weight usable for e.g. histograms. More...
 

Detailed Description

Other useful helper functions and variables.

Functions here perform simple tasks and are most commonly run in initialize() or finalize(). Many of them are automatically set by the AnalysisManager.

Function Documentation

void AnalysisBase::setInformation ( std::string  s)
inlineprotected

Sets the header that is printed on top of all output files.

Parameters
sThe string that is to be printed as the header. Linebreaks have to be explicitly set using \n. and lines should start with '# ' (including the space to declare them as comments for the CheckMATE evaluation module.

Definition at line 524 of file AnalysisBase.h.

void AnalysisBase::setLuminosity ( double  l)
inlineprotected

Sets the luminosity.

Parameters
lThe luminosity of the analysis the input should be normalised to. The units objects should be used to give the unit.

Definition at line 530 of file AnalysisBase.h.

void AnalysisBase::setAnalysisName ( std::string  name)
inlineprotected

Sets the analysis name to denote the name of the output files.

Parameters
nameThe name of the analysis (should correspond to the name of the class)

Definition at line 536 of file AnalysisBase.h.

double AnalysisBase::normalize ( double  x)
inlineprotected

Normalises number to luminosity and cross section.

This function is useful if one stores data beyond the signal/cutflow/control region data which is normalised automatically. Example: One can define a histogram in initialize(), fill the bins with data in analyze() using the AnalysisBase::weight of the current event and normalize() the histogram bins in the finalize() step of the analysis to physical numbers.

Parameters
xThe number to be normalised
Returns
x * luminosity * crossSectionOfEventFile / (sum of weights)

Definition at line 547 of file AnalysisBase.h.

void AnalysisBase::ignore ( std::string  ignore_what)
protected

Does not read out unneeded ROOT information.

If needed, this function should be called within initialize().

Parameters
ignore_whatWhich information should not be stored? (possible options: "electrons", "electrons_looseIsolation","electronsMedium","electronsTight","muons", "muons_looseIsolation","muonsCombinedPlus","muonsCombined","photons","photons_looseIsolation", "tracks","towers"

Definition at line 296 of file AnalysisBase.cc.

Variable Documentation

ExRootResult* AnalysisBase::result
protected

Object to ExRootAnalysis for internal studies.

Definition at line 549 of file AnalysisBase.h.

double AnalysisBase::weight
protected

Current event weight usable for e.g. histograms.

Definition at line 562 of file AnalysisBase.h.