Detailed Description

It includes a model definition and experimental data used to obtain a final experimental sensitivity.

Documentation TOBE written

REST-for-Physics - Software for Rare Event Searches Toolkit

History of developments:

2022-December: First implementation of TRestExperiment Javier Galan

Author: : Javier Galan (javie.nosp@m.r.ga.nosp@m.lan.l.nosp@m.acar.nosp@m.ra@ce.nosp@m.rn.c.nosp@m.h)

Definition at line 33 of file TRestExperiment.h.

#include <TRestExperiment.h>

Inheritance diagram for TRestExperiment:

Public Member Functions
	ClassDefOverride (TRestExperiment, 2)

void	GenerateMockDataSet (Bool_t useAverage=false)

TRestComponent *	GetBackground () const

Int_t	GetExperimentalCounts () const

ROOT::RDF::RNode	GetExperimentalDataFrame () const

TRestDataSet	GetExperimentalDataSet () const

Double_t	GetExposureInSeconds () const

TRestComponent *	GetSignal () const

void	Initialize () override
	It will initialize the data frame with the filelist and column names (or observables) that have been defined by the user. More...

Bool_t	IsDataReady () const

Bool_t	IsMockData () const

void	PrintExperimentalData ()

void	PrintMetadata () override
	Prints on screen the information about the metadata members of TRestAxionSolarFlux. More...

void	SetBackground (TRestComponent *comp)

void	SetExperimentalDataSet (const std::string &filename)

void	SetExposureInSeconds (const Double_t exposure)

void	SetSignal (TRestComponent *comp)

	TRestExperiment ()
	Default constructor. More...

	TRestExperiment (const char *cfgFileName, const std::string &name="")
	Constructor loading data from a config file. More...

	~TRestExperiment ()
	Default destructor. More...

Public Member Functions inherited from TRestMetadata
void	AddLog (std::string log="", bool print=true)
	Add logs to messageBuffer. More...

void	DoNotStore ()
	If this method is called the metadata information will not be stored in disk. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1))

TString	GetCommit ()
	Returns the REST commit value stored in fCommit. More...

std::string	GetConfigBuffer ()
	Returns the config section of this class. More...

std::string	GetDataMemberValue (std::string memberName)
	Get the value of data member as string. More...

std::vector< std::string >	GetDataMemberValues (std::string memberName, Int_t precision=0)
	Get the value of datamember as a vector of strings. More...

TString	GetDataPath ()
	Returns a std::string with the path used for data storage. More...

Double_t	GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL)
	Gets the value of the parameter name parName, after applying unit conversion. More...

Bool_t	GetError () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetErrorMessage ()
	Returns a std::string containing the error message. More...

TString	GetLibraryVersion ()
	Returns the REST libraty version stored in fLibraryVersion. More...

TString	GetMainDataPath ()
	Gets a std::string with the path used for data storage. More...

Int_t	GetNumberOfErrors () const

Int_t	GetNumberOfWarnings () const

std::string	GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns corresponding REST Metadata parameter from multiple sources. More...

std::string	GetSectionName ()
	Returns the section name of this class, defined at the beginning of fSectionName. More...

TRestStringOutput::REST_Verbose_Level	GetVerboseLevel ()
	returns the verboselevel in type of REST_Verbose_Level enumerator More...

TString	GetVerboseLevelString ()
	returns the verbose level in type of TString More...

TString	GetVersion ()
	Returns the REST version stored in fVersion. More...

Int_t	GetVersionCode ()

UInt_t	GetVersionMajor () const

UInt_t	GetVersionMinor () const

UInt_t	GetVersionPatch () const

Bool_t	GetWarning () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetWarningMessage ()
	Returns a std::string containing the warning message. More...

virtual void	Initialize ()
	Making default settings. More...

TRestMetadata *	InstantiateChildMetadata (int index, std::string pattern="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `index` given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More...

TRestMetadata *	InstantiateChildMetadata (std::string pattern="", std::string name="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `name` given by argument. More...

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

Int_t	LoadConfigFromBuffer ()
	Initialize data from a string element buffer. More...

Int_t	LoadConfigFromElement (TiXmlElement eSectional, TiXmlElement eGlobal, std::map< std::string, std::string > envs={})
	Main starter method. More...

Int_t	LoadConfigFromFile (const std::string &configFilename, const std::string &sectionName="")
	Give the file name, find out the corresponding section. Then call the main starter. More...

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)

void	Print ()
	Implementing TObject::Print() method. More...

void	PrintConfigBuffer ()
	Print the config xml section stored in the class. More...

void	PrintMessageBuffer ()
	Print the buffered message. More...

virtual void	PrintMetadata ()
	Implemented it in the derived metadata class to print out specific metadata information. More...

void	PrintTimeStamp (Double_t timeStamp)
	Print the current time on local machine. More...

void	SetConfigFile (std::string configFilename)
	set config file path from external More...

void	SetError (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	SetHostmgr (TRestManager *m)
	Set the host manager for this class. More...

void	SetSectionName (std::string sName)
	set the section name, clear the section content More...

void	SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v)
	sets the verbose level More...

void	SetWarning (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	Store ()
	If this method is called the metadata information will be stored in disk. More...

	TRestMetadata (const TRestMetadata &)

virtual void	UpdateMetadataMembers ()
	Method to allow implementation of specific metadata members updates at inherited classes. More...

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	overwriting the write() method with fStore considered More...

void	WriteConfigBuffer (std::string fName)
	Writes the config buffer to a file in append mode. More...

	~TRestMetadata ()
	TRestMetadata default destructor. More...

Protected Member Functions
void	InitFromConfigFile () override
	It customizes the retrieval of XML data values of this class. More...

Protected Member Functions inherited from TRestMetadata
std::string	ElementToString (TiXmlElement *ele)
	Convert an TiXmlElement object to string. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1))

Double_t	GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL)

TiXmlElement *	GetElement (std::string eleDeclare, TiXmlElement *e=nullptr)
	Get an xml element from a given parent element, according to its declaration. More...

TiXmlElement *	GetElementFromFile (std::string configFilename, std::string NameOrDecalre="")
	Open an xml encoded file and find its element. More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName)
	Get an xml element from the default location, according to its declaration and its field "name". More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name". More...

std::string	GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0)
	Gets field value in an xml element string by parsing it as TiXmlElement. More...

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified name. More...

std::string	GetKEYDefinition (std::string keyName)
	Gets the first key definition for keyName found inside buffer starting at fromPosition. More...

std::string	GetKEYDefinition (std::string keyName, size_t &Position)

std::string	GetKEYDefinition (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYDefinition (std::string keyName, std::string buffer)

std::string	GetKEYStructure (std::string keyName)
	Gets the first key structure for keyName found inside buffer after fromPosition. More...

std::string	GetKEYStructure (std::string keyName, size_t &Position)

std::string	GetKEYStructure (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYStructure (std::string keyName, size_t &Position, TiXmlElement *ele)

std::string	GetKEYStructure (std::string keyName, std::string buffer)

TiXmlElement *	GetNextElement (TiXmlElement *e)
	Get the next sibling xml element of this element, with same eleDeclare. More...

std::string	GetParameter (std::string parName, size_t &pos, std::string inputString)
	Returns the value for the parameter name parName found in inputString. More...

std::string	GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns the value for the parameter named parName in the given section. More...

std::pair< std::string, std::string >	GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr)
	Returns the unit string of the given parameter of the given xml section. More...

std::map< std::string, std::string >	GetParametersList ()
	It retrieves a map of all parameter:value found in the metadata class. More...

TString	GetSearchPath ()

virtual void	InitFromConfigFile ()
	To make settings from rml file. This method must be implemented in the derived class. More...

virtual void	InitFromRootFile ()
	Method called after the object is retrieved from root file. More...

virtual Int_t	LoadSectionMetadata ()
	This method does some preparation of xml section. More...

void	ReadAllParameters ()
	Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More...

void	ReadParametersList (std::map< std::string, std::string > &list)
	It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. More...

std::string	ReplaceConstants (const std::string buffer)
	Identifies "constants" in the input buffer, and replace them with corresponding value. More...

std::string	ReplaceVariables (const std::string buffer)
	Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More...

void	ReSetVersion ()
	Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. More...

std::string	SearchFile (std::string filename)
	Search files in current directory and directories specified in "searchPath" section. More...

void	SetLibraryVersion (TString version)
	Set the library version of this metadata class. More...

TiXmlElement *	StringToElement (std::string definition)
	Parsing a string into TiXmlElement object. More...

	TRestMetadata ()
	TRestMetadata default constructor. More...

	TRestMetadata (const char *configFilename)
	constructor More...

void	UnSetVersion ()
	Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. More...

Private Attributes
TRestComponent *	fBackground = nullptr
	A pointer to the background component. More...

Bool_t	fDataReady = false
	Only if it is true we will be able to calculate the LogLikelihood. More...

Int_t	fExperimentalCounts = 0
	It keeps track on the number of counts inside the dataset. More...

TRestDataSet	fExperimentalData
	It contains the experimental data (should contain same columns as the components) More...

std::string	fExperimentalDataSet = ""
	It defines the filename used to load the dataset. More...

Double_t	fExposureTime = 0
	The exposure time. If 0 it will be extracted from the tracking dataset (In us, standard REST unit) More...

Bool_t	fMockData = false
	If enabled it means that the experimental data was MC-generated. More...

TRandom3 *	fRandom = nullptr
	Internal process random generator. More...

UInt_t	fSeed = 0
	Seed used in random generator. More...

TRestComponent *	fSignal = nullptr
	A pointer to the signal component. More...

Bool_t	fUseAverage = false
	The mock dataset will be generated using the mean counts instead of a real MonteCarlo. More...

Additional Inherited Members
Protected Attributes inherited from TRestMetadata
std::string	configBuffer
	The buffer where the corresponding metadata section is stored. Filled only during Write() More...

std::string	fConfigFileName
	Full name of the rml file. More...

std::map< std::string, std::string >	fConstants
	Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only. More...

TiXmlElement *	fElement
	Saving the sectional element together with global element. More...

TiXmlElement *	fElementGlobal
	Saving the global element, to be passed to the resident class, if necessary. More...

Bool_t	fError = false
	It can be used as a way to identify that something went wrong using SetError method. More...

TString	fErrorMessage = ""
	A std::string to store an optional error message through method SetError. More...

TRestManager *	fHostmgr
	All metadata classes can be initialized and managed by TRestManager. More...

Int_t	fNErrors = 0
	It counts the number of errors notified. More...

Int_t	fNWarnings = 0
	It counts the number of warnings notified. More...

std::string	fSectionName
	Section name given in the constructor of the derived metadata class. More...

Bool_t	fStore
	This variable is used to determine if the metadata structure should be stored in the ROOT file. More...

std::map< std::string, std::string >	fVariables
	Saving a list of rml variables. name-value std::pair. More...

TRestStringOutput::REST_Verbose_Level	fVerboseLevel
	Verbose level used to print debug info. More...

Bool_t	fWarning = false
	It can be used as a way to identify that something went wrong using SetWarning method. More...

TString	fWarningMessage = ""
	It can be used as a way to identify that something went wrong using SetWarning method. More...

std::string	messageBuffer
	The buffer to store the output message through TRestStringOutput in this class. More...

endl_t	RESTendl
	Termination flag object for TRestStringOutput. More...

Constructor & Destructor Documentation

◆ TRestExperiment() [1/2]

TRestExperiment::TRestExperiment	(	const char *	cfgFileName,
		const std::string &	name = `""`
	)

Constructor loading data from a config file.

If no configuration path is defined using TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

The default behaviour is that the config file must be specified with full path, absolute or relative.

Parameters

cfgFileName	A const char* giving the path to an RML file.
name	The name of the specific metadata. It will be used to find the corresponding TRestAxionMagneticField section inside the RML.

Definition at line 69 of file TRestExperiment.cxx.

◆ TRestExperiment() [2/2]

TRestExperiment::TRestExperiment ( )

Default constructor.

Definition at line 48 of file TRestExperiment.cxx.

◆ ~TRestExperiment()

TRestExperiment::~TRestExperiment ( )

Default destructor.

Definition at line 53 of file TRestExperiment.cxx.

Member Function Documentation

◆ GenerateMockDataSet()

void TRestExperiment::GenerateMockDataSet ( Bool_t useAverage = false )

Definition at line 90 of file TRestExperiment.cxx.

◆ GetBackground()

TRestComponent * TRestExperiment::GetBackground ( ) const

inline

Definition at line 85 of file TRestExperiment.h.

◆ GetExperimentalCounts()

Int_t TRestExperiment::GetExperimentalCounts ( ) const

inline

Definition at line 73 of file TRestExperiment.h.

◆ GetExperimentalDataFrame()

ROOT::RDF::RNode TRestExperiment::GetExperimentalDataFrame ( ) const

inline

Definition at line 88 of file TRestExperiment.h.

◆ GetExperimentalDataSet()

TRestDataSet TRestExperiment::GetExperimentalDataSet ( ) const

inline

Definition at line 87 of file TRestExperiment.h.

◆ GetExposureInSeconds()

Double_t TRestExperiment::GetExposureInSeconds ( ) const

inline

Definition at line 84 of file TRestExperiment.h.

◆ GetSignal()

TRestComponent * TRestExperiment::GetSignal ( ) const

inline

Definition at line 86 of file TRestExperiment.h.

◆ InitFromConfigFile()

void TRestExperiment::InitFromConfigFile ( )

overrideprotectedvirtual

It customizes the retrieval of XML data values of this class.

Checking that signal/background/tracking got the same variable names and ranges

Reimplemented from TRestMetadata.

Definition at line 155 of file TRestExperiment.cxx.

◆ Initialize()

void TRestExperiment::Initialize ( )

overridevirtual

It will initialize the data frame with the filelist and column names (or observables) that have been defined by the user.

Reimplemented from TRestMetadata.

Definition at line 78 of file TRestExperiment.cxx.

◆ IsDataReady()

Bool_t TRestExperiment::IsDataReady ( ) const

inline

Definition at line 76 of file TRestExperiment.h.

◆ IsMockData()

Bool_t TRestExperiment::IsMockData ( ) const

inline

Definition at line 75 of file TRestExperiment.h.

◆ PrintExperimentalData()

void TRestExperiment::PrintExperimentalData ( )

inline

Definition at line 90 of file TRestExperiment.h.

◆ PrintMetadata()

void TRestExperiment::PrintMetadata ( )

overridevirtual

Prints on screen the information about the metadata members of TRestAxionSolarFlux.

Reimplemented from TRestMetadata.

Definition at line 269 of file TRestExperiment.cxx.

◆ SetBackground()

void TRestExperiment::SetBackground ( TRestComponent * comp )

inline

Definition at line 80 of file TRestExperiment.h.

◆ SetExperimentalDataSet()

void TRestExperiment::SetExperimentalDataSet ( const std::string & filename )

fExposureTime is in standard REST units : us

Definition at line 121 of file TRestExperiment.cxx.

◆ SetExposureInSeconds()

void TRestExperiment::SetExposureInSeconds ( const Double_t exposure )

inline

Definition at line 78 of file TRestExperiment.h.

◆ SetSignal()

void TRestExperiment::SetSignal ( TRestComponent * comp )

inline

Definition at line 79 of file TRestExperiment.h.

Field Documentation

◆ fBackground

TRestComponent* TRestExperiment::fBackground = nullptr

private

A pointer to the background component.

Definition at line 39 of file TRestExperiment.h.

◆ fDataReady

Bool_t TRestExperiment::fDataReady = false

private

Only if it is true we will be able to calculate the LogLikelihood.

Definition at line 54 of file TRestExperiment.h.

◆ fExperimentalCounts

Int_t TRestExperiment::fExperimentalCounts = 0

private

It keeps track on the number of counts inside the dataset.

Definition at line 60 of file TRestExperiment.h.

◆ fExperimentalData

TRestDataSet TRestExperiment::fExperimentalData

private

It contains the experimental data (should contain same columns as the components)

Definition at line 48 of file TRestExperiment.h.

◆ fExperimentalDataSet

std::string TRestExperiment::fExperimentalDataSet = ""

private

It defines the filename used to load the dataset.

Definition at line 45 of file TRestExperiment.h.

◆ fExposureTime

Double_t TRestExperiment::fExposureTime = 0

private

The exposure time. If 0 it will be extracted from the tracking dataset (In us, standard REST unit)

Definition at line 36 of file TRestExperiment.h.

◆ fMockData

Bool_t TRestExperiment::fMockData = false

private

If enabled it means that the experimental data was MC-generated.

Definition at line 51 of file TRestExperiment.h.

◆ fRandom

TRandom3* TRestExperiment::fRandom = nullptr

private

Internal process random generator.

Definition at line 63 of file TRestExperiment.h.

◆ fSeed

UInt_t TRestExperiment::fSeed = 0

private

Seed used in random generator.

Definition at line 66 of file TRestExperiment.h.

◆ fSignal

TRestComponent* TRestExperiment::fSignal = nullptr

private

A pointer to the signal component.

Definition at line 42 of file TRestExperiment.h.

◆ fUseAverage

Bool_t TRestExperiment::fUseAverage = false

private

The mock dataset will be generated using the mean counts instead of a real MonteCarlo.

Definition at line 57 of file TRestExperiment.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestExperiment() [1/2]

◆ TRestExperiment() [2/2]

◆ ~TRestExperiment()

Member Function Documentation

◆ GenerateMockDataSet()

◆ GetBackground()

◆ GetExperimentalCounts()

◆ GetExperimentalDataFrame()

◆ GetExperimentalDataSet()

◆ GetExposureInSeconds()

◆ GetSignal()

◆ InitFromConfigFile()

◆ Initialize()

◆ IsDataReady()

◆ IsMockData()

◆ PrintExperimentalData()

◆ PrintMetadata()

◆ SetBackground()

◆ SetExperimentalDataSet()

◆ SetExposureInSeconds()

◆ SetSignal()

Field Documentation

◆ fBackground

◆ fDataReady

◆ fExperimentalCounts

◆ fExperimentalData

◆ fExperimentalDataSet

◆ fExposureTime

◆ fMockData

◆ fRandom

◆ fSeed

◆ fSignal

◆ fUseAverage