Observable Class Reference

A class for observables. More...

#include <Observable.h>

Inheritance diagram for Observable:

Detailed Description

A class for observables.

Author

HEPfit Collaboration

Copyright

GNU General Public License

The class for building an observable and storing its different parameters read from the SomeModel.conf file or specified by the user. The name (thname) of the observable has to correspond to the allowed name of observables listed in the ThFactory class.

Definition at line 28 of file Observable.h.

Public Member Functions
double	computeTheoryValue ()
	A method to access the computed theory value of the observable. More...
virtual double	computeWeight ()
	A method to compute the weight associated with the observable. More...
virtual double	computeWeight (double th)
	A method to compute the weight associated with the observable. More...
virtual double	computeWeight (double th, double ave_i, double errg_i, double errf_i)
	A method to compute the weight associated with the observable. More...
virtual double	computeWeight (double th1, double th2)
	A method to compute the weight associated with the observable. More...
double	getAve () const
	A get method to access the average value of the observable. More...
std::string	getDistr () const
	A get method to access the name of the distribution of the observable. More...
double	getErrf () const
	A get method to access the flat error of the observable. More...
double	getErrg () const
	A get method to access the Gaussian error of the observble. More...
std::string	getFilename () const
	A get method to access the filename of the observables experimental likelihood file. More...
std::string	getHistoname () const
	A get method to access the name for the histogram of the observable. More...
std::string	getLabel () const
	A get method to access the label for the observable. More...
double	getMax () const
	A get method to access the maximum value of the observable. More...
double	getMin () const
	A get method to access the minimum value of the observable. More...
std::string	getName () const
	A get method to access the name of the observable. More...
virtual int	getNChannels ()
virtual int	getNTheoryValues ()
std::string	getObsType () const
	A get method to get the Observable type. More...
virtual void	getTheoryValues (std::vector< double > &theoryValues_i)
std::string	getThname () const
	A get method to access the thname of the observable as defined in ThFactory class. More...
ThObservable *	getTho () const
	A get method to access the pointer to the object of the ThObservable class. More...
virtual bool	isNew ()
bool	isTMCMC () const
	A method to check if the observable is listed for MCMC. More...
bool	isWriteChain () const
	A method to check if the observable is listed for writing chains. More...
double	LogGaussian (double x, double ave, double sigma)
double	LogSplitGaussian (double x, double ave, double errl, double errr)
	Observable ()
	The default constructor. More...
	Observable (const Observable &orig)
	The copy constructor. More...
	Observable (const std::string name_i, const std::string thname_i, const std::string label_i, const bool tMCMC_i, const double min_i, const double max_i, ThObservable *tho_i)
	Constructor. More...
boost::tokenizer< boost::char_separator< char > >::iterator &	ParseObservable (std::string &type, boost::tokenizer< boost::char_separator< char > > *tok, boost::tokenizer< boost::char_separator< char > >::iterator &beg, std::string &filepath, std::string &infilename, int rank)
	The parser for Observables. More...
void	setAve (double ave)
	A set method to fix the average value of the observable. More...
void	setDistr (std::string distr)
	A set method to fix the name of the distribution of the observable. More...
void	setErrf (double errf)
	A set method to fix the flat error of the observable. More...
void	setErrg (double errg)
	A set method to fix the gaussian error of the observable. More...
void	setErrgl (double errgl)
	A set method to fix the left Gaussian error of the observable. More...
void	setErrgr (double errgr)
	A set method to fix the right Gaussian error of the observable. More...
void	setFilename (std::string filename_i)
void	setHasInverseCovariance (bool hasInverseCovariance)
	A set method to state that the Observable is a part of ObservablesWithInverseCovariance. More...
void	setHistoname (std::string histoname_i)
	A set method to set the name of the histogram containing the likelihood. More...
void	setLabel (std::string label)
	A set method to fix the label for the observable. More...
virtual void	setLikelihoodFromHisto (std::string filename, std::string histoname)
	A set method to set the likelihood from which the experimental likelihood of the observable will be read. More...
void	setMax (double max)
	A set method to fix the maximum value for the observable. More...
void	setMin (double min)
	A set method to fix the minimum value for the observable. More...
void	setName (std::string name)
	A set method to fix the name for the observable. More...
void	setObsType (std::string &obsType_s)
	A set method to set the Observable type. More...
