BAT  0.9.4
The Bayesian analysis toolkit
 All Classes Namespaces Functions Variables Enumerations
BCMTFTemplate Class Reference

A class describing a template. More...

#include <BCMTFTemplate.h>

Public Member Functions

Constructors and destructors
 BCMTFTemplate (const char *channelname, const char *processname)
 
 ~BCMTFTemplate ()
 
Member functions (get)
std::string GetChannelName ()
 
std::string GetProcessName ()
 
double GetEfficiency ()
 
TH1D * GetHistogram ()
 
double GetNorm ()
 
double GetOriginalNorm ()
 
TH1D FluctuateHistogram (std::string options="GZ", double norm=1)
 
std::vector< TF1 * > * GetFunctionContainer ()
 
int GetNBins ()
 
Member functions (set)
void SetEfficiency (double eff)
 
void SetHistogram (TH1D *hist, double norm=1)
 
void SetOrignialNormalization (double norm)
 
void SetFunctionContainer (std::vector< TF1 * > *funccont, int nbins)
 

Detailed Description

A class describing a template.

Author
Daniel Kollar
Kevin Kröninger
Version
1.1
Date
06.2012 This class describes a template.

Definition at line 32 of file BCMTFTemplate.h.

Constructor & Destructor Documentation

BCMTFTemplate::BCMTFTemplate ( const char *  channelname,
const char *  processname 
)

The default constructor.

Parameters
channelnameThe name of the channel.
processname The name of the process.

Definition at line 19 of file BCMTFTemplate.cxx.

BCMTFTemplate::~BCMTFTemplate ( )

The default destructor.

Definition at line 33 of file BCMTFTemplate.cxx.

Member Function Documentation

TH1D BCMTFTemplate::FluctuateHistogram ( std::string  options = "GZ",
double  norm = 1 
)

Fluctuate the original template histogram by the uncertainty on the bin content.

Parameters
optionsA set of options. "P" : use Poisson model, the expectation value parameter is the bin content and also defines the uncertainties. "G" [default] : use a Gaussian mode, the expectation value paramer mu is the bin content, the uncertainty sigma is defined by the uncertainty in the histogram. "Z" [default] : make sure that the bin content is positive.
normThe target normalization.
Returns
A histogram with each bin fluctuated by the uncertainty on the bin content.

Definition at line 71 of file BCMTFTemplate.cxx.

std::string BCMTFTemplate::GetChannelName ( )
inline
Returns
The name of the channel.

Definition at line 56 of file BCMTFTemplate.h.

double BCMTFTemplate::GetEfficiency ( )
inline
Returns
The efficiency.

Definition at line 66 of file BCMTFTemplate.h.

std::vector<TF1 *>* BCMTFTemplate::GetFunctionContainer ( )
inline
Returns
The function container.

Definition at line 97 of file BCMTFTemplate.h.

TH1D* BCMTFTemplate::GetHistogram ( )
inline
Returns
The TH1D histogram.

Definition at line 71 of file BCMTFTemplate.h.

int BCMTFTemplate::GetNBins ( )
inline
Returns
The number of bins.

Definition at line 102 of file BCMTFTemplate.h.

double BCMTFTemplate::GetNorm ( )
inline
Returns
The normalization.

Definition at line 76 of file BCMTFTemplate.h.

double BCMTFTemplate::GetOriginalNorm ( )
inline
Returns
The original normalization.

Definition at line 81 of file BCMTFTemplate.h.

std::string BCMTFTemplate::GetProcessName ( )
inline
Returns
The name of the process.

Definition at line 61 of file BCMTFTemplate.h.

void BCMTFTemplate::SetEfficiency ( double  eff)
inline

Set the efficiency.

Parameters
effThe efficiency.

Definition at line 113 of file BCMTFTemplate.h.

void BCMTFTemplate::SetFunctionContainer ( std::vector< TF1 * > *  funccont,
int  nbins 
)

Set a function container funccont The function container nbins The number of bins (and functions)

Definition at line 64 of file BCMTFTemplate.cxx.

void BCMTFTemplate::SetHistogram ( TH1D *  hist,
double  norm = 1 
)

Set the histogram.

Parameters
histThe TH1D histogram.
normThe target normalization.

Definition at line 38 of file BCMTFTemplate.cxx.

void BCMTFTemplate::SetOrignialNormalization ( double  norm)
inline

Set the original normalization.

Parameters
normThe normalization.

Definition at line 126 of file BCMTFTemplate.h.


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