Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooStats::HistFactory::Measurement Class Reference

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 31 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 &param)
 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::ChannelGetChannel (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::map< std::string, double > const & GetGammaSyst () const
 
std::string GetInterpolationScheme ()
 
std::map< std::string, double > & GetLogNormSyst ()
 
std::map< std::string, double > const & GetLogNormSyst () const
 
double GetLumi ()
 retrieve integrated luminosity
 
double GetLumiRelErr ()
 retrieve relative uncertainty on luminosity
 
std::map< std::string, double > & GetNoSyst ()
 
std::map< std::string, double > const & GetNoSyst () const
 
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 ()
 
std::map< std::string, double > const & GetUniformSyst () const
 
bool HasChannel (std::string)
 Check if the given channel is part of this measurement.
 
TClassIsA () const override
 
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 &param, 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 Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void writeToFile (TFile *file)
 A measurement, once fully configured, can be saved into a ROOT file.
 
- Public Member Functions inherited from TNamed
 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.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 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.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from 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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
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=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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)
 
Bool_t IsDestructed () const
 IsDestructed.
 
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 (the base implementation is no-op).
 
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)
 
TObjectoperator= (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.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_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.
 

Private Member Functions

std::string GetDirPath (TDirectory *dir)
 Return the directory's path, stripped of unnecessary prefixes.
 

Private Attributes

std::vector< RooStats::HistFactory::AsimovfAsimovDatasets
 List of Asimov datasets to generate.
 
int fBinHigh
 
int fBinLow
 
std::vector< RooStats::HistFactory::ChannelfChannels
 Channels that make up this measurement.
 
std::vector< std::string > fConstantParams
 List of Parameters to be set constant.
 
bool fExportOnly
 
std::vector< RooStats::HistFactory::PreprocessFunctionfFunctionObjects
 List of Preprocess Function objects.
 
std::map< std::string, doublefGammaSyst
 List of Alternate constraint terms.
 
std::string fInterpolationScheme
 
std::map< std::string, doublefLogNormSyst
 
double fLumi
 
double fLumiRelErr
 
std::map< std::string, doublefNoSyst
 
std::string fOutputFilePrefix
 Configurables of this measurement.
 
std::map< std::string, doublefParamValues
 Map of parameter names to initial values to be set.
 
std::vector< std::string > fPOI
 
std::map< std::string, doublefUniformSyst
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <RooStats/HistFactory/Measurement.h>

Inheritance diagram for RooStats::HistFactory::Measurement:
[legend]

Constructor & Destructor Documentation

◆ Measurement() [1/2]

RooStats::HistFactory::Measurement::Measurement ( )

Standard constructor.

Definition at line 40 of file Measurement.cxx.

◆ Measurement() [2/2]

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 55 of file Measurement.cxx.

Member Function Documentation

◆ AddAsimovDataset()

void RooStats::HistFactory::Measurement::AddAsimovDataset ( RooStats::HistFactory::Asimov  dataset)
inline

add an Asimov Dataset

Definition at line 82 of file Measurement.h.

◆ AddChannel()

void RooStats::HistFactory::Measurement::AddChannel ( RooStats::HistFactory::Channel  chan)
inline

add a completely configured channel

Definition at line 109 of file Measurement.h.

◆ AddConstantParam()

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 70 of file Measurement.cxx.

◆ AddFunctionObject()

void RooStats::HistFactory::Measurement::AddFunctionObject ( const RooStats::HistFactory::PreprocessFunction  function)
inline

add a preprocess function object

Definition at line 72 of file Measurement.h.

◆ AddGammaSyst()

void RooStats::HistFactory::Measurement::AddGammaSyst ( std::string  syst,
double  uncert 
)

Set constraint term for given systematic to Gamma distribution.

Definition at line 136 of file Measurement.cxx.

◆ AddLogNormSyst()

void RooStats::HistFactory::Measurement::AddLogNormSyst ( std::string  syst,
double  uncert 
)

Set constraint term for given systematic to LogNormal distribution.

Definition at line 142 of file Measurement.cxx.

◆ AddNoSyst()

void RooStats::HistFactory::Measurement::AddNoSyst ( std::string  syst)

Define given systematics to have no external constraint.

Definition at line 154 of file Measurement.cxx.

◆ AddPOI()

void RooStats::HistFactory::Measurement::AddPOI ( const std::string &  POI)
inline

append parameter to vector of PoIs

Definition at line 47 of file Measurement.h.

◆ AddPreprocessFunction()

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 113 of file Measurement.cxx.

◆ AddUniformSyst()

void RooStats::HistFactory::Measurement::AddUniformSyst ( std::string  syst)

Set constraint term for given systematic to uniform distribution.

Definition at line 148 of file Measurement.cxx.

◆ Class()

static TClass * RooStats::HistFactory::Measurement::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * RooStats::HistFactory::Measurement::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t RooStats::HistFactory::Measurement::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 169 of file Measurement.h.

◆ ClearConstantParams()

void RooStats::HistFactory::Measurement::ClearConstantParams ( )
inline

empty vector of constant parameters

Definition at line 58 of file Measurement.h.

◆ ClearParamValues()

void RooStats::HistFactory::Measurement::ClearParamValues ( )
inline

clear map of parameter values

Definition at line 68 of file Measurement.h.

◆ CollectHistograms()

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 647 of file Measurement.cxx.

◆ DeclFileName()

static const char * RooStats::HistFactory::Measurement::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 169 of file Measurement.h.

◆ GetAsimovDatasets()

std::vector< RooStats::HistFactory::Asimov > & RooStats::HistFactory::Measurement::GetAsimovDatasets ( )
inline

get vector of defined Asimov Datasets

Definition at line 80 of file Measurement.h.

◆ GetBinHigh()

int RooStats::HistFactory::Measurement::GetBinHigh ( )
inline

Definition at line 96 of file Measurement.h.

◆ GetBinLow()

int RooStats::HistFactory::Measurement::GetBinLow ( )
inline

Definition at line 95 of file Measurement.h.

◆ GetChannel()

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 180 of file Measurement.cxx.

◆ GetChannels() [1/2]

std::vector< RooStats::HistFactory::Channel > & RooStats::HistFactory::Measurement::GetChannels ( )
inline

Definition at line 105 of file Measurement.h.

◆ GetChannels() [2/2]

const std::vector< RooStats::HistFactory::Channel > & RooStats::HistFactory::Measurement::GetChannels ( ) const
inline

Definition at line 106 of file Measurement.h.

◆ GetConstantParams()

std::vector< std::string > & RooStats::HistFactory::Measurement::GetConstantParams ( )
inline

get vector of all constant parameters

Definition at line 60 of file Measurement.h.

◆ GetDirPath()

std::string RooStats::HistFactory::Measurement::GetDirPath ( TDirectory dir)
private

Return the directory's path, stripped of unnecessary prefixes.

Definition at line 612 of file Measurement.cxx.

◆ GetExportOnly()

bool RooStats::HistFactory::Measurement::GetExportOnly ( )
inline

Definition at line 100 of file Measurement.h.

◆ GetFunctionObjects() [1/2]

std::vector< RooStats::HistFactory::PreprocessFunction > & RooStats::HistFactory::Measurement::GetFunctionObjects ( )
inline

get vector of defined function objects

Definition at line 75 of file Measurement.h.

◆ GetFunctionObjects() [2/2]

const std::vector< RooStats::HistFactory::PreprocessFunction > & RooStats::HistFactory::Measurement::GetFunctionObjects ( ) const
inline

Definition at line 76 of file Measurement.h.

◆ GetGammaSyst() [1/2]

std::map< std::string, double > & RooStats::HistFactory::Measurement::GetGammaSyst ( )
inline

Definition at line 122 of file Measurement.h.

◆ GetGammaSyst() [2/2]

std::map< std::string, double > const & RooStats::HistFactory::Measurement::GetGammaSyst ( ) const
inline

Definition at line 127 of file Measurement.h.

◆ GetInterpolationScheme()

std::string RooStats::HistFactory::Measurement::GetInterpolationScheme ( )
inline

Definition at line 132 of file Measurement.h.

◆ GetLogNormSyst() [1/2]

std::map< std::string, double > & RooStats::HistFactory::Measurement::GetLogNormSyst ( )
inline

Definition at line 124 of file Measurement.h.

◆ GetLogNormSyst() [2/2]

std::map< std::string, double > const & RooStats::HistFactory::Measurement::GetLogNormSyst ( ) const
inline

Definition at line 129 of file Measurement.h.

◆ GetLumi()

double RooStats::HistFactory::Measurement::GetLumi ( )
inline

retrieve integrated luminosity

Definition at line 89 of file Measurement.h.

◆ GetLumiRelErr()

double RooStats::HistFactory::Measurement::GetLumiRelErr ( )
inline

retrieve relative uncertainty on luminosity

Definition at line 91 of file Measurement.h.

◆ GetNoSyst() [1/2]

std::map< std::string, double > & RooStats::HistFactory::Measurement::GetNoSyst ( )
inline

Definition at line 125 of file Measurement.h.

◆ GetNoSyst() [2/2]

std::map< std::string, double > const & RooStats::HistFactory::Measurement::GetNoSyst ( ) const
inline

Definition at line 130 of file Measurement.h.

◆ GetOutputFilePrefix()

std::string RooStats::HistFactory::Measurement::GetOutputFilePrefix ( )
inline

retrieve prefix for output files

Definition at line 42 of file Measurement.h.

◆ GetParamValues()

std::map< std::string, double > & RooStats::HistFactory::Measurement::GetParamValues ( )
inline

get map: parameter name <--> parameter value

Definition at line 66 of file Measurement.h.

◆ GetPOI()

std::string RooStats::HistFactory::Measurement::GetPOI ( unsigned int  i = 0)
inline

get name of PoI at given index

Definition at line 49 of file Measurement.h.

◆ GetPOIList()

std::vector< std::string > & RooStats::HistFactory::Measurement::GetPOIList ( )
inline

get vector of PoI names

Definition at line 51 of file Measurement.h.

◆ GetPreprocessFunctions()

std::vector< std::string > RooStats::HistFactory::Measurement::GetPreprocessFunctions ( ) const

Returns a list of defined preprocess function expressions.

Definition at line 123 of file Measurement.cxx.

◆ GetUniformSyst() [1/2]

std::map< std::string, double > & RooStats::HistFactory::Measurement::GetUniformSyst ( )
inline

Definition at line 123 of file Measurement.h.

◆ GetUniformSyst() [2/2]

std::map< std::string, double > const & RooStats::HistFactory::Measurement::GetUniformSyst ( ) const
inline

Definition at line 128 of file Measurement.h.

◆ HasChannel()

bool RooStats::HistFactory::Measurement::HasChannel ( std::string  ChanName)

Check if the given channel is part of this measurement.

Definition at line 160 of file Measurement.cxx.

◆ IsA()

TClass * RooStats::HistFactory::Measurement::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 169 of file Measurement.h.

◆ PrintTree()

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 211 of file Measurement.cxx.

◆ PrintXML()

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 262 of file Measurement.cxx.

◆ SetBinHigh()

void RooStats::HistFactory::Measurement::SetBinHigh ( int  BinHigh)
inline

Definition at line 94 of file Measurement.h.

◆ SetBinLow()

void RooStats::HistFactory::Measurement::SetBinLow ( int  BinLow)
inline

Definition at line 93 of file Measurement.h.

◆ SetExportOnly()

void RooStats::HistFactory::Measurement::SetExportOnly ( bool  ExportOnly)
inline

do not produce any plots or tables, just save the model

Definition at line 99 of file Measurement.h.

◆ SetFunctionObjects()

void RooStats::HistFactory::Measurement::SetFunctionObjects ( std::vector< RooStats::HistFactory::PreprocessFunction objects)
inline

Definition at line 73 of file Measurement.h.

◆ SetLumi()

void RooStats::HistFactory::Measurement::SetLumi ( double  Lumi)
inline

set integrated luminosity used to normalise histograms (if NormalizeByTheory is true for this sample)

Definition at line 85 of file Measurement.h.

◆ SetLumiRelErr()

void RooStats::HistFactory::Measurement::SetLumiRelErr ( double  RelErr)
inline

set relative uncertainty on luminosity

Definition at line 87 of file Measurement.h.

◆ SetOutputFilePrefix()

void RooStats::HistFactory::Measurement::SetOutputFilePrefix ( const std::string &  prefix)
inline

set output prefix

Definition at line 40 of file Measurement.h.

◆ SetParamValue()

void RooStats::HistFactory::Measurement::SetParamValue ( const std::string &  param,
double  value 
)

Set a parameter to a specific value (And optionally fix it)

Set parameter of the model to given value.

Definition at line 88 of file Measurement.cxx.

◆ SetPOI()

void RooStats::HistFactory::Measurement::SetPOI ( const std::string &  POI)
inline

insert PoI at beginning of vector of PoIs

Definition at line 45 of file Measurement.h.

◆ Streamer()

void RooStats::HistFactory::Measurement::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void RooStats::HistFactory::Measurement::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 169 of file Measurement.h.

◆ writeToFile()

void RooStats::HistFactory::Measurement::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.

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 440 of file Measurement.cxx.

Member Data Documentation

◆ fAsimovDatasets

std::vector< RooStats::HistFactory::Asimov > RooStats::HistFactory::Measurement::fAsimovDatasets
private

List of Asimov datasets to generate.

Definition at line 159 of file Measurement.h.

◆ fBinHigh

int RooStats::HistFactory::Measurement::fBinHigh
private

Definition at line 142 of file Measurement.h.

◆ fBinLow

int RooStats::HistFactory::Measurement::fBinLow
private

Definition at line 141 of file Measurement.h.

◆ fChannels

std::vector< RooStats::HistFactory::Channel > RooStats::HistFactory::Measurement::fChannels
private

Channels that make up this measurement.

Definition at line 147 of file Measurement.h.

◆ fConstantParams

std::vector< std::string > RooStats::HistFactory::Measurement::fConstantParams
private

List of Parameters to be set constant.

Definition at line 150 of file Measurement.h.

◆ fExportOnly

bool RooStats::HistFactory::Measurement::fExportOnly
private

Definition at line 143 of file Measurement.h.

◆ fFunctionObjects

std::vector< RooStats::HistFactory::PreprocessFunction > RooStats::HistFactory::Measurement::fFunctionObjects
private

List of Preprocess Function objects.

Definition at line 156 of file Measurement.h.

◆ fGammaSyst

std::map< std::string, double > RooStats::HistFactory::Measurement::fGammaSyst
private

List of Alternate constraint terms.

Definition at line 162 of file Measurement.h.

◆ fInterpolationScheme

std::string RooStats::HistFactory::Measurement::fInterpolationScheme
private

Definition at line 144 of file Measurement.h.

◆ fLogNormSyst

std::map< std::string, double > RooStats::HistFactory::Measurement::fLogNormSyst
private

Definition at line 164 of file Measurement.h.

◆ fLumi

double RooStats::HistFactory::Measurement::fLumi
private

Definition at line 139 of file Measurement.h.

◆ fLumiRelErr

double RooStats::HistFactory::Measurement::fLumiRelErr
private

Definition at line 140 of file Measurement.h.

◆ fNoSyst

std::map< std::string, double > RooStats::HistFactory::Measurement::fNoSyst
private

Definition at line 165 of file Measurement.h.

◆ fOutputFilePrefix

std::string RooStats::HistFactory::Measurement::fOutputFilePrefix
private

Configurables of this measurement.

Definition at line 137 of file Measurement.h.

◆ fParamValues

std::map< std::string, double > RooStats::HistFactory::Measurement::fParamValues
private

Map of parameter names to initial values to be set.

Definition at line 153 of file Measurement.h.

◆ fPOI

std::vector<std::string> RooStats::HistFactory::Measurement::fPOI
private

Definition at line 138 of file Measurement.h.

◆ fUniformSyst

std::map< std::string, double > RooStats::HistFactory::Measurement::fUniformSyst
private

Definition at line 163 of file Measurement.h.

Libraries for RooStats::HistFactory::Measurement:

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