virtual void	setParametricLikelihood (std::string filename)
	A set method to set a parametric likelihood reading parameters from a file. More...
virtual void	setParametricLikelihood (std::string filename, std::vector< ThObservable * > thObsV)
void	setThname (std::string thname)
	A set method to fix the name of the observable as listed in ThFactory class. More...
void	setTho (ThObservable *tho_i)
	A set method to fix the pointer to object of type ThObservable. More...
void	setTho (ThObservable *tho_i, double bmin, double bmax)
	A set method to fix the pointer to object of type ThObservable. More...
void	setTMCMC (bool tMCMC)
	A set method to fix the observable's inclusion in the MCMC listing. More...
virtual	~Observable ()
	The default destructor. More...

Protected Attributes
double	ave
	The average value of the observable. More...
double	bin_max
	The maximum valus of the observable bin. More...
double	bin_min
	The minimum value of the observable bin. More...
std::string	distr
	The name of the distribution of the the observable. More...
double	errf
	The flat error of the observable. More...
double	errg
	The gaussian error of the observable. More...
double	errgl
	The lower gaussian error of the observable. More...
double	errgr
	The upper gaussian error of the observable. More...
std::string	filename
	The name of the file containing the experimental likelihood for the observable. More...
bool	hasInverseCovariance
std::string	histoname
	The name of the histogram for the observable. More...
TH1D *	inhisto
	1D Histogram containing the experimental likelihood for the observable More...
int	iterationNo
	A counter for the interation that helps with the observable caching. More...
std::string	label
	A label for the observable. More...
double	max
	The maximum valus of the observable. More...
double	min
	The minimum value of the observable. More...
std::string	name
	A name for the observable. More...
std::string	obsType
	Type of the Observable. 0: Observable, 1: HiggsObservable, 2: BinnedObservable, 3: FunctionObservable. More...
std::string	thname
	The name for the observable as fixed in the ThObservable class. More...
ThObservable *	tho
	A pointer of to the object of the ThObservables class. More...
double	thValue
	The theory value of the first observable. More...
bool	tMCMC
	The flag to include or exclude the observable from the MCMC run. More...
bool	writeChain
	The flag to write the chain for the observable from the MCMC run. More...

Friends
std::ostream &	operator<< (std::ostream &output, const Observable &o)
	Befriending of the std::ostream operator << to generate an output stream for printing the observables details. More...

Constructor & Destructor Documentation

Observable() [1/3]

Observable::Observable	(	const std::string	name_i,
		const std::string	thname_i,
		const std::string	label_i,
		const bool	tMCMC_i,
		const double	min_i,
		const double	max_i,
		ThObservable *	tho_i
	)

Constructor.

Parameters

[in]	name_i	a given name for the observable
[in]	thname_i	the thname for the observable fixed in ThFactory()
[in]	label_i	the label assigned to the observable
[in]	tMCMC_i	boolean flag to indicate inclusion in MCMC
[in]	min_i	minimum value for the observable
[in]	max_i	maximum value for the observable
[in]	tho_i	a pointer to an object of type ThObservable

Definition at line 18 of file Observable.cpp.

{
    name = name_i;
    thname = thname_i;
    label = label_i;
    min = min_i;
    max = max_i;
    tMCMC = tMCMC_i;
    tho = tho_i;
    distr = "";
    filename = "";
    histoname = "";
    ave = 0.;
    errg = 0.;
    errf = 0.;
    errgl = 0.;
    errgr = 0.;
    obsType = "";
    bin_min = 0.;
    bin_max = 0.;
    iterationNo = std::numeric_limits<int>::max();
    writeChain = false;
    hasInverseCovariance = false;
}

Observable() [2/3]

Observable::Observable

(

const Observable &

orig

)

The copy constructor.

Definition at line 49 of file Observable.cpp.

{
    name = orig.name;
    thname = orig.thname;
    label = orig.label;
    min = orig.min;
    max = orig.max;
    tMCMC = orig.tMCMC;
    tho = orig.tho;
    distr = orig.distr; 
    filename = orig.filename; 
    histoname = orig.histoname;
    ave = orig.ave; 
    errg = orig.errg; 
    errf = orig.errf;
    errgl = orig.errgl;
    errgr = orig.errgr;
    obsType = orig.obsType;
    bin_min = orig.bin_min;
    bin_min = orig.bin_max;
    iterationNo = orig.iterationNo;
    inhisto = orig.inhisto;
    writeChain = orig.writeChain;
    hasInverseCovariance = orig.hasInverseCovariance;
}

Observable() [3/3]

Observable::Observable

(

)

The default constructor.

Definition at line 75 of file Observable.cpp.

{
    name = "";
    thname = "";
    label = "";
    min = 0.;
    max = 0.;
    tMCMC = false;
    tho = NULL;
    distr = ""; 
    filename = ""; 
    histoname = "";
    ave = 0.; 
    errg = 0.; 
    errf = 0.;
    errgl = 0.;
    errgr = 0.;
    obsType = "";
    bin_min = 0.;
    bin_max = 0.;
    iterationNo = std::numeric_limits<int>::max();
    writeChain = false;
    hasInverseCovariance = false;
}

~Observable()

Observable::~Observable ( )

virtual

The default destructor.

Definition at line 100 of file Observable.cpp.

{}

Member Function Documentation

computeTheoryValue()

double Observable::computeTheoryValue

(

)

A method to access the computed theory value of the observable.

Definition at line 130 of file Observable.cpp.

{
    if (tho->getModel().getIterationNo() == iterationNo) {
        return thValue;
    } else {
        iterationNo = tho->getModel().getIterationNo();
        thValue = tho->computeThValue();
        return thValue;
    }   
}

computeWeight() [1/4]

virtual double Observable::computeWeight ( )

inlinevirtual

A method to compute the weight associated with the observable.

Reimplemented in Observable2D, and HiggsObservable.

Definition at line 113 of file Observable.h.

    {
        return computeWeight(computeTheoryValue());
    }

computeWeight() [2/4]

double Observable::computeWeight ( double  th )

virtual

A method to compute the weight associated with the observable.

Parameters

[in]

th

the theoretical value of the observable

Definition at line 152 of file Observable.cpp.

{
    double logprob;
    if (distr.compare("weight") == 0) {
        if (getObsType().compare("AsyGausObservable") == 0) logprob = LogSplitGaussian(th, ave, errgl, errgr);
        else {
            if (errf == 0.)
                logprob = LogGaussian(th, ave, errg);
            else if (errg == 0.) {
                if (th < ave + errf && th > ave - errf)
                    logprob = 1.;
                else
                    logprob = log(0.);
            } else
                logprob = log(TMath::Erf((th - ave + errf) / sqrt(2.) / errg)
                    - TMath::Erf((th - ave - errf) / sqrt(2.) / errg));
        }
    } else if (distr.compare("file") == 0) {
        int i = inhisto->FindBin(th);
        if (inhisto->IsBinOverflow(i) || inhisto->IsBinUnderflow(i))
            logprob = log(0.);
        else
            logprob = log(inhisto->GetBinContent(i));
        //logprob = log(h->GetBinContent(h->FindBin(th)));
    } else
        throw std::runtime_error("ERROR: MonteCarloEngine::Weight() called without weight for "
            + name);
    return (logprob);
}

computeWeight() [3/4]

double Observable::computeWeight ( double  th, double  ave_i, double  errg_i, double  errf_i  )

virtual

A method to compute the weight associated with the observable.

Parameters

[in]	th	the theoretical value of the observable
[in]	ave_i	the average value of the observable
[in]	errg_i	the Gaussian error of the observable
[in]	errf_i	the flat error of the observable

Definition at line 182 of file Observable.cpp.

{
    double logprob;
    if (distr.compare("weight") == 0) {
        if (errf_i == 0.)
            logprob = LogGaussian(th, ave_i, errg_i);
        else if (errg_i == 0.) {
            if (th < ave_i + errf_i && th > ave_i - errf_i)
                logprob = 1.;
            else
                logprob = log(0.);
        } else
            logprob = log(TMath::Erf((th - ave_i + errf_i) / sqrt(2.) / errg_i)
                - TMath::Erf((th - ave_i - errf_i) / sqrt(2.) / errg_i));
    } else
        throw std::runtime_error("ERROR: MonteCarloEngine::Weight() called without weight for "
            + name);
    return (logprob);
}

computeWeight() [4/4]

virtual double Observable::computeWeight ( double  th1, double  th2  )

inlinevirtual

A method to compute the weight associated with the observable.

Parameters

[in]	th1	the theoretical value of the first observable
[in]	th2	the theoretical value of the second observable

Reimplemented in Observable2D.

Definition at line 105 of file Observable.h.

    {
        return 0.0;
    };

getAve()

double Observable::getAve ( ) const

inline

A get method to access the average value of the observable.

Returns

the average value of the observable

Definition at line 122 of file Observable.h.

    {
        return ave;
    }

getDistr()

std::string Observable::getDistr ( ) const

inline

A get method to access the name of the distribution of the observable.

Returns

the name of the distribution of the observable

Definition at line 140 of file Observable.h.

    {
        return distr;
    }

getErrf()

double Observable::getErrf ( ) const

inline

A get method to access the flat error of the observable.

Returns

the flat error of the observable

Definition at line 158 of file Observable.h.

    {
        return errf;
    }

getErrg()

double Observable::getErrg ( ) const

inline

A get method to access the Gaussian error of the observble.

Returns

the Gauissian error of the observable

Definition at line 176 of file Observable.h.

    {
        return errg;
    }

getFilename()

std::string Observable::getFilename ( ) const

inline

A get method to access the filename of the observables experimental likelihood file.

Returns

the name of the file

Definition at line 212 of file Observable.h.

    {
        return filename;
    }

getHistoname()

std::string Observable::getHistoname ( ) const

inline

A get method to access the name for the histogram of the observable.

Returns

the name of the histogram for the observable

Definition at line 251 of file Observable.h.

    {
        return histoname;
    }

getLabel()

std::string Observable::getLabel ( ) const

inline

A get method to access the label for the observable.

Returns

the label for the observable

Definition at line 269 of file Observable.h.

    {
        return label;
    }

getMax()

double Observable::getMax ( ) const

inline

A get method to access the maximum value of the observable.

Returns

the maximum value of the observable

Definition at line 287 of file Observable.h.

    {
        return max;
    }

getMin()

double Observable::getMin ( ) const

inline

A get method to access the minimum value of the observable.

Returns

the minimum value of the observable

Definition at line 305 of file Observable.h.

    {
        return min;
    }

getName()

std::string Observable::getName ( ) const

inline

A get method to access the name of the observable.

Returns

the name of the observable

Definition at line 323 of file Observable.h.

    {
        return name;
    }

getNChannels()

virtual int Observable::getNChannels ( )

inlinevirtual

Reimplemented in HiggsObservable.

Definition at line 456 of file Observable.h.

{ return 0; }; 

getNTheoryValues()

virtual int Observable::getNTheoryValues ( )

inlinevirtual

Reimplemented in HiggsObservable.

Definition at line 454 of file Observable.h.

{ return 0; }; 

getObsType()

std::string Observable::getObsType ( ) const

inline

A get method to get the Observable type.

Returns

a string containing the observable type

Definition at line 404 of file Observable.h.

    {
        return obsType;
    }

getTheoryValues()

virtual void Observable::getTheoryValues ( std::vector< double > &  theoryValues_i )

inlinevirtual

Reimplemented in HiggsObservable.

Definition at line 452 of file Observable.h.

{}; 

getThname()

std::string Observable::getThname ( ) const

inline

A get method to access the thname of the observable as defined in ThFactory class.

Returns

thname the name of the observable as listed in ThFactory class

Definition at line 368 of file Observable.h.

    {
        return thname;
    }

getTho()

ThObservable* Observable::getTho ( ) const

inline

A get method to access the pointer to the object of the ThObservable class.

Returns

pointer to the object of type ThObservable

Definition at line 386 of file Observable.h.

    {
        return tho;
    }

isNew()

virtual bool Observable::isNew ( )

inlinevirtual

Reimplemented in HiggsObservable.

Definition at line 458 of file Observable.h.

{ return false; };

isTMCMC()

bool Observable::isTMCMC ( ) const

inline

A method to check if the observable is listed for MCMC.

Returns

true or false

Definition at line 341 of file Observable.h.

    {
        return tMCMC;
    }

isWriteChain()

bool Observable::isWriteChain ( ) const

inline

A method to check if the observable is listed for writing chains.

Returns

true or false

Definition at line 350 of file Observable.h.

    {
        return writeChain;
    }

LogGaussian()

double Observable::LogGaussian	(	double	x,
		double	ave,
		double	sigma
	)

A method to compute the log of a Gaussian likelihood

Parameters

[in]	x	the value of the Gaussian distributed variable
[in]	ave	the average value
[in]	sigma	the error

Returns

the log likelihood at point x

Definition at line 147 of file Observable.cpp.

{
    return -0.5 * (x-ave) * (x-ave) / sigma / sigma;
}

LogSplitGaussian()

double Observable::LogSplitGaussian	(	double	x,
		double	ave,
		double	errl,
		double	errr
	)

A method to compute the log of a split Gaussian likelihood

Parameters

	x	the value of the split-Gaussian distributed variable
[in]	ave	the average value
[in]	errl	the left-side error
[in]	errr	the right-side error

Returns

the log likelihood at point x

Definition at line 141 of file Observable.cpp.

{
    double sigma = (x > ave ? errr : errl);
    return -0.5 * (x-ave) * (x-ave) / sigma / sigma;
}

ParseObservable()

boost::tokenizer< boost::char_separator< char > >::iterator & Observable::ParseObservable	(	std::string &	type,
		boost::tokenizer< boost::char_separator< char > > *	tok,
		boost::tokenizer< boost::char_separator< char > >::iterator &	beg,
		std::string &	filepath,
		std::string &	infilename,
		int	rank
	)

The parser for Observables.

Parameters

[in]	type	the string specifying the type of the observable
[in]	tok	the tokenizer containing the line being parsed
[in]	beg	the iterator that parses a line in the config file
[in]	filepath	the path to the config file being parsed
[in]	infilename	the name of the config file being parsed
[in]	rank	the MPI rank of the process accessing the code

Returns

the line number (integer) after the parsing is done

Definition at line 202 of file Observable.cpp.

{
    if ((type.compare("Observable") == 0 || type.compare("HiggsObservable")) && std::distance(tok->begin(), tok->end()) < 8) {
        if(rank == 0) throw std::runtime_error("ERROR: lack of information on " + *beg + " in " + infilename);
        else sleep (2);
    } else if (type.compare("BinnedObservable") == 0 && std::distance(tok->begin(), tok->end()) < 12) {
        if(rank == 0) throw std::runtime_error("ERROR: lack of information on " + *beg + " in " + infilename);
        else sleep (2);
    } else if (type.compare("FunctionObservable") == 0 && std::distance(tok->begin(), tok->end()) < 11) {
        if(rank == 0) throw std::runtime_error("ERROR: lack of information on " + *beg + " in " + infilename);
        else sleep (2);
    } else {
        obsType = type;
        name = *beg;
        ++beg;
        thname = *beg;
        ++beg;
        label = *beg;
        size_t pos = 0;
        while ((pos = label.find("~", pos)) != std::string::npos)
            label.replace(pos++, 1, " ");
        ++beg;
        min = atof((*beg).c_str());
        ++beg;
        max = atof((*beg).c_str());
        ++beg;
        std::string toMCMC = *beg;
        if (toMCMC.compare("MCMC") == 0)
            tMCMC = true;
        else if (toMCMC.compare("noMCMC") == 0)
            tMCMC = false;
        else {
            if (rank == 0) throw std::runtime_error("ERROR: wrong MCMC flag in " + name + ".\n");
            else sleep (2);
        }
 
        if (obsType.compare("Observable") == 0 || obsType.compare("BinnedObservable") == 0 || obsType.compare("FunctionObservable") == 0 || type.compare("AsyGausObservable") == 0) {
            ++beg;
            distr = *beg;
            if (distr.compare("file") == 0) {
                if (std::distance(tok->begin(), tok->end()) < 10) {
                    if (rank == 0) throw std::runtime_error("ERROR: lack of information on " + *beg + " in " + infilename + ".\n");
                    else sleep(2);
                } else if (type.compare("AsyGausObservable") == 0) {
                    if (rank == 0) throw std::runtime_error("ERROR: AsyGausObservable cannot be specified with a input histogram, use Observable keyword instead.\n");
                    else sleep(2);
                } else {
                    filename = filepath + *(++beg);
                    histoname = *(++beg);
                    setLikelihoodFromHisto(filename, histoname);
                    if (rank == 0) std::cout << "added input histogram " << filename << "/" << histoname << std::endl;
                }
            } else if (distr.compare("weight") == 0) {
                if (std::distance(tok->begin(), tok->end()) < 11) {
                    if(rank == 0) throw std::runtime_error("ERROR: lack of information on " + *beg + " in " + infilename + ".\n");
                    else sleep (2);
                }
                ++beg;
                ave = atof((*beg).c_str());
                ++beg;
                if (type.compare("AsyGausObservable") == 0) errgl = atof((*beg).c_str());
                else errg = atof((*beg).c_str());
                ++beg;
                if (type.compare("AsyGausObservable") == 0) errgr = atof((*beg).c_str());
                else errf = atof((*beg).c_str());
                if (type.compare("AsyGausObservable") != 0 && errf == 0. && errg == 0. && !hasInverseCovariance) {
                    if (rank == 0) throw std::runtime_error("ERROR: The Gaussian and flat error in weight for " + name + " cannot both be 0. in the " + infilename + " .\n");
                    else sleep(2);
                }
                if (type.compare("AsyGausObservable") == 0 && errgl == 0. && errgr == 0. && !hasInverseCovariance) {
                    if (rank == 0) throw std::runtime_error("ERROR: The left Gaussian and right Gaussian error in weight for " + name + " cannot both be 0. in the " + infilename + " .\n");
                    else sleep(2);
                }
            } else if (distr.compare("noweight") == 0 || distr.compare("writeChain") == 0) {
                if (!tMCMC) writeChain = (distr.compare("writeChain") == 0);
                else {
                    if (rank == 0) throw std::runtime_error("ERROR: writeChains cannot be requested since " + name + " is set to MCMC in " + infilename + " .\n");
                    else sleep(2);
                }
                if (obsType.compare("BinnedObservable") == 0 || obsType.compare("FunctionObservable") == 0) {
                    ++beg;
                    ++beg;
                    ++beg;
                }
            } else {
                if (rank == 0) throw std::runtime_error("ERROR: wrong distribution flag in " + name + " in file " + infilename + ": can be only weight, noweight or writeChain.\n");
                else sleep(2);
            }
            ++beg;
            if (obsType.compare("BinnedObservable") == 0) {
                bin_min = atof((*beg).c_str());
                ++beg;
                bin_max = atof((*beg).c_str());
                ++beg;
            } else if (obsType.compare("FunctionObservable") == 0) {
                bin_min = atof((*beg).c_str());
                ++beg;
            }
            if (beg != tok->end() && rank == 0) std::cout << "WARNING: unread information in observable " << name << std::endl;
        }
    }
    return beg;
}

setAve()

void Observable::setAve ( double  ave )

inline

A set method to fix the average value of the observable.

Parameters

[in]

ave

the average value of the observable

Definition at line 131 of file Observable.h.

    {
        this->ave = ave;
    }

setDistr()

void Observable::setDistr ( std::string  distr )

inline

A set method to fix the name of the distribution of the observable.

Parameters

[in]

distr

the name of the distribution of the observable

Definition at line 149 of file Observable.h.

    {
        this->distr = distr;
    }

setErrf()

void Observable::setErrf ( double  errf )

inline

A set method to fix the flat error of the observable.

Parameters

[in]

errf

the flat error of the observable

Definition at line 167 of file Observable.h.

    {
        this->errf = errf;
    }

setErrg()

void Observable::setErrg ( double  errg )

inline

A set method to fix the gaussian error of the observable.

Parameters

[in]

errg

the Gaussian error of the observable

Definition at line 185 of file Observable.h.

    {
        this->errg = errg;
    }

setErrgl()

void Observable::setErrgl ( double  errgl )

inline

A set method to fix the left Gaussian error of the observable.

Parameters

[in]

errgl

the left Gaussian error of the observable

Definition at line 194 of file Observable.h.

    {
        this->errgl = errgl;
    }

setErrgr()

void Observable::setErrgr ( double  errgr )

inline

A set method to fix the right Gaussian error of the observable.

Parameters

[in]

errgr

the right Gaussian error of the observable

Definition at line 203 of file Observable.h.

    {
        this->errgr = errgr;
    }

setFilename()

void Observable::setFilename ( std::string  filename_i )

inline

Definition at line 217 of file Observable.h.

    {
        filename = filename_i;
    }

setHasInverseCovariance()

void Observable::setHasInverseCovariance ( bool  hasInverseCovariance )

inline

A set method to state that the Observable is a part of ObservablesWithInverseCovariance.

Parameters

[in]

hasInverseCovariance

a boolean which is true for ObservablesWithInverseCovariance

Definition at line 464 of file Observable.h.

    {
        this->hasInverseCovariance = hasInverseCovariance;
    }

setHistoname()

void Observable::setHistoname ( std::string  histoname_i )

inline

A set method to set the name of the histogram containing the likelihood.

Parameters

[in]

histoname_i

a string that contains the name of the histogram

Definition at line 260 of file Observable.h.

    {
        histoname = histoname_i;
    }

setLabel()

void Observable::setLabel ( std::string  label )

inline

A set method to fix the label for the observable.

Parameters

[in]

label

the label for the observable

Definition at line 278 of file Observable.h.

    {
        this->label = label;
    }

setLikelihoodFromHisto()

void Observable::setLikelihoodFromHisto ( std::string  filename, std::string  histoname  )

virtual

A set method to set the likelihood from which the experimental likelihood of the observable will be read.

Parameters

filename	the name of the file
histoname	the name of the histogram

Reimplemented in Observable2D.

Definition at line 111 of file Observable.cpp.

    {
        this->filename = filename;
        this->histoname = histoname;
        TFile *lik = new TFile((filename + ".root").c_str(), "read");
        TH1D *htmp = (TH1D*) (lik->Get(histoname.c_str()));
        if (htmp == NULL)
            throw std::runtime_error("ERROR: nonexistent histogram called "
                    + histoname + " in "
                    + filename + ".root");
        inhisto = (TH1D *) htmp->Clone((filename + "/" + histoname).c_str());
        inhisto->SetDirectory(gROOT);
        setMin(inhisto->GetXaxis()->GetXmin());
        setMax(inhisto->GetXaxis()->GetXmax());
        lik->Close();
        delete lik;
    }

setMax()

void Observable::setMax ( double  max )

inline

A set method to fix the maximum value for the observable.

Parameters

[in]

max

the maximum value for the observable

Definition at line 296 of file Observable.h.

    {
        this->max = max;
    }

setMin()

void Observable::setMin ( double  min )

inline

A set method to fix the minimum value for the observable.

Parameters

[in]

min

the minimum value for the observable

Definition at line 314 of file Observable.h.

    {
        this->min = min;
    }

setName()

void Observable::setName ( std::string  name )

inline

A set method to fix the name for the observable.

Parameters

name	for the observable

Definition at line 332 of file Observable.h.

    {
        this->name = name;
    }

setObsType()

void Observable::setObsType ( std::string &  obsType_s )

inline

A set method to set the Observable type.

Parameters

[in]

obsType_s

a string that contains the parameter name

Definition at line 395 of file Observable.h.

    {
        obsType = obsType_s;
    }

setParametricLikelihood() [1/2]

virtual void Observable::setParametricLikelihood ( std::string  filename )

inlinevirtual

A set method to set a parametric likelihood reading parameters from a file.

Parameters

filename

the name of the file

Definition at line 234 of file Observable.h.

    {
        this->filename=filename; //real implementation will be done in extension
    }

setParametricLikelihood() [2/2]

virtual void Observable::setParametricLikelihood ( std::string  filename, std::vector< ThObservable * >  thObsV  )

inlinevirtual

Set the parametric likelihood to be overloaded by HiggsObservable.

Parameters

filename	the name of the config file
thObsV	a vector of ThObservables

Reimplemented in HiggsObservable.

Definition at line 244 of file Observable.h.

    {};

setThname()

void Observable::setThname ( std::string  thname )

inline

A set method to fix the name of the observable as listed in ThFactory class.

Parameters

[in]

thname

the name of the observable as listed in ThFactory class

Definition at line 377 of file Observable.h.

    {
        this->thname = thname;
    }

setTho() [1/2]

void Observable::setTho ( ThObservable *  tho_i )

inline

A set method to fix the pointer to object of type ThObservable.

Parameters

[in]

tho_i

pointer to the object of type ThObservable

Definition at line 413 of file Observable.h.

    {
        tho = tho_i;
        tho->setBinMin(bin_min);
        tho->setBinMax(bin_max);
    }

setTho() [2/2]

void Observable::setTho ( ThObservable *  tho_i, double  bmin, double  bmax  )

inline

A set method to fix the pointer to object of type ThObservable.

Parameters

[in]	tho_i	pointer to the object of type ThObservable
[in]	bmin	the lower limit of the bind
[in]	bmax	the upper limit of the bin

Definition at line 426 of file Observable.h.

    {
        tho = tho_i;
        tho->setBinMin(bmin);
        tho->setBinMax(bmax);
    }

setTMCMC()

void Observable::setTMCMC ( bool  tMCMC )

inline

A set method to fix the observable's inclusion in the MCMC listing.

Parameters

[in]

tMCMC

true or false

Definition at line 359 of file Observable.h.

    {
        this->tMCMC = tMCMC;
    }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  output, const Observable &  o  )

friend

Befriending of the std::ostream operator << to generate an output stream for printing the observables details.

Parameters

[out]	output	the formatted output stream to print the model parameters
[in]	o	a reference to an object of type Observable()

Definition at line 102 of file Observable.cpp.

{
    output << "Observable name, tMCMC, min, max, distribution, distribution parameters" << std::endl;
    output << o.name << " " << o.tMCMC << " " << o.min << " " << o.max << " " 
           << o.distr << " " << o.filename << " " << o.histoname << " " << o.ave 
           << " " << o.errg << " " << o.errf << std::endl;
    return output;
}

Member Data Documentation

ave

double Observable::ave

protected

The average value of the observable.

Definition at line 485 of file Observable.h.

bin_max

double Observable::bin_max

protected

The maximum valus of the observable bin.

Definition at line 497 of file Observable.h.

bin_min

double Observable::bin_min

protected

The minimum value of the observable bin.

Definition at line 496 of file Observable.h.

distr

std::string Observable::distr

protected

The name of the distribution of the the observable.

Definition at line 482 of file Observable.h.

errf

double Observable::errf

protected

The flat error of the observable.

Definition at line 487 of file Observable.h.

errg

double Observable::errg

protected

The gaussian error of the observable.

Definition at line 486 of file Observable.h.

errgl

double Observable::errgl

protected

The lower gaussian error of the observable.

Definition at line 488 of file Observable.h.

errgr

double Observable::errgr

protected

The upper gaussian error of the observable.

Definition at line 489 of file Observable.h.

filename

std::string Observable::filename

protected

The name of the file containing the experimental likelihood for the observable.

Definition at line 483 of file Observable.h.

hasInverseCovariance

bool Observable::hasInverseCovariance

protected

Definition at line 500 of file Observable.h.

histoname

std::string Observable::histoname

protected

The name of the histogram for the observable.

Definition at line 484 of file Observable.h.

inhisto

TH1D* Observable::inhisto

protected

1D Histogram containing the experimental likelihood for the observable

Definition at line 494 of file Observable.h.

iterationNo

int Observable::iterationNo

protected

A counter for the interation that helps with the observable caching.

Definition at line 498 of file Observable.h.

label

std::string Observable::label

protected

A label for the observable.

Definition at line 481 of file Observable.h.

max

double Observable::max

protected

The maximum valus of the observable.

Definition at line 491 of file Observable.h.

min

double Observable::min

protected

The minimum value of the observable.

Definition at line 490 of file Observable.h.

name

std::string Observable::name

protected

A name for the observable.

Definition at line 479 of file Observable.h.

obsType

std::string Observable::obsType

protected

Type of the Observable. 0: Observable, 1: HiggsObservable, 2: BinnedObservable, 3: FunctionObservable.

Definition at line 495 of file Observable.h.

thname

std::string Observable::thname

protected

The name for the observable as fixed in the ThObservable class.

Definition at line 480 of file Observable.h.

tho

ThObservable* Observable::tho

protected

A pointer of to the object of the ThObservables class.

Definition at line 478 of file Observable.h.

thValue

double Observable::thValue

protected

The theory value of the first observable.

Definition at line 499 of file Observable.h.

tMCMC

bool Observable::tMCMC

protected

The flag to include or exclude the observable from the MCMC run.

Definition at line 492 of file Observable.h.

writeChain

bool Observable::writeChain

protected

The flag to write the chain for the observable from the MCMC run.

Definition at line 493 of file Observable.h.

---

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

• Observable.h
• Observable.cpp