ROOT » ROOFIT » HISTFACTORY » RooStats::HistFactory::Measurement

class RooStats::HistFactory::Measurement: public TNamed

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.

Function Members (Methods)

voidTObject::AbstractMethod(const char* method) const
voidAddAsimovDataset(RooStats::HistFactory::Asimov dataset)
voidAddChannel(RooStats::HistFactory::Channel chan)
voidAddConstantParam(const string& param)
voidAddFunctionObject(const RooStats::HistFactory::PreprocessFunction function)
voidAddGammaSyst(string syst, double uncert)
voidAddLogNormSyst(string syst, double uncert)
voidAddNoSyst(string syst)
voidAddPOI(const string& POI)
voidAddPreprocessFunction(string name, string expression, string dependencies)
voidAddUniformSyst(string syst)
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTNamed::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTNamed::Copy(TObject& named) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTNamed::FillBuffer(char*& buffer)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
virtual const char*TNamed::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
stringGetPOI(unsigned int i = 0)
virtual const char*TNamed::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTNamed::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTNamed::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
RooStats::HistFactory::MeasurementMeasurement(const RooStats::HistFactory::Measurement&)
RooStats::HistFactory::MeasurementMeasurement(const char* Name, const char* Title = "")
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
voidTObject::operator delete(void* ptr)
voidTObject::operator delete(void* ptr, void* vp)
voidTObject::operator delete[](void* ptr)
voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
RooStats::HistFactory::Measurement&operator=(const RooStats::HistFactory::Measurement&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTNamed::Print(Option_t* option = "") const
voidPrintTree(ostream& = std::cout)
voidPrintXML(string Directory = "", string NewOutputPrefix = "")
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
voidSetBinHigh(int BinHigh)
voidSetBinLow(int BinLow)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
voidSetExportOnly(bool ExportOnly)
voidSetFunctionObjects(vector<RooStats::HistFactory::PreprocessFunction> objects)
voidSetLumi(double Lumi)
voidSetLumiRelErr(double RelErr)
virtual voidTNamed::SetName(const char* name)MENU
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
voidSetOutputFilePrefix(const string& prefix)
voidSetParamValue(const string& param, double value)
voidSetPOI(const string& POI)
virtual voidTNamed::SetTitle(const char* title = "")MENU
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp) const
virtual Int_tTNamed::Sizeof() const
virtual voidStreamer(TBuffer&)
voidStreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
voidwriteToFile(TFile* file)
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
stringGetDirPath(TDirectory* dir)

Data Members

static TObject::(anonymous)TObject::kBitMask
static TObject::EStatusBitsTObject::kCanDelete
static TObject::EStatusBitsTObject::kCannotPick
static TObject::EStatusBitsTObject::kHasUUID
static TObject::EStatusBitsTObject::kInvalidObject
static TObject::(anonymous)TObject::kIsOnHeap
static TObject::EStatusBitsTObject::kIsReferenced
static TObject::EStatusBitsTObject::kMustCleanup
static TObject::EStatusBitsTObject::kNoContextMenu
static TObject::(anonymous)TObject::kNotDeleted
static TObject::EStatusBitsTObject::kObjInCanvas
static TObject::(anonymous)TObject::kOverwrite
static TObject::(anonymous)TObject::kSingleKey
static TObject::(anonymous)TObject::kWriteDelete
static TObject::(anonymous)TObject::kZombie
TStringTNamed::fNameobject identifier
TStringTNamed::fTitleobject title

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

 standard constructor
Measurement(const char* Name, const char* Title = "")
 standard constructor specifying name and title of measurement
void AddConstantParam(const string& param)
 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
void SetParamValue(const string& param, double value)
 set parameter of the model to given value
void AddPreprocessFunction(string name, string expression, 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]")
std::vector<std::string> GetPreprocessFunctions()
 returns a list of defined proprocess function expressions
void AddGammaSyst(string syst, double uncert)
 set constraint term for given systematic to Gamma distribution
void AddLogNormSyst(string syst, double uncert)
 set constraint term for given systematic to LogNormal distribution
void AddUniformSyst(string syst)
 set constraint term for given systematic to uniform distribution
void AddNoSyst(string syst)
 define given systematics to have no external constraint
bool HasChannel(string )
 is the given channel part of this measurement
RooStats::HistFactory::Channel& GetChannel(string )
 get channel with given name from this measurement
 throws an exception in case the channel is not found
void PrintTree(ostream& = std::cout)
 print information about measurement object in tree-like structure to given stream
void PrintXML(string Directory = "", string NewOutputPrefix = "")
 create XML files for this measurement in the given directory
 XML files can be configured with a different output prefix
void writeToFile(TFile* file)
 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.
std::string GetDirPath(TDirectory* dir)
 Return the directory's path,
 stripped of unnecessary prefixes
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. 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.
  Measurement( const Measurement& other ); // Copy
Measurement(const char* Name, const char* Title = "")
void SetOutputFilePrefix(const string& prefix)
  set output prefix
{ fOutputFilePrefix = prefix; }
std::string GetOutputFilePrefix()
 retrieve prefix for output files
{ return fOutputFilePrefix; }
void SetPOI(const string& POI)
 insert PoI at beginning of vector of PoIs
{ fPOI.insert( fPOI.begin(), POI ); }
void AddPOI(const string& POI)
 append parameter to vector of PoIs
{ fPOI.push_back(POI); }
std::string GetPOI(unsigned int i = 0)
 get name of PoI at given index
{ return; }
std::vector<std::string>& GetPOIList()
 get vector of PoI names
{ return fPOI; }
void ClearConstantParams()
 empty vector of constant parameters
{ fConstantParams.clear(); }
std::vector< std::string >& GetConstantParams()
 get vector of all constant parameters
{ return fConstantParams; }
std::map<std::string, double>& GetParamValues()
 get map: parameter name <--> parameter value
{ return fParamValues; }
void ClearParamValues()
 clear map of parameter values
{ fParamValues.clear(); }
void AddFunctionObject(const RooStats::HistFactory::PreprocessFunction function)
 add a preprocess function object
{ fFunctionObjects.push_back( function ); }
void SetFunctionObjects(vector<RooStats::HistFactory::PreprocessFunction> objects)
 get vector of defined function objects
{ fFunctionObjects = objects; }
std::vector< RooStats::HistFactory::PreprocessFunction >& GetFunctionObjects()
{ return fFunctionObjects; }
std::vector< RooStats::HistFactory::Asimov >& GetAsimovDatasets()
 get vector of defined Asimov Datasets
{ return fAsimovDatasets; }
void AddAsimovDataset(RooStats::HistFactory::Asimov dataset)
 add an Asimov Dataset
{ fAsimovDatasets.push_back(dataset); }
void SetLumi(double Lumi)
 set integrated luminosity used to normalise histograms (if NormalizeByTheory is true for this sample)
{ fLumi = Lumi; }
void SetLumiRelErr(double RelErr)
 set relative uncertainty on luminosity
{ fLumiRelErr = RelErr; }
double GetLumi()
 retrieve integrated luminosity
{ return fLumi; }
double GetLumiRelErr()
 retrieve relative uncertainty on luminosity
{ return fLumiRelErr; }
void SetBinLow(int BinLow)
{ fBinLow = BinLow; }
void SetBinHigh(int BinHigh)
{ fBinHigh = BinHigh; }
int GetBinLow()
{ return fBinLow; }
int GetBinHigh()
{ return fBinHigh; }
void SetExportOnly(bool ExportOnly)
 do not produce any plots or tables, just save the model
{ fExportOnly = ExportOnly; }
bool GetExportOnly()
{ return fExportOnly; }
std::vector< RooStats::HistFactory::Channel >& GetChannels()
{ return fChannels; }
void AddChannel(RooStats::HistFactory::Channel chan)
 add a completely configured channel
{ fChannels.push_back( chan ); }
std::map< std::string, double >& GetGammaSyst()
{ return fGammaSyst; }
std::map< std::string, double >& GetUniformSyst()
{ return fUniformSyst; }
std::map< std::string, double >& GetLogNormSyst()
{ return fLogNormSyst; }
std::map< std::string, double >& GetNoSyst()
{ return fNoSyst; }