The RooStats::HistFactory::Measurement class can be used to construct a model by combining multiple RooStats::HistFactory::Channel objects.
It also allows to set some general properties like the integrated luminosity, its relative uncertainty or the functional form of constraints on nuisance parameters.
Definition at line 30 of file Measurement.h.
Public Member Functions | |
Measurement () | |
Standard constructor. | |
Measurement (const char *Name, const char *Title="") | |
Measurement( const Measurement& other ); // Copy. | |
void | AddAsimovDataset (RooStats::HistFactory::Asimov dataset) |
add an Asimov Dataset | |
void | AddChannel (RooStats::HistFactory::Channel chan) |
add a completely configured channel | |
void | AddConstantParam (const std::string ¶m) |
Add a parameter to be set as constant (Similar to ParamSetting method below) | |
void | AddFunctionObject (const RooStats::HistFactory::PreprocessFunction function) |
add a preprocess function object | |
void | AddGammaSyst (std::string syst, double uncert) |
Set constraint term for given systematic to Gamma distribution. | |
void | AddLogNormSyst (std::string syst, double uncert) |
Set constraint term for given systematic to LogNormal distribution. | |
void | AddNoSyst (std::string syst) |
Define given systematics to have no external constraint. | |
void | AddPOI (const std::string &POI) |
append parameter to vector of PoIs | |
void | AddPreprocessFunction (std::string name, std::string expression, std::string dependencies) |
Add a preprocessed function by giving the function a name, a functional expression, and a string with a bracketed list of dependencies (eg "SigXsecOverSM[0,3]") | |
void | AddUniformSyst (std::string syst) |
Set constraint term for given systematic to uniform distribution. | |
void | ClearConstantParams () |
empty vector of constant parameters | |
void | ClearParamValues () |
clear map of parameter values | |
void | CollectHistograms () |
The most common way to add histograms to channels is to have them stored in ROOT files and to give HistFactory the location of these files. | |
std::vector< RooStats::HistFactory::Asimov > & | GetAsimovDatasets () |
get vector of defined Asimov Datasets | |
int | GetBinHigh () |
int | GetBinLow () |
RooStats::HistFactory::Channel & | GetChannel (std::string) |
Get channel with given name from this measurement throws an exception in case the channel is not found. | |
std::vector< RooStats::HistFactory::Channel > & | GetChannels () |
const std::vector< RooStats::HistFactory::Channel > & | GetChannels () const |
std::vector< std::string > & | GetConstantParams () |
get vector of all constant parameters | |
bool | GetExportOnly () |
std::vector< RooStats::HistFactory::PreprocessFunction > & | GetFunctionObjects () |
get vector of defined function objects | |
const std::vector< RooStats::HistFactory::PreprocessFunction > & | GetFunctionObjects () const |
std::map< std::string, double > & | GetGammaSyst () |
std::string | GetInterpolationScheme () |
std::map< std::string, double > & | GetLogNormSyst () |
double | GetLumi () |
retrieve integrated luminosity | |
double | GetLumiRelErr () |
retrieve relative uncertainty on luminosity | |
std::map< std::string, double > & | GetNoSyst () |
std::string | GetOutputFilePrefix () |
retrieve prefix for output files | |
std::map< std::string, double > & | GetParamValues () |
get map: parameter name <--> parameter value | |
std::string | GetPOI (unsigned int i=0) |
get name of PoI at given index | |
std::vector< std::string > & | GetPOIList () |
get vector of PoI names | |
std::vector< std::string > | GetPreprocessFunctions () const |
Returns a list of defined preprocess function expressions. | |
std::map< std::string, double > & | GetUniformSyst () |
bool | HasChannel (std::string) |
Check if the given channel is part of this measurement. | |
void | PrintTree (std::ostream &=std::cout) |
Print information about measurement object in tree-like structure to given stream. | |
void | PrintXML (std::string Directory="", std::string NewOutputPrefix="") |
Print to a stream. | |
void | SetBinHigh (int BinHigh) |
void | SetBinLow (int BinLow) |
void | SetExportOnly (bool ExportOnly) |
do not produce any plots or tables, just save the model | |
void | SetFunctionObjects (std::vector< RooStats::HistFactory::PreprocessFunction > objects) |
void | SetLumi (double Lumi) |
set integrated luminosity used to normalise histograms (if NormalizeByTheory is true for this sample) | |
void | SetLumiRelErr (double RelErr) |
set relative uncertainty on luminosity | |
void | SetOutputFilePrefix (const std::string &prefix) |
set output prefix | |
void | SetParamValue (const std::string ¶m, double value) |
Set a parameter to a specific value (And optionally fix it) | |
void | SetPOI (const std::string &POI) |
insert PoI at beginning of vector of PoIs | |
void | writeToFile (TFile *file) |
A measurement, once fully configured, can be saved into a ROOT file. | |
![]() | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TNamed destructor. | |
virtual void | Clear (Option_t *option="") |
Set name and title to empty strings (""). | |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
virtual Int_t | Compare (const TObject *obj) const |
Compare two TNamed objects. | |
virtual void | Copy (TObject &named) const |
Copy this to obj. | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. | |
virtual const char * | GetName () const |
Returns name of object. | |
virtual const char * | GetTitle () const |
Returns title of object. | |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
virtual Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List TNamed name and title. | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. | |
virtual void | Print (Option_t *option="") const |
Print TNamed name and title. | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. | |
virtual Int_t | Sizeof () const |
Return size of the TNamed part of the TObject. | |
![]() | |
TObject () | |
TObject constructor. | |
TObject (const TObject &object) | |
TObject copy ctor. | |
virtual | ~TObject () |
TObject destructor. | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. | |
virtual void | Browse (TBrowser *b) |
Browse object. May be overridden for another default action. | |
ULong_t | CheckedHash () |
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. | |
virtual void | Delete (Option_t *option="") |
Delete this object. | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. | |
virtual void | Draw (Option_t *option="") |
Default Draw method for all objects. | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad) . | |
virtual void | Dump () const |
Dump contents of object on stdout. | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. | |
virtual void | Execute (const char *method, const char *params, Int_t *error=0) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
Execute method on this object with parameters stored in the TObjArray. | |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
Execute action corresponding to an event at (px,py). | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. | |
virtual const char * | GetIconName () const |
Returns mime type name of object. | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). | |
virtual Option_t * | GetOption () const |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. | |
Bool_t | HasInconsistentHash () const |
Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. | |
virtual Bool_t | InheritsFrom (const char *classname) const |
Returns kTRUE if object inherits from class "classname". | |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
Returns kTRUE if object inherits from TClass cl. | |
virtual void | Inspect () const |
Dump contents of this object in a graphics canvas. | |
void | InvertBit (UInt_t f) |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
void | MayNotUse (const char *method) const |
Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. | |
void | operator delete (void *ptr) |
Operator delete. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. | |
virtual void | Paint (Option_t *option="") |
This method must be overridden if a class wants to paint itself. | |
virtual void | Pop () |
Pop on object drawn in a pad to the top of the display list. | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. | |
virtual void | RecursiveRemove (TObject *obj) |
Recursively remove this object from a list. | |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
Save this object in the file specified by filename. | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save a primitive as a C++ statement(s) on output stream "out". | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. | |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. | |
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
virtual void | UseCurrentStyle () |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Private Member Functions | |
std::string | GetDirPath (TDirectory *dir) |
Return the directory's path, stripped of unnecessary prefixes. | |
Private Attributes | |
std::vector< RooStats::HistFactory::Asimov > | fAsimovDatasets |
List of Asimov datasets to generate. | |
int | fBinHigh |
int | fBinLow |
std::vector< RooStats::HistFactory::Channel > | fChannels |
Channels that make up this measurement. | |
std::vector< std::string > | fConstantParams |
List of Parameters to be set constant. | |
bool | fExportOnly |
std::vector< RooStats::HistFactory::PreprocessFunction > | fFunctionObjects |
List of Preprocess Function objects. | |
std::map< std::string, double > | fGammaSyst |
List of Alternate constraint terms. | |
std::string | fInterpolationScheme |
std::map< std::string, double > | fLogNormSyst |
double | fLumi |
double | fLumiRelErr |
std::map< std::string, double > | fNoSyst |
std::string | fOutputFilePrefix |
Configurables of this measurement. | |
std::map< std::string, double > | fParamValues |
Map of parameter names to inital values to be set. | |
std::vector< std::string > | fPOI |
std::map< std::string, double > | fUniformSyst |
Additional Inherited Members | |
![]() | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) } |
enum | EDeprecatedStatusBits { kObjInCanvas = BIT(3) } |
enum | EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) } |
![]() | |
static Long_t | GetDtorOnly () |
Return destructor only flag. | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. | |
![]() | |
enum | { kOnlyPrepStep = BIT(3) } |
![]() | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
![]() | |
TString | fName |
TString | fTitle |
#include <RooStats/HistFactory/Measurement.h>
RooStats::HistFactory::Measurement::Measurement | ( | ) |
Standard constructor.
Definition at line 38 of file Measurement.cxx.
RooStats::HistFactory::Measurement::Measurement | ( | const char * | Name, |
const char * | Title = "" |
||
) |
Measurement( const Measurement& other ); // Copy.
Standard constructor specifying name and title of measurement.
Definition at line 54 of file Measurement.cxx.
|
inline |
add an Asimov Dataset
Definition at line 81 of file Measurement.h.
|
inline |
add a completely configured channel
Definition at line 108 of file Measurement.h.
void RooStats::HistFactory::Measurement::AddConstantParam | ( | const std::string & | param | ) |
Add a parameter to be set as constant (Similar to ParamSetting method below)
Set a parameter in the model to be constant.
the parameter does not have to exist yet, the information will be used when the model is actually created.
Also checks if the parameter is already set constant. We don't need to set it constant twice, and we issue a warning in case this is a hint of a possible bug
Definition at line 71 of file Measurement.cxx.
|
inline |
add a preprocess function object
Definition at line 71 of file Measurement.h.
Set constraint term for given systematic to Gamma distribution.
Definition at line 137 of file Measurement.cxx.
Set constraint term for given systematic to LogNormal distribution.
Definition at line 143 of file Measurement.cxx.
void RooStats::HistFactory::Measurement::AddNoSyst | ( | std::string | syst | ) |
Define given systematics to have no external constraint.
Definition at line 155 of file Measurement.cxx.
|
inline |
append parameter to vector of PoIs
Definition at line 46 of file Measurement.h.
void RooStats::HistFactory::Measurement::AddPreprocessFunction | ( | std::string | name, |
std::string | expression, | ||
std::string | dependencies | ||
) |
Add a preprocessed function by giving the function a name, a functional expression, and a string with a bracketed list of dependencies (eg "SigXsecOverSM[0,3]")
Definition at line 114 of file Measurement.cxx.
void RooStats::HistFactory::Measurement::AddUniformSyst | ( | std::string | syst | ) |
Set constraint term for given systematic to uniform distribution.
Definition at line 149 of file Measurement.cxx.
|
inline |
empty vector of constant parameters
Definition at line 57 of file Measurement.h.
|
inline |
clear map of parameter values
Definition at line 67 of file Measurement.h.
void RooStats::HistFactory::Measurement::CollectHistograms | ( | ) |
The most common way to add histograms to channels is to have them stored in ROOT files and to give HistFactory the location of these files.
This means providing the path to the ROOT file and the path and name of the histogram within that file. When providing these in a script, HistFactory doesn't load the histogram from the file right away. Instead, once all such histograms have been supplied, one should run this method to open all ROOT files and to copy and save all necessary histograms.
Definition at line 648 of file Measurement.cxx.
|
inline |
get vector of defined Asimov Datasets
Definition at line 79 of file Measurement.h.
|
inline |
Definition at line 95 of file Measurement.h.
|
inline |
Definition at line 94 of file Measurement.h.
RooStats::HistFactory::Channel & RooStats::HistFactory::Measurement::GetChannel | ( | std::string | ChanName | ) |
Get channel with given name from this measurement throws an exception in case the channel is not found.
Definition at line 181 of file Measurement.cxx.
|
inline |
Definition at line 104 of file Measurement.h.
|
inline |
Definition at line 105 of file Measurement.h.
|
inline |
get vector of all constant parameters
Definition at line 59 of file Measurement.h.
|
private |
Return the directory's path, stripped of unnecessary prefixes.
Definition at line 613 of file Measurement.cxx.
|
inline |
Definition at line 99 of file Measurement.h.
|
inline |
get vector of defined function objects
Definition at line 74 of file Measurement.h.
|
inline |
Definition at line 75 of file Measurement.h.
|
inline |
Definition at line 121 of file Measurement.h.
|
inline |
Definition at line 126 of file Measurement.h.
|
inline |
Definition at line 123 of file Measurement.h.
|
inline |
retrieve integrated luminosity
Definition at line 88 of file Measurement.h.
|
inline |
retrieve relative uncertainty on luminosity
Definition at line 90 of file Measurement.h.
|
inline |
Definition at line 124 of file Measurement.h.
|
inline |
retrieve prefix for output files
Definition at line 41 of file Measurement.h.
|
inline |
get map: parameter name <--> parameter value
Definition at line 65 of file Measurement.h.
|
inline |
get name of PoI at given index
Definition at line 48 of file Measurement.h.
|
inline |
get vector of PoI names
Definition at line 50 of file Measurement.h.
std::vector< std::string > RooStats::HistFactory::Measurement::GetPreprocessFunctions | ( | ) | const |
Returns a list of defined preprocess function expressions.
Definition at line 124 of file Measurement.cxx.
|
inline |
Definition at line 122 of file Measurement.h.
bool RooStats::HistFactory::Measurement::HasChannel | ( | std::string | ChanName | ) |
Check if the given channel is part of this measurement.
Definition at line 161 of file Measurement.cxx.
void RooStats::HistFactory::Measurement::PrintTree | ( | std::ostream & | stream = std::cout | ) |
Print information about measurement object in tree-like structure to given stream.
Definition at line 212 of file Measurement.cxx.
void RooStats::HistFactory::Measurement::PrintXML | ( | std::string | directory = "" , |
std::string | newOutputPrefix = "" |
||
) |
Print to a stream.
Create XML files for this measurement in the given directory.
XML files can be configured with a different output prefix Create an XML file for this measurement First, create the XML driver Then, create xml files for each channel
Definition at line 263 of file Measurement.cxx.
Definition at line 93 of file Measurement.h.
Definition at line 92 of file Measurement.h.
do not produce any plots or tables, just save the model
Definition at line 98 of file Measurement.h.
|
inline |
Definition at line 72 of file Measurement.h.
set integrated luminosity used to normalise histograms (if NormalizeByTheory is true for this sample)
Definition at line 84 of file Measurement.h.
set relative uncertainty on luminosity
Definition at line 86 of file Measurement.h.
|
inline |
set output prefix
Definition at line 39 of file Measurement.h.
Set a parameter to a specific value (And optionally fix it)
Set parameter of the model to given value.
Definition at line 89 of file Measurement.cxx.
|
inline |
insert PoI at beginning of vector of PoIs
Definition at line 44 of file Measurement.h.
A measurement, once fully configured, can be saved into a ROOT file.
This will persitify the Measurement object, along with any channels and samples that have been added to it. It can then be loaded, potentially modified, and used to create new models.
Write every histogram to the file. Edit the measurement to point to this file and to point to each histogram in this file Then write the measurement itself.
Definition at line 441 of file Measurement.cxx.
|
private |
List of Asimov datasets to generate.
Definition at line 153 of file Measurement.h.
|
private |
Definition at line 136 of file Measurement.h.
|
private |
Definition at line 135 of file Measurement.h.
|
private |
Channels that make up this measurement.
Definition at line 141 of file Measurement.h.
|
private |
List of Parameters to be set constant.
Definition at line 144 of file Measurement.h.
|
private |
Definition at line 137 of file Measurement.h.
|
private |
List of Preprocess Function objects.
Definition at line 150 of file Measurement.h.
|
private |
List of Alternate constraint terms.
Definition at line 156 of file Measurement.h.
|
private |
Definition at line 138 of file Measurement.h.
|
private |
Definition at line 158 of file Measurement.h.
|
private |
Definition at line 133 of file Measurement.h.
|
private |
Definition at line 134 of file Measurement.h.
|
private |
Definition at line 159 of file Measurement.h.
|
private |
Configurables of this measurement.
Definition at line 131 of file Measurement.h.
|
private |
Map of parameter names to inital values to be set.
Definition at line 147 of file Measurement.h.
|
private |
Definition at line 132 of file Measurement.h.
|
private |
Definition at line 157 of file Measurement.h.