Class to calculate the CL upper limit using the Feldman-Cousins method as described in PRD V57 #7, p3873-3889.

The default confidence interval calculated using this method is 90% This is set either by having a default the constructor, or using the appropriate fraction when instantiating an object of this class (e.g. 0.9)

The simple extension to a gaussian resolution function bounded at zero has not been addressed as yet -> `time is of the essence' as they write on the wall of the maze in that classic game ...

VARIABLES THAT CAN BE ALTERED

=> depending on your desired precision: The initial values of fMuMin, fMuMax, fMuStep and fNMax are those used in the PRD:

fMuMin = 0.0
fMuMax = 50.0
fMuStep= 0.005

but there is total flexibility in changing this should you desire.

see example of use in $ROOTSYS/tutorials/math/FeldmanCousins.C

see note about: "Should I use TRolke, TFeldmanCousins, TLimit?" in the TRolke class description.

Author: : Adrian Bevan, Liverpool University

Copyright Liverpool University 2001 bevan.nosp@m.@sla.nosp@m.c.sta.nosp@m.nfor.nosp@m.d.edu

Definition at line 47 of file TFeldmanCousins.h.

Public Member Functions
	TFeldmanCousins (Double_t newCL=0.9, TString options="")
	Constructor. More...

virtual	~TFeldmanCousins ()

Double_t	CalculateLowerLimit (Double_t Nobserved, Double_t Nbackground)
	given Nobserved and Nbackground, try different values of mu that give lower limits that are consistent with Nobserved. More...

Double_t	CalculateUpperLimit (Double_t Nobserved, Double_t Nbackground)
	given Nobserved and Nbackground, try different values of mu that give upper limits that are consistent with Nobserved. More...

Double_t	GetCL (void) const

Double_t	GetLowerLimit (void) const

Double_t	GetMuMax (void) const

Double_t	GetMuMin (void) const

Double_t	GetMuStep (void) const

Double_t	GetNbackground (void) const

Double_t	GetNMax (void) const

Double_t	GetNobserved (void) const

Double_t	GetUpperLimit (void) const

void	SetCL (Double_t newCL)

void	SetMuMax (Double_t newMax=50.0)
	Set maximum value of signal to use in calculating the tables. More...

void	SetMuMin (Double_t newMin=0.0)

void	SetMuStep (Double_t newMuStep=0.005)
	Set the step in signal to use when generating tables. More...

void	SetNbackground (Double_t Nbg)

void	SetNobserved (Double_t NObs)

Protected Member Functions
Int_t	FindLimitsFromTable (Double_t mu)
	calculate the probability table for a given mu for n = 0, NMAX and return 1 if the number of observed events is consistent with the CL bad More...

Double_t	Prob (Int_t N, Double_t mu, Double_t B)
	Calculate the poissonian probability for a mean of mu+B events with a variance of N. More...

Protected Attributes
Double_t	fCL

Double_t	fLowerLimit

Double_t	fMuMax

Double_t	fMuMin

Double_t	fMuStep

Double_t	fNbackground

Int_t	fNMax

Int_t	fNMuStep

Double_t	fNobserved

Int_t	fQUICK

Double_t	fUpperLimit

#include <TFeldmanCousins.h>

Inheritance diagram for TFeldmanCousins:

[legend]

Constructor & Destructor Documentation

◆ TFeldmanCousins()

TFeldmanCousins::TFeldmanCousins	(	Double_t	newCL = `0.9`,
		TString	options = `""`
	)

Constructor.

Definition at line 57 of file TFeldmanCousins.cxx.

◆ ~TFeldmanCousins()

TFeldmanCousins::~TFeldmanCousins ( )

virtual

Definition at line 79 of file TFeldmanCousins.cxx.

Member Function Documentation

◆ CalculateLowerLimit()

Double_t TFeldmanCousins::CalculateLowerLimit	(	Double_t	Nobserved,
		Double_t	Nbackground
	)

given Nobserved and Nbackground, try different values of mu that give lower limits that are consistent with Nobserved.

The closed interval (plus any stragglers) corresponds to the F&C interval

Definition at line 88 of file TFeldmanCousins.cxx.

◆ CalculateUpperLimit()

Double_t TFeldmanCousins::CalculateUpperLimit	(	Double_t	Nobserved,
		Double_t	Nbackground
	)

given Nobserved and Nbackground, try different values of mu that give upper limits that are consistent with Nobserved.

The closed interval (plus any stragglers) corresponds to the F&C interval

Definition at line 100 of file TFeldmanCousins.cxx.

◆ FindLimitsFromTable()

Int_t TFeldmanCousins::FindLimitsFromTable ( Double_t mu )

protected

calculate the probability table for a given mu for n = 0, NMAX and return 1 if the number of observed events is consistent with the CL bad

Definition at line 155 of file TFeldmanCousins.cxx.

◆ GetCL()

Double_t TFeldmanCousins::GetCL ( void ) const

inline

Definition at line 93 of file TFeldmanCousins.h.

◆ GetLowerLimit()

Double_t TFeldmanCousins::GetLowerLimit ( void ) const

inline

Definition at line 90 of file TFeldmanCousins.h.

◆ GetMuMax()

Double_t TFeldmanCousins::GetMuMax ( void ) const

inline

Definition at line 96 of file TFeldmanCousins.h.

◆ GetMuMin()

Double_t TFeldmanCousins::GetMuMin ( void ) const

inline

Definition at line 95 of file TFeldmanCousins.h.

◆ GetMuStep()

Double_t TFeldmanCousins::GetMuStep ( void ) const

inline

Definition at line 97 of file TFeldmanCousins.h.

◆ GetNbackground()

Double_t TFeldmanCousins::GetNbackground ( void ) const

inline

Definition at line 92 of file TFeldmanCousins.h.

◆ GetNMax()

Double_t TFeldmanCousins::GetNMax ( void ) const

inline

Definition at line 98 of file TFeldmanCousins.h.

◆ GetNobserved()

Double_t TFeldmanCousins::GetNobserved ( void ) const

inline

Definition at line 91 of file TFeldmanCousins.h.

◆ GetUpperLimit()

Double_t TFeldmanCousins::GetUpperLimit ( void ) const

inline

Definition at line 89 of file TFeldmanCousins.h.

◆ Prob()

Double_t TFeldmanCousins::Prob	(	Int_t	N,
		Double_t	mu,
		Double_t	B
	)

protected

Calculate the poissonian probability for a mean of mu+B events with a variance of N.

Definition at line 201 of file TFeldmanCousins.cxx.

◆ SetCL()

void TFeldmanCousins::SetCL ( Double_t newCL )

inline

Definition at line 102 of file TFeldmanCousins.h.

◆ SetMuMax()

void TFeldmanCousins::SetMuMax ( Double_t newMax = 50.0 )

Set maximum value of signal to use in calculating the tables.

Definition at line 209 of file TFeldmanCousins.cxx.

◆ SetMuMin()

void TFeldmanCousins::SetMuMin ( Double_t newMin = 0.0 )

inline

Definition at line 104 of file TFeldmanCousins.h.

◆ SetMuStep()

void TFeldmanCousins::SetMuStep ( Double_t newMuStep = 0.005 )

Set the step in signal to use when generating tables.

Definition at line 219 of file TFeldmanCousins.cxx.

◆ SetNbackground()

void TFeldmanCousins::SetNbackground ( Double_t Nbg )

inline

Definition at line 101 of file TFeldmanCousins.h.

◆ SetNobserved()

void TFeldmanCousins::SetNobserved ( Double_t NObs )

inline

Definition at line 100 of file TFeldmanCousins.h.

Member Data Documentation

◆ fCL

Double_t TFeldmanCousins::fCL

protected

Definition at line 49 of file TFeldmanCousins.h.

◆ fLowerLimit

Double_t TFeldmanCousins::fLowerLimit

protected

Definition at line 51 of file TFeldmanCousins.h.

◆ fMuMax

Double_t TFeldmanCousins::fMuMax

protected

Definition at line 55 of file TFeldmanCousins.h.

◆ fMuMin

Double_t TFeldmanCousins::fMuMin

protected

Definition at line 54 of file TFeldmanCousins.h.

◆ fMuStep

Double_t TFeldmanCousins::fMuStep

protected

Definition at line 56 of file TFeldmanCousins.h.

◆ fNbackground

Double_t TFeldmanCousins::fNbackground

protected

Definition at line 53 of file TFeldmanCousins.h.

◆ fNMax

Int_t TFeldmanCousins::fNMax

protected

Definition at line 58 of file TFeldmanCousins.h.

◆ fNMuStep

Int_t TFeldmanCousins::fNMuStep

protected

Definition at line 57 of file TFeldmanCousins.h.

◆ fNobserved

Double_t TFeldmanCousins::fNobserved

protected

Definition at line 52 of file TFeldmanCousins.h.

◆ fQUICK

Int_t TFeldmanCousins::fQUICK

protected

Definition at line 59 of file TFeldmanCousins.h.

◆ fUpperLimit

Double_t TFeldmanCousins::fUpperLimit

protected

Definition at line 50 of file TFeldmanCousins.h.

Libraries for TFeldmanCousins:

[legend]

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

math/physics/inc/TFeldmanCousins.h
math/physics/src/TFeldmanCousins.cxx

VARIABLES THAT CAN BE ALTERED

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ TFeldmanCousins()

◆ ~TFeldmanCousins()

Member Function Documentation

◆ CalculateLowerLimit()

◆ CalculateUpperLimit()

◆ FindLimitsFromTable()

◆ GetCL()

◆ GetLowerLimit()

◆ GetMuMax()

◆ GetMuMin()

◆ GetMuStep()

◆ GetNbackground()

◆ GetNMax()

◆ GetNobserved()

◆ GetUpperLimit()

◆ Prob()

◆ SetCL()

◆ SetMuMax()

◆ SetMuMin()

◆ SetMuStep()

◆ SetNbackground()

◆ SetNobserved()

Member Data Documentation

◆ fCL

◆ fLowerLimit

◆ fMuMax

◆ fMuMin

◆ fMuStep

◆ fNbackground

◆ fNMax

◆ fNMuStep

◆ fNobserved

◆ fQUICK

◆ fUpperLimit