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)

Private Attributes
double	fEfficiency
TH1D *	fHistogram
std::vector< TF1 * > *	fFunctionContainer
int	fNBins
double	fNormalization
double	fOriginalNormalization
std::string	fChannelName
std::string	fProcessName
TRandom3 *	fRandom

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

channelname	The name of the channel.
process	name The name of the process.

Definition at line 19 of file BCMTFTemplate.cxx.

   : fEfficiency(0)
   , fHistogram(0)
   , fNBins(0)
   , fNormalization(0)
   , fOriginalNormalization(0)
{
   fChannelName = channelname;
   fProcessName = processname;
   fFunctionContainer = new std::vector<TF1 *>(0);
   fRandom = new TRandom3(0);
}

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

options	A 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.
norm	The target normalization.

Returns

A histogram with each bin fluctuated by the uncertainty on the bin content.

Definition at line 71 of file BCMTFTemplate.cxx.

{
   // option flags
   bool flag_p = false;
   bool flag_g = false;
   bool flag_z = false;

   // check content of options string
   if (options.find("P") < options.size()) {
      flag_p = true;
   }

   if (options.find("G") < options.size()) {
      flag_g = true;
   }

   if (options.find("Z") < options.size()) {
      flag_z = true;
   }

   if (flag_p && flag_g) {
      flag_g = false;
   }

   TH1D hist_temp = TH1D(*fHistogram);

   for (int i = 1; i <= fNBins; ++i) {
      double expectation = fOriginalNormalization * hist_temp.GetBinContent(i);
      double error = fOriginalNormalization * hist_temp.GetBinError(i);
      double n = 0;

      // throw random number according to Poisson distribution
      if (flag_p) {
         n = (double) fRandom->Poisson(expectation);
      }

      // throw random number according to Gauss distribution
      else if (flag_g) {
         double dn = fRandom->Gaus(expectation, error);

         // make it a truncated Gaussian
         if (flag_z) {
            while (n + dn < 0)
               dn = fRandom->Gaus(expectation, error);
         }
         n += dn;
      }

      // set the number of events in the template
      hist_temp.SetBinContent(i, n);
   }

   // normalize histogram
   double orignorm = hist_temp.Integral();

   if (orignorm)
      hist_temp.Scale(norm / orignorm);

   return hist_temp;
}

std::string BCMTFTemplate::GetChannelName ( )

inline

Returns

The name of the channel.

Definition at line 56 of file BCMTFTemplate.h.

        { return fChannelName; };

double BCMTFTemplate::GetEfficiency ( )

inline

Returns

The efficiency.

Definition at line 66 of file BCMTFTemplate.h.

        { return fEfficiency; };

std::vector<TF1 *>* BCMTFTemplate::GetFunctionContainer ( )

inline

Returns

The function container.

Definition at line 97 of file BCMTFTemplate.h.

        { return fFunctionContainer; };

TH1D* BCMTFTemplate::GetHistogram ( )

inline

Returns

The TH1D histogram.

Definition at line 71 of file BCMTFTemplate.h.

        { return fHistogram; };

int BCMTFTemplate::GetNBins ( )

inline

Returns

The number of bins.

Definition at line 102 of file BCMTFTemplate.h.

        { return fNBins; };

double BCMTFTemplate::GetNorm ( )

inline

Returns

The normalization.

Definition at line 76 of file BCMTFTemplate.h.

        { return fNormalization; };

double BCMTFTemplate::GetOriginalNorm ( )

inline

Returns

The original normalization.

Definition at line 81 of file BCMTFTemplate.h.

        { return fOriginalNormalization; };

std::string BCMTFTemplate::GetProcessName ( )

inline

Returns

The name of the process.

Definition at line 61 of file BCMTFTemplate.h.

        { return fProcessName; };

void BCMTFTemplate::SetEfficiency ( double  eff)

inline

Set the efficiency.

Parameters

eff	The efficiency.

Definition at line 113 of file BCMTFTemplate.h.

        { fEfficiency = eff; };

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.

{
   fFunctionContainer = funccont;
   fNBins = nbins;
}

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

Set the histogram.

Parameters

hist	The TH1D histogram.
norm	The target normalization.

Definition at line 38 of file BCMTFTemplate.cxx.

{
   // set histogram
   fHistogram = hist;

   // check if histogram exists
   if (!hist)
      return;

   // get number of bins
   fNBins = fHistogram->GetNbinsX();

   // set original normalization
   double orignorm = fHistogram->Integral();
   SetOrignialNormalization(orignorm);

   // normalize histogram
   if (orignorm && norm)
      fHistogram->Scale(norm / orignorm);

   // set normalization
   if (norm)
      fNormalization = norm;
}

void BCMTFTemplate::SetOrignialNormalization ( double  norm)

inline

Set the original normalization.

Parameters

norm	The normalization.

Definition at line 126 of file BCMTFTemplate.h.

                                                   {
                fOriginalNormalization = norm; };

Member Data Documentation

std::string BCMTFTemplate::fChannelName

private

The name of the channel.

Definition at line 164 of file BCMTFTemplate.h.

double BCMTFTemplate::fEfficiency

private

The efficiency of the contribution.

Definition at line 140 of file BCMTFTemplate.h.

std::vector<TF1 *>* BCMTFTemplate::fFunctionContainer

private

A histogram alternative for templates: a vector of TF1 functions.

Definition at line 148 of file BCMTFTemplate.h.

TH1D* BCMTFTemplate::fHistogram

private

The TH1D histogram.

Definition at line 144 of file BCMTFTemplate.h.

int BCMTFTemplate::fNBins

private

The number of bins in the histogram.

Definition at line 152 of file BCMTFTemplate.h.

double BCMTFTemplate::fNormalization

private

The normalization.

Definition at line 156 of file BCMTFTemplate.h.

double BCMTFTemplate::fOriginalNormalization

private

The original normalization.

Definition at line 160 of file BCMTFTemplate.h.

std::string BCMTFTemplate::fProcessName

private

The name of the process.

Definition at line 168 of file BCMTFTemplate.h.

TRandom3* BCMTFTemplate::fRandom

private

A random number generator.

Definition at line 172 of file BCMTFTemplate.h.

---

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

• BCMTFTemplate.h
• BCMTFTemplate.cxx