PValue Class Reference

Basic class for calculating P values. More...

#include <XeStat.h>

Inheritance diagram for PValue:

List of all members.

Public Member Functions
virtual void	estimateCrossSection ()
	virtual method: estimate the cross section (actually for P.L.
virtual double	eventsLowerLimit ()
	Return lower limit of number of events in the fit.
virtual double	eventsUpperLimit ()
	Return upper limit of number of events in the fit.
virtual void	exclusionComputed ()
	retrieve parameters at end of exclusion finder, and print them if needed
virtual int	forceCLs ()
	Virtual method saying is CLs can be used.
virtual double	getSigmaHat ()
	Virtual method returning current estimated sigma.
bool	initialize ()
	Checks (once) that all is iniatlized ok.
void	initializeIt (int mode=NO_ANALYSIS)
	Intitialize at instantiation.
bool	isAnalysisModeOK ()
	Check that the mode is compatible with the current PL or Cut Based anaylsis.
bool	isInError ()
	Is there an error ?
bool	isInitializedOK ()
	Is all initialized ok?
virtual double	nSignalPerCm2 ()=0
	Typical number of expected signal events per cm2 of cross sections.
virtual void	printFlagsAndParameters ()=0
	print All flags and parameters
	PValue (string name, int analMode=NO_ANALYSIS)
	Regular constructor.
	PValue ()
	void constructor for ROOT
double	pValueB ()
	Commpute p-value for the background.
virtual double	pValueS (double sigma)=0
	compute p-value for a given cross section
virtual double	qExclusion (double sigma)
	Virtual method returning exclusion q value for a tested sigma.
virtual void	setEventsLowerLimit (double l)
	Set lower limit of number of events in the fit.
virtual void	setEventsUpperLimit (double l)
	Set upper limit of number of events in the fit.
void	setSigmaUnit (double scale)
virtual void	setWimpMass (double mass)
	Virutal method: pass the wimp mass.
virtual bool	simulate (double sigma=0.)
	Simulate an outcome.
virtual bool	update ()=0
	update after a change in conditions (mainly sigma test)
virtual void	updateSigmaUnit ()
	Virtual method: update cross section, in cm^2, corresponding to 1 event.
Protected Member Functions
virtual bool	checkPValue ()=0
	check that pValue is OK
Protected Attributes
bool	inError
bool	initializedOK
double	lowerLimit
int	requestedAnalysisMode
double	sigmaUnit
double	upperLimit

---

Detailed Description

Basic class for calculating P values.

This is a virtual class. In this class, cross sections are the real ones (1E-45 or so); No scaling is performed.

---

Constructor & Destructor Documentation

PValue::PValue	(	string	name,
		int	analMode = NO_ANALYSIS
	)

Regular constructor.

Parameters:

	name	name of the p-value calculator
	analMode	either PL_ANALYSIS,CUTS_ANALYSIS,NO_ANALYSIS

---

Member Function Documentation

virtual void PValue::estimateCrossSection

(

)

[virtual]

virtual method: estimate the cross section (actually for P.L.

)

Reimplemented in ProfileLikelihood.

virtual int PValue::forceCLs

(

)

[virtual]

Virtual method saying is CLs can be used.

Returns:

DO_NOT_FORCE, FORCE_TRUE or FORCE_FALSE

Reimplemented in YellinPValue.

virtual double PValue::getSigmaHat

(

)

[virtual]

Virtual method returning current estimated sigma.

Returns:

current value of estimated sigma

Reimplemented in PVcountingSB, and ProfileLikelihood.

void PValue::initializeIt

(

int

mode = NO_ANALYSIS

)

Intitialize at instantiation.

Method used as a workaround to diamond hierarchy problems

Parameters:

mode

either NO_ANALYSIS, CUTS_ANALYSIS or PL_ANALYSIS

virtual double PValue::pValueS

(

double

sigma

)

[pure virtual]

compute p-value for a given cross section

Returns:

p-value for a given cross section

Parameters:

sigma

true value of the cross section

Implemented in S1S2CLs, PVcountingSB, YellinPValue, and ProfileLikelihood.

virtual double PValue::qExclusion

(

double

sigma

)

[virtual]

Virtual method returning exclusion q value for a tested sigma.

Returns:

q(sigma)

Parameters:

sigma

cross sections being testes

Reimplemented in ProfileLikelihood.

void PValue::setSigmaUnit

(

double

scale

)

Parameters:

scale

sigma unit to be passed to Minuit

virtual bool PValue::simulate

(

double

sigma = 0.

)

[virtual]

Simulate an outcome.

Parameters:

sigma

cross section simulated

Reimplemented in S1S2PL.

virtual bool PValue::update

(

)

[pure virtual]

update after a change in conditions (mainly sigma test)

Returns:

bool was update OK ?

Implemented in S1S2CLs, S1S2PL, PVcountingSB, YellinPValue, CombinedProfileLikelihood, and PLcountingSB.

---

Member Data Documentation

bool PValue::inError [protected]

Has an error been detected?

bool PValue::initializedOK [protected]

Is all ok?

double PValue::lowerLimit [protected]

Lower number of events in fit

int PValue::requestedAnalysisMode [protected]

Requested mode (PL or cuts)

double PValue::sigmaUnit [protected]

Sigma corresponding to 1 events

double PValue::upperLimit [protected]

Upper number of events in fit

---

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

• /home/lellouch/Dropbox/Xenon/Xephyr/XeStat.h