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 33 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	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	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	ClearConstantParams ()
	empty vector of constant parameters

void	ClearParamValues ()
	clear map of parameter values

std::vector< RooStats::HistFactory::Asimov > &	GetAsimovDatasets ()
	get vector of defined Asimov Datasets

int	GetBinHigh ()

int	GetBinLow ()

std::vector< std::string > &	GetConstantParams ()
	get vector of all constant parameters

std::vector< RooStats::HistFactory::PreprocessFunction > &	GetFunctionObjects ()
	get vector of defined function objects

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

double	GetLumi ()
	retrieve integrated luminosity

double	GetLumiRelErr ()
	retrieve relative uncertainty on luminosity

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.

void	SetBinHigh (int BinHigh)

void	SetBinLow (int BinLow)

void	SetExportOnly (bool ExportOnly) R__DEPRECATED(6
	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

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 ("").

TObject *	Clone (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.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (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 TObject *	DrawClone (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 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)

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, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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.

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.

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 )) }

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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.

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 39 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 54 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 84 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 69 of file Measurement.cxx.

◆ AddFunctionObject()

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

inline

add a preprocess function object

Definition at line 74 of file Measurement.h.

◆ AddPOI()

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

inline

append parameter to vector of PoIs

Definition at line 49 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 112 of file Measurement.cxx.

◆ ClearConstantParams()

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

inline

empty vector of constant parameters

Definition at line 60 of file Measurement.h.

◆ ClearParamValues()

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

inline

clear map of parameter values

Definition at line 70 of file Measurement.h.

◆ GetAsimovDatasets()

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

inline

get vector of defined Asimov Datasets

Definition at line 82 of file Measurement.h.

◆ GetBinHigh()

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

inline

Definition at line 98 of file Measurement.h.

◆ GetBinLow()

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

inline

Definition at line 97 of file Measurement.h.

◆ GetConstantParams()

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

inline

get vector of all constant parameters

Definition at line 62 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 77 of file Measurement.h.

◆ GetFunctionObjects() [2/2]

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

inline

Definition at line 78 of file Measurement.h.

◆ GetLumi()

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

inline

retrieve integrated luminosity

Definition at line 91 of file Measurement.h.

◆ GetLumiRelErr()

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

inline

retrieve relative uncertainty on luminosity

Definition at line 93 of file Measurement.h.

◆ GetOutputFilePrefix()

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

inline

retrieve prefix for output files

Definition at line 44 of file Measurement.h.

◆ GetParamValues()

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

inline

get map: parameter name <--> parameter value

Definition at line 68 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 51 of file Measurement.h.

◆ GetPOIList()

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

inline

get vector of PoI names

Definition at line 53 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 122 of file Measurement.cxx.

◆ SetBinHigh()

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

inline

Definition at line 96 of file Measurement.h.

◆ SetBinLow()

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

inline

Definition at line 95 of file Measurement.h.

◆ SetExportOnly()

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

Do not produce any plots or tables, just save the model.

Deprecated:: Will be removed in ROOT 6.36. ExportOnly() == true is the default since ROOT 6.34 and it can't be disabled anymore in 6.36.

◆ SetFunctionObjects()

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

inline

Definition at line 75 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 87 of file Measurement.h.

◆ SetLumiRelErr()

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

inline

set relative uncertainty on luminosity

Definition at line 89 of file Measurement.h.

◆ SetOutputFilePrefix()

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

inline

set output prefix

Definition at line 42 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 87 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 47 of file Measurement.h.

Libraries for RooStats::HistFactory::Measurement:

[legend]

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

roofit/histfactory/inc/RooStats/HistFactory/Measurement.h
roofit/histfactory/src/Measurement.cxx

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ Measurement() [1/2]

◆ Measurement() [2/2]

Member Function Documentation

◆ AddAsimovDataset()

◆ AddConstantParam()

◆ AddFunctionObject()

◆ AddPOI()

◆ AddPreprocessFunction()

◆ ClearConstantParams()

◆ ClearParamValues()

◆ GetAsimovDatasets()

◆ GetBinHigh()

◆ GetBinLow()

◆ GetConstantParams()

◆ GetFunctionObjects() [1/2]

◆ GetFunctionObjects() [2/2]

◆ GetLumi()

◆ GetLumiRelErr()

◆ GetOutputFilePrefix()

◆ GetParamValues()

◆ GetPOI()

◆ GetPOIList()

◆ GetPreprocessFunctions()

◆ SetBinHigh()

◆ SetBinLow()

◆ SetExportOnly()

◆ SetFunctionObjects()

◆ SetLumi()

◆ SetLumiRelErr()

◆ SetOutputFilePrefix()

◆ SetParamValue()

◆ SetPOI()