LKParameter Class Reference

Description of a likelihood parameter. More...

#include <XeStat.h>

Inheritance diagram for LKParameter:
XeCombinable XeStat XeMath XeObject XeCore XeCore SigmaParameter TEfficiencyParameter TLEffParameter TStatBkgParameter TSystBkgParameter

List of all members.

Public Member Functions

bool compares (LKParameter *par, bool print)
void freeze (bool doFreeze)
 freeze the parameter in profile likelihood double tag computation
double getCurrentValue ()
double getCurrentValueInMinuitUnits ()
int getId ()
double getInitialValue ()
double getInitialValueInMinuitUnits ()
double getMaximum ()
double getMaximumInMinuitUnits ()
double getMinimum ()
double getMinimumInMinuitUnits ()
double getSigma ()
double getStep ()
double getStepInMinuitUnits ()
int getType ()
string getTypeName ()
bool inCombinedMode ()
void initialize ()
bool isActive ()
bool isCommon ()
bool isOfInterest ()
 LKParameter (int id, int type, string nam, double initial, double step, double min, double max)
 Regular Constructor.
 LKParameter ()
 Empry constructor for ROOT.
void printCurrent (bool withErrors)
void printExperiment ()
void printInitial ()
void setCombinedMode (bool mode=true)
void setCommon (bool c=true)
 Set the fact that this parameter is or isn't common to various likelihoods calculators.
void setCurrentValue (double c)
void setCurrentValueInMinuitUnits (double c)
void setInitialValue (double i)
void setMaximum (double max)
void setMinimum (double mi)
void setMinuitUnit (double s=1.)
 set the unit so that Minuit deals with parameters of order of mag 1
void setSigma (double sig)
void setSigmaInMinuitUnits (double sig)
void setStep (double st)
void setType (int typ)

Static Public Member Functions

static string getTypeName (int type)

Protected Attributes

bool combinedMode
bool common
double currentValue
int id
double initialValue
double maximum
double minimum
double MinuitUnit
double sigma
double step
int type

Detailed Description

Description of a likelihood parameter.

It is evaluated by the Likelihood class


Constructor & Destructor Documentation

LKParameter::LKParameter ( int  id,
int  type,
string  nam,
double  initial,
double  step,
double  min,
double  max 
)

Regular Constructor.

Parameters:
id Its identifier
type Can be PARAMETER_OF_INTEREST , NUISANCE_PARAMETER , FIXED_PARAMETER , FROZEN_PARAMETER. FROZEN means temporary fixed
nam name
initial initial value
step step for minimization
min minimum value
max maximum value

Member Function Documentation

void LKParameter::freeze ( bool  doFreeze  ) 

freeze the parameter in profile likelihood double tag computation

Parameters:
doFreeze Freeze is or not?
void LKParameter::setCommon ( bool  c = true  ) 

Set the fact that this parameter is or isn't common to various likelihoods calculators.

Parameters:
c Is it common
void LKParameter::setMinuitUnit ( double  s = 1.  ) 

set the unit so that Minuit deals with parameters of order of mag 1

Parameters:
s typical unit

The documentation for this class was generated from the following file:
 All Classes Functions Variables

Generated on 10 Apr 2015 for Xephyr by  doxygen 1.6.1