LKParameter Class Reference

#include <XeStat.h>

Inheritance diagram for LKParameter:

Public Member Functions
	LKParameter (TString name)
	LKParameter (int id, int type, TString nam, double initial, double step, double min, double max)
void	printInitial ()
virtual void	printCurrent (bool withErrors)
void	setId (int id)
void	setType (int typ)
void	setInitialValue (double i)
virtual void	setCurrentValue (double c)
void	setCurrentValueInMinuitUnits (double c)
void	setT0value (double val)
double	getT0value ()
void	setMinuitUnit (double s=1.)
void	setStep (double st)
virtual void	setSigma (double sig)
void	setSigmaInMinuitUnits (double sig)
void	setMinimum (double mi)
void	setMaximum (double max)
int	getType ()
int	getId ()
double	getCurrentValue ()
double	getCurrentValueInMinuitUnits ()
double	getInitialValue ()
double	getInitialValueInMinuitUnits ()
double	getMaximum ()
double	getMaximumInMinuitUnits ()
double	getMinimum ()
double	getMinimumInMinuitUnits ()
double	getStep ()
double	getStepInMinuitUnits ()
double	getSigma ()
TString	getTypeName ()
double	getInitialSigma ()
double	getLLGausConstraint ()
void	setCommon (bool c=true)
bool	isActive ()
bool	isOfInterest ()
bool	isCommon ()
void	freeze (bool doFreeze)
bool	compares (LKParameter *par, bool print)
void	printHeader ()
bool	inCombinedMode ()
void	initialize ()
void	setCombinedMode (bool mode=true)
Public Member Functions inherited from XeStat
	XeStat (TString name)
void	setName (TString nam="No_Name")
	helper method to set the name of this instance.
TString	getName ()
	helper method to return the name of this instance.
void	setExperiment (int exp)
	set the experiment number, usefull for combination
int	getExperiment ()
	set the experiment number, usefull for combination
Public Member Functions inherited from errorHandler
	errorHandler (TString name)
void	Error (TString functionName, TString message)
	Send an Error message to the user. More...
void	Warning (TString functionName, TString message)
	Send a Warning message to the user. More...
void	Info (TString functionName, TString message)
	Send an Info message to the user. More...
void	Debug (TString functionName, TString message)
	Send a Debug message to the user. More...
void	setPrintLevel (int level)
	Set the local printing level (for this instance only) More...
int	getPrintLevel ()
	Return the current print level for this instance. remind that if you set with setPrintLevel this will override the global print level.
Public Member Functions inherited from printTools
	printTools ()
	---------— Print Toools -----------— ///

Static Public Member Functions
static TString	getTypeName (int type)
Static Public Member Functions inherited from XeStat
static void	setAnalysisMode (int mode)
static int	getAnalysisMode ()
static bool	checkAnalysisMode (TString name, int requested)
static bool	isAnalysisDefined (bool verbose=false)
static bool	isCutsBased ()
static bool	isPL ()
static int	getSigmaLinLog (int unit)
static TString	getAnalysisModeName ()
static TString	getAnalysisModeName (int mode)
static TString	getSystematicModeName (int syst)
static TString	getSigmaUnitName (int unit)
static TString	getSigmaLabel (int unit)
static TString	getSigmaModeName (int mode)
static TString	getUpperSigmaLabel (int unit)
Static Public Member Functions inherited from printTools
static TString	upperCase (TString s)
static TString	lowerCase (TString s)
static TString	trim (TString s)
static TString	justify (TString s, int w, bool left, bool trim)
static TString	rightJustify (TString s, int w, bool trim=false)
static TString	leftJustify (TString s, int w, bool trim=false)
static TString	format0I (int v, int w=1)
static TString	formatLI (int v, int w=1, int p=1)
static TString	formatRI (int v, int w=1, int p=1)
static TString	formatF (double v, int w=1, int p=1)
static TString	formatR (double v, int w=1, int p=1)
static TString	formatLF (double v, int w=1, int p=1)
static TString	formatRF (double v, int w=1, int p=1)
static TString	formatG (double v, int w=1, int p=1)
static TString	formatLG (double v, int w=1, int p=1)
static TString	formatRG (double v, int w=1, int p=1)
static TString	formatI (int v, int w=1, int trailer=0)
static TString	doOrDont (bool b)

Protected Attributes
double	t0
int	type
int	id
bool	common
bool	combinedMode
double	initialValue
double	step
double	minimum
double	maximum
double	currentValue
double	sigma
double	initialSigma
double	MinuitUnit
Protected Attributes inherited from XeStat
TString	name
int	experiment

Additional Inherited Members
Public Attributes inherited from errorHandler
int	localPrintLevel
TString	className
Static Public Attributes inherited from errorHandler
static int	globalPrintLevel = 1
Static Protected Attributes inherited from XeStat
static int	analysisMode = NO_ANALYSIS

Detailed Description

Description of a likelihood parameter. It is evaluated by the Likelihood class

Constructor & Destructor Documentation

LKParameter() [1/2]

LKParameter::LKParameter

(

TString

name

)

Empry constructor for ROOT

LKParameter() [2/2]

LKParameter::LKParameter	(	int	id,
		int	type,
		TString	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

freeze()

void LKParameter::freeze

(

bool

doFreeze

)

freeze the parameter in profile likelihood double tag computation

Parameters

doFreeze

Freeze is or not?

setCommon()

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

setT0value()

void LKParameter::setT0value ( double  val )

inline

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 files:

• SOURCE/src/XeStat.h
• SOURCE/src/XeStat.cxx