OneSidedFrequentistUpperLimitWithBands
This is a standard demo that can be used with any ROOT file prepared in the standard way. You specify:
- name for input ROOT file
- name of workspace inside ROOT file that holds model and data
- name of ModelConfig that specifies details for calculator tools
- name of dataset
With default parameters the macro will attempt to run the standard hist2workspace example and read the ROOT file that it produces.
The first ~100 lines define a new test statistic, then the main macro starts. You may want to control:
double confidenceLevel=0.95;
int nPointsToScan = 12;
int nToyMC = 150;
This uses a modified version of the profile likelihood ratio as a test statistic for upper limits (eg. test stat = 0 if muhat>mu).
Based on the observed data, one defines a set of parameter points to be tested based on the value of the parameter of interest and the conditional MLE (eg. profiled) values of the nuisance parameters.
At each parameter point, pseudo-experiments are generated using this fixed reference model and then the test statistic is evaluated. Note, the nuisance parameters are floating in the fits. For each point, the threshold that defines the 95% acceptance region is found. This forms a "Confidence Belt".
After constructing the confidence belt, one can find the confidence interval for any particular dataset by finding the intersection of the observed test statistic and the confidence belt. First this is done on the observed data to get an observed 1-sided upper limt.
Finally, there expected limit and bands (from background-only) are formed by generating background-only data and finding the upper limit. This is done by hand for now, will later be part of the RooStats tools.
On a technical note, this technique is NOT the Feldman-Cousins technique, because that is a 2-sided interval BY DEFINITION. However, like the Feldman-Cousins technique this is a Neyman-Construction. For technical reasons the easiest way to implement this right now is to use the FeldmanCousins tool and then change the test statistic that it is using.
Building the confidence belt can be computationally expensive. Once it is built, one could save it to a file and use it in a separate step.
We can use PROOF to speed things along in parallel, however, the test statistic has to be installed on the workers so either turn off PROOF or include the modified test statistic in your $ROOTSYS/roofit/roostats/inc
directory, add the additional line to the LinkDef.h file, and recompile root.
Note, if you have a boundary on the parameter of interest (eg. cross-section) the threshold on the one-sided test statistic starts off very small because we are only including downward fluctuations. You can see the threshold in these printouts:
NeymanConstruction: Prog: 12/50
total MC = 39
this test stat = 0
SigXsecOverSM=0.69 alpha_syst1=0.136515 alpha_syst3=0.425415 beta_syst2=1.08496 [-1
e+30, 0.011215] in interval = 1
static unsigned int total
this tells you the values of the parameters being used to generate the pseudo-experiments and the threshold in this case is 0.011215. One would expect for 95% that the threshold would be ~1.35 once the cross-section is far enough away from 0 that it is essentially unaffected by the boundary. As one reaches the last points in the scan, the theshold starts to get artificially high. This is because the range of the parameter in the fit is the same as the range in the scan. In the future, these should be independently controlled, but they are not now. As a result the ~50% of pseudo-experiments that have an upward fluctuation end up with muhat = muMax. Because of this, the upper range of the parameter should be well above the expected upper limit... but not too high or one will need a very large value of nPointsToScan to resolve the relevant region. This can be improved, but this is the first version of this script.
Important note: when the model includes external constraint terms, like a Gaussian constraint to a nuisance parameter centered around some nominal value there is a subtlety. The asymptotic results are all based on the assumption that all the measurements fluctuate... including the nominal values from auxiliary measurements. If these do not fluctuate, this corresponds to an "conditional ensemble". The result is that the distribution of the test statistic can become very non-chi^2. This results in thresholds that become very large. This can be seen in the following thought experiment. Say the model is \( Pois(N | s + b)G(b0|b,sigma) \) where \( G(b0|b,sigma) \) is the external constraint and b0 is 100. If N is also 100 then the profiled value of b given s is going to be some trade off between 100-s and b0. If sigma is \( \sqrt(N) \), then the profiled value of b is probably 100 - s/2 So for s=60 we are going to have a profiled value of b~70. Now when we generate pseudo-experiments for s=60, b=70 we will have N~130 and the average shat will be 30, not 60. In practice, this is only an issue for values of s that are very excluded. For values of s near the 95% limit this should not be a big effect. This can be avoided if the nominal values of the constraints also fluctuate, but that requires that those parameters are RooRealVars in the model. This version does not deal with this issue, but it will be addressed in a future version.
␛[1mRooFit v3.60 -- Developed by Wouter Verkerke and David Kirkby␛[0m
Copyright (C) 2000-2013 NIKHEF, University of California & Stanford University
All rights reserved, please read http://roofit.sourceforge.net/license.txt
FeldmanCousins: ntoys per point = 499
FeldmanCousins: nEvents per toy will fluctuate about expectation
will use global observables for unconditional ensemble
RooArgSet:: = (nom_alpha_syst2,nom_alpha_syst3,nom_gamma_stat_channel1_bin_0,nom_gamma_stat_channel1_bin_1)
=== Using the following for ModelConfig ===
Observables: RooArgSet:: = (obs_x_channel1,weightVar,channelCat)
Parameters of Interest: RooArgSet:: = (SigXsecOverSM)
Nuisance Parameters: RooArgSet:: = (alpha_syst2,alpha_syst3,gamma_stat_channel1_bin_0,gamma_stat_channel1_bin_1)
Global Observables: RooArgSet:: = (nom_alpha_syst2,nom_alpha_syst3,nom_gamma_stat_channel1_bin_0,nom_gamma_stat_channel1_bin_1)
PDF: RooSimultaneous::simPdf[ indexCat=channelCat channel1=model_channel1 ] = 0.174888
FeldmanCousins: Model has nuisance parameters, will do profile construction
FeldmanCousins: # points to test = 12
lookup index = 0
NeymanConstruction: Prog: 1/12 total MC = 499 this test stat = 0
SigXsecOverSM=0.125 alpha_syst2=0.620013 alpha_syst3=0.233371 gamma_stat_channel1_bin_0=1.03213 gamma_stat_channel1_bin_1=1.04741 [-1e+30, 0.352289] in interval = 1
NeymanConstruction: Prog: 2/12 total MC = 499 this test stat = 0
SigXsecOverSM=0.375 alpha_syst2=0.447753 alpha_syst3=0.177838 gamma_stat_channel1_bin_0=1.02318 gamma_stat_channel1_bin_1=1.03602 [-1e+30, 0.880615] in interval = 1
NeymanConstruction: Prog: 3/12 total MC = 499 this test stat = 0
SigXsecOverSM=0.625 alpha_syst2=0.286439 alpha_syst3=0.123101 gamma_stat_channel1_bin_0=1.01471 gamma_stat_channel1_bin_1=1.02485 [-1e+30, 1.24865] in interval = 1
NeymanConstruction: Prog: 4/12 total MC = 499 this test stat = 0
SigXsecOverSM=0.875 alpha_syst2=0.135227 alpha_syst3=0.0712312 gamma_stat_channel1_bin_0=1.00681 gamma_stat_channel1_bin_1=1.01342 [-1e+30, 1.67695] in interval = 1
NeymanConstruction: Prog: 5/12 total MC = 499 this test stat = 0.000123982
SigXsecOverSM=1.125 alpha_syst2=-0.0145151 alpha_syst3=0.0140841 gamma_stat_channel1_bin_0=0.999276 gamma_stat_channel1_bin_1=1.00325 [-1e+30, 1.27013] in interval = 1
NeymanConstruction: Prog: 6/12 total MC = 499 this test stat = 0.0914826
SigXsecOverSM=1.375 alpha_syst2=-0.158296 alpha_syst3=-0.0388344 gamma_stat_channel1_bin_0=0.992172 gamma_stat_channel1_bin_1=0.99314 [-1e+30, 1.2931] in interval = 1
NeymanConstruction: Prog: 7/12 total MC = 499 this test stat = 0.348977
SigXsecOverSM=1.625 alpha_syst2=-0.293123 alpha_syst3=-0.0887596 gamma_stat_channel1_bin_0=0.985749 gamma_stat_channel1_bin_1=0.98241 [-1e+30, 1.38422] in interval = 1
NeymanConstruction: Prog: 8/12 total MC = 499 this test stat = 0.767852
SigXsecOverSM=1.875 alpha_syst2=-0.422662 alpha_syst3=-0.140488 gamma_stat_channel1_bin_0=0.979598 gamma_stat_channel1_bin_1=0.972408 [-1e+30, 1.44103] in interval = 1
NeymanConstruction: Prog: 9/12 total MC = 499 this test stat = 1.34349
SigXsecOverSM=2.125 alpha_syst2=-0.544231 alpha_syst3=-0.191113 gamma_stat_channel1_bin_0=0.973832 gamma_stat_channel1_bin_1=0.962561 [-1e+30, 1.18511] in interval = 0
NeymanConstruction: Prog: 10/12 total MC = 499 this test stat = 2.07144
SigXsecOverSM=2.375 alpha_syst2=-0.657507 alpha_syst3=-0.240928 gamma_stat_channel1_bin_0=0.968401 gamma_stat_channel1_bin_1=0.952927 [-1e+30, 1.49941] in interval = 0
NeymanConstruction: Prog: 11/12 total MC = 499 this test stat = 2.94737
SigXsecOverSM=2.625 alpha_syst2=-0.763071 alpha_syst3=-0.290559 gamma_stat_channel1_bin_0=0.963225 gamma_stat_channel1_bin_1=0.943651 [-1e+30, 1.38056] in interval = 0
NeymanConstruction: Prog: 12/12 total MC = 499 this test stat = 3.9668
SigXsecOverSM=2.875 alpha_syst2=-0.861426 alpha_syst3=-0.338746 gamma_stat_channel1_bin_0=0.958365 gamma_stat_channel1_bin_1=0.934518 [-1e+30, 1.33024] in interval = 0
[#1] INFO:Eval -- 8 points in interval
95% interval on SigXsecOverSM is : [0.125, 1.875]
[#1] INFO:Minization -- p.d.f. provides expected number of events, including extended term in likelihood.
[#1] INFO:Minization -- createNLL picked up cached consraints from workspace with 6 entries
[#1] INFO:Minization -- Including the following contraint terms in minimization: (lumiConstraint,alpha_syst1Constraint,alpha_syst2Constraint,alpha_syst3Constraint,gamma_stat_channel1_bin_0_constraint,gamma_stat_channel1_bin_1_constraint)
[#1] INFO:Minization -- RooProfileLL::evaluate(nll_simPdf_obsData_with_constr_Profile[SigXsecOverSM]) Creating instance of MINUIT
[#1] INFO:Fitting -- RooAddition::defaultErrorLevel(nll_simPdf_obsData_with_constr) Summation contains a RooNLLVar, using its error level
[#1] INFO:Minization -- RooProfileLL::evaluate(nll_simPdf_obsData_with_constr_Profile[SigXsecOverSM]) determining minimum likelihood for current configurations w.r.t all observable
RooAbsTestStatistic::initSimMode: creating slave calculator #0 for state channel1 (2 dataset entries)
[#1] INFO:Fitting -- RooAbsTestStatistic::initSimMode: created 1 slave calculators.
[#1] INFO:Minization -- RooProfileLL::evaluate(nll_simPdf_obsData_with_constr_Profile[SigXsecOverSM]) minimum found at (SigXsecOverSM=1.11573)
.
Will use these parameter points to generate pseudo data for bkg only
1) 0x55a61618d940 RooRealVar:: alpha_syst2 = 0.71117 +/- 0.914105 L(-5 - 5) "alpha_syst2"
2) 0x55a617833f80 RooRealVar:: alpha_syst3 = 0.261459 +/- 0.9291 L(-5 - 5) "alpha_syst3"
3) 0x55a617818e50 RooRealVar:: gamma_stat_channel1_bin_0 = 1.03677 +/- 0.0462899 L(0 - 1.25) "gamma_stat_channel1_bin_0"
4) 0x55a61787b1a0 RooRealVar:: gamma_stat_channel1_bin_1 = 1.05319 +/- 0.0761205 L(0 - 1.5) "gamma_stat_channel1_bin_1"
5) 0x55a61786d280 RooRealVar:: SigXsecOverSM = 0 +/- 0 L(0 - 3) B(12) "SigXsecOverSM"
-2 sigma band 6.95252e-310
-1 sigma band 0.345 [Power Constraint)]
median of band 0.855
+1 sigma band 1.605
+2 sigma band 2.085
observed 95% upper-limit 1.875
CLb strict [P(toy>obs|0)] for observed 95% upper-limit 0.946667
CLb inclusive [P(toy>=obs|0)] for observed 95% upper-limit 0.946667
bool useProof = false;
int nworkers = 0;
void OneSidedFrequentistUpperLimitWithBands(const char *infile = "", const char *workspaceName = "combined",
const char *modelConfigName = "ModelConfig",
const char *dataName = "obsData")
{
double confidenceLevel = 0.95;
int nPointsToScan = 12;
int nToyMC = 150;
const char *filename = "";
if (!strcmp(infile, "")) {
filename = "results/example_combined_GaussExample_model.root";
if (!fileExist) {
#ifdef _WIN32
cout << "HistFactory file cannot be generated on Windows - exit" << endl;
return;
#endif
cout << "will run standard hist2workspace example" << endl;
gROOT->ProcessLine(
".! prepareHistFactory .");
gROOT->ProcessLine(
".! hist2workspace config/example.xml");
cout << "\n\n---------------------" << endl;
cout << "Done creating example input" << endl;
cout << "---------------------\n\n" << endl;
}
} else
filename = infile;
cout << "StandardRooStatsDemoMacro: Input file " << filename << " is not found" << endl;
return;
}
if (!w) {
cout << "workspace not found" << endl;
return;
}
ModelConfig *mc = (ModelConfig *)w->
obj(modelConfigName);
if (!data || !mc) {
cout << "data or ModelConfig was not found" << endl;
return;
}
FeldmanCousins
fc(*data, *mc);
fc.SetConfidenceLevel(confidenceLevel);
fc.AdditionalNToysFactor(
0.5);
fc.SetNBins(nPointsToScan);
ToyMCSampler *toymcsampler = (ToyMCSampler *)
fc.GetTestStatSampler();
ProfileLikelihoodTestStat *testStat = dynamic_cast<ProfileLikelihoodTestStat *>(toymcsampler->GetTestStatistic());
testStat->SetOneSided(true);
if (!mc->GetPdf()->canBeExtended()) {
fc.FluctuateNumDataEntries(
false);
else
cout << "Not sure what to do about this model" << endl;
}
if (useProof) {
ProofConfig
pc(*w, nworkers,
"",
false);
toymcsampler->SetProofConfig(&
pc);
}
if (mc->GetGlobalObservables()) {
cout << "will use global observables for unconditional ensemble" << endl;
mc->GetGlobalObservables()->Print();
toymcsampler->SetGlobalObservables(*mc->GetGlobalObservables());
}
PointSetInterval *interval =
fc.GetInterval();
ConfidenceBelt *belt =
fc.GetConfidenceBelt();
cout <<
"\n95% interval on " << firstPOI->
GetName() <<
" is : [" << interval->LowerLimit(*firstPOI) <<
", "
<< interval->UpperLimit(*firstPOI) << "] " << endl;
double observedUL = interval->UpperLimit(*firstPOI);
double obsTSatObsUL =
fc.GetTestStatSampler()->EvaluateTestStatistic(*data, tmpPOI);
double arMax = belt->GetAcceptanceRegionMax(*tmpPoint);
histOfThresholds->
Fill(poiVal, arMax);
}
histOfThresholds->
Draw();
if (mc->GetNuisanceParameters())
poiAndNuisance->
add(*mc->GetNuisanceParameters());
poiAndNuisance->
add(*mc->GetParametersOfInterest());
cout << "\nWill use these parameter points to generate pseudo data for bkg only" << endl;
paramsToGenerateData->
Print(
"v");
unconditionalObs.
add(*mc->GetObservables());
unconditionalObs.
add(*mc->GetGlobalObservables());
double CLb = 0;
double CLbinclusive = 0;
TH1F *histOfUL =
new TH1F(
"histOfUL",
"", 100, 0, firstPOI->
getMax());
for (int imc = 0; imc < nToyMC; ++imc) {
if (!mc->GetPdf()->canBeExtended()) {
toyData = mc->GetPdf()->generate(*mc->GetObservables(), 1);
else
cout << "Not sure what to do about this model" << endl;
} else {
toyData = mc->GetPdf()->generate(*mc->GetObservables(),
Extended());
}
if (!simPdf) {
RooDataSet *one = mc->GetPdf()->generate(*mc->GetGlobalObservables(), 1);
RooArgSet *allVars = mc->GetPdf()->getVariables();
*allVars = *values;
delete allVars;
delete values;
delete one;
} else {
delete globtmp;
delete tmp;
}
}
double toyTSatObsUL =
fc.GetTestStatSampler()->EvaluateTestStatistic(*toyData, tmpPOI);
if (obsTSatObsUL < toyTSatObsUL)
CLb += (1.) / nToyMC;
if (obsTSatObsUL <= toyTSatObsUL)
CLbinclusive += (1.) / nToyMC;
double thisUL = 0;
double arMax = belt->GetAcceptanceRegionMax(*tmpPoint);
double thisTS =
fc.GetTestStatSampler()->EvaluateTestStatistic(*toyData, tmpPOI);
if (thisTS <= arMax) {
} else {
break;
}
}
delete toyData;
}
c1->SaveAs(
"one-sided_upper_limit_output.pdf");
double band2sigDown, band1sigDown, bandMedian, band1sigUp, band2sigUp;
for (
int i = 1; i <= cumulative->
GetNbinsX(); ++i) {
if (bins[i] < 0.5)
}
cout << "-2 sigma band " << band2sigDown << endl;
cout << "-1 sigma band " << band1sigDown << " [Power Constraint)]" << endl;
cout << "median of band " << bandMedian << endl;
cout << "+1 sigma band " << band1sigUp << endl;
cout << "+2 sigma band " << band2sigUp << endl;
cout << "\nobserved 95% upper-limit " << interval->UpperLimit(*firstPOI) << endl;
cout << "CLb strict [P(toy>obs|0)] for observed 95% upper-limit " << CLb << endl;
cout << "CLb inclusive [P(toy>=obs|0)] for observed 95% upper-limit " << CLbinclusive << endl;
delete profile;
delete nll;
}
R__EXTERN TSystem * gSystem
static struct mg_connection * fc(struct mg_context *ctx)
RooArgSet * getObservables(const RooArgSet &set, Bool_t valueOnly=kTRUE) const
Return the observables of this pdf given a set of observables.
TIterator * typeIterator() const
Return iterator over all defined states.
virtual void Print(Option_t *options=0) const
This method must be overridden when a class wants to print itself.
RooAbsData is the common abstract base class for binned and unbinned datasets.
virtual Int_t numEntries() const
RooDataSet * generate(const RooArgSet &whatVars, Int_t nEvents, const RooCmdArg &arg1, const RooCmdArg &arg2=RooCmdArg::none(), const RooCmdArg &arg3=RooCmdArg::none(), const RooCmdArg &arg4=RooCmdArg::none(), const RooCmdArg &arg5=RooCmdArg::none())
See RooAbsPdf::generate(const RooArgSet&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,...
virtual Double_t getMax(const char *name=0) const
Get maximum of currently defined range.
virtual Double_t getMin(const char *name=0) const
Get miniminum of currently defined range.
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
virtual RooAbsReal * createProfile(const RooArgSet ¶msOfInterest)
Create a RooProfileLL object that eliminates all nuisance parameters in the present function.
Double_t getVal(const RooArgSet *normalisationSet=nullptr) const
Evaluate object.
RooArgSet is a container object that can hold multiple RooAbsArg objects.
RooArgSet * snapshot(bool deepCopy=true) const
Use RooAbsCollection::snapshot(), but return as RooArgSet.
Double_t getRealValue(const char *name, Double_t defVal=0, Bool_t verbose=kFALSE) const
Get value of a RooAbsReal stored in set with given name.
virtual TObject * clone(const char *newname) const
virtual Bool_t add(const RooAbsCollection &col, Bool_t silent=kFALSE)
Add a collection of arguments to this collection by calling add() for each element in the source coll...
RooCatType is an auxilary class for RooAbsCategory and defines a a single category state.
RooDataSet is a container class to hold unbinned data.
virtual const RooArgSet * get(Int_t index) const
Return RooArgSet with coordinates of event 'index'.
RooRealVar represents a fundamental (non-derived) real valued object.
virtual void setVal(Double_t value)
Set value of variable to 'value'.
RooSimultaneous facilitates simultaneous fitting of multiple PDFs to subsets of a given dataset.
const RooAbsCategoryLValue & indexCat() const
RooAbsPdf * getPdf(const char *catName) const
Return the p.d.f associated with the given index category name.
The RooWorkspace is a persistable container for RooFit projects.
RooAbsData * data(const char *name) const
Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found.
void Print(Option_t *opts=0) const
Print contents of the workspace.
Bool_t saveSnapshot(const char *name, const char *paramNames)
Save snapshot of values and attributes (including "Constant") of parameters 'params' If importValues ...
Bool_t loadSnapshot(const char *name)
Load the values and attributes of the parameters in the snapshot saved with the given name.
TObject * obj(const char *name) const
Return any type of object (RooAbsArg, RooAbsData or generic object) with given name)
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format.
static TFile * Open(const char *name, Option_t *option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseGeneralPurpose, Int_t netopt=0)
Create / open a file.
1-D histogram with a float per channel (see TH1 documentation)}
virtual Double_t GetBinCenter(Int_t bin) const
Return bin center for 1D histogram.
TAxis * GetXaxis()
Get the behaviour adopted by the object about the statoverflows. See EStatOverflows for more informat...
TObject * Clone(const char *newname=0) const
Make a complete copy of the underlying object.
virtual Int_t GetNbinsX() const
virtual Int_t Fill(Double_t x)
Increment bin with abscissa X by 1.
virtual void SetContent(const Double_t *content)
Replace bin contents by the contents of array content.
virtual void SetMinimum(Double_t minimum=-1111)
virtual void Draw(Option_t *option="")
Draw this histogram with options.
virtual Double_t * GetIntegral()
Return a pointer to the array of bins integral.
Iterator abstract base class.
virtual TObject * Next()=0
virtual void SetTitle(const char *title="")
Set the title of the TNamed.
virtual const char * GetName() const
Returns name of object.
virtual Bool_t AccessPathName(const char *path, EAccessMode mode=kFileExists)
Returns FALSE if one can access a file using the specified access mode.
Template specialisation used in RooAbsArg:
RooCmdArg Extended(Bool_t flag=kTRUE)
Namespace for the RooStats classes.
Double_t SignificanceToPValue(Double_t Z)
returns p-value corresponding to a 1-sided significance
static constexpr double pc
- Authors
- Kyle Cranmer Haichen Wang Daniel Whiteson
Definition in file OneSidedFrequentistUpperLimitWithBands.C.