Detailed Description

It defines an analytical component model distribution in a given parameter space (tipically x,y,en)

This class allows to ...

<TRestComponentFormula name="DummyFormulaComponent">
        <variable name="final_posX" range="(-10,10)mm" bins="100" />
        <variable name="final_posY" range="(-1,1)cm" bins="100" />
        <variable name="final_energy" range="(0,10)keV" bins="20" />

        <parameter name="units" value="cm^-2*keV^-1" />

           // A spatial gaussian component contribution (energy normalized)
        <formula name="gaus" expression="1E-${REST_BCK_LEVEL} *

TMath::Exp(-[final_posX]*[final_posX]-[final_posY]*[final_posY])/(1+[final_energy])" /> // A flat contribution <formula name="flat" expression="1E-7" /> </TRestComponentFormula>

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

History of developments:

2023-December: First implementation of TRestComponentFormula 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 32 of file TRestComponentFormula.h.

#include <TRestComponentFormula.h>

Inheritance diagram for TRestComponentFormula:

Public Member Functions
	ClassDefOverride (TRestComponentFormula, 1)

Double_t	GetFormulaRate (std::vector< Double_t > point)
	It returns the intensity/rate (in seconds) corresponding to the formula evaluated at the position of the parameter space given by point and integrated to the parameter space cell volume. More...

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...

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

	TRestComponentFormula ()
	Default constructor. More...

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

	~TRestComponentFormula ()
	Default destructor. More...

Public Member Functions inherited from TRestComponent
	ClassDefOverride (TRestComponent, 6)

void	DisableInterpolation ()

TCanvas *	DrawComponent (std::vector< std::string > drawVariables, std::vector< std::string > scanVariables, Int_t binScanSize=1, TString drawOption="")
	A method allowing to draw a series of plots representing the density distributions. More...

void	EnableInterpolation ()

Int_t	FindActiveNode (Double_t node)
	It returns the position of the fParameterizationNodes element for the variable name given by argument. More...

Int_t	GetActiveNode ()

Double_t	GetActiveNodeValue ()

Double_t	GetAllNodesIntegratedRate ()
	This method returns the integrated total rate for all the nodes The result will be returned in s-1. More...

Double_t	GetBinCenter (Int_t nDim, const Int_t bin)
	It returns the bin center of the given component dimension. More...

THnD *	GetDensity ()

THnD *	GetDensityForActiveNode ()

THnD *	GetDensityForNode (Double_t value)

size_t	GetDimensions ()

TH1D *	GetHistogram (Double_t node, std::string varName)
	It returns a 1-dimensional projected histogram for the variable names provided in the argument. More...

TH2D *	GetHistogram (Double_t node, std::string varName1, std::string varName2)
	It returns the 2-dimensional projected histogram for the variable names provided in the argument. More...

TH3D *	GetHistogram (Double_t node, std::string varName1, std::string varName2, std::string varName3)
	It returns the 3-dimensional projected histogram for the variable names provided in the argument. More...

TH1D *	GetHistogram (std::string varName)
	It returns a 1-dimensional projected histogram for the variable names provided in the argument. It will recover the histogram corresponding to the active node. More...

TH2D *	GetHistogram (std::string varName1, std::string varName2)
	It returns a 2-dimensional projected histogram for the variable names provided in the argument. It will recover the histogram corresponding to the active node. More...

TH3D *	GetHistogram (std::string varName1, std::string varName2, std::string varName3)
	It returns a 3-dimensional projected histogram for the variable names provided in the argument. It will recover the histogram corresponding to the active node. More...

Double_t	GetMaxRate ()
	This method returns the total rate for the node that has the highest contribution The result will be returned in s-1. More...

ROOT::RDF::RNode	GetMonteCarloDataFrame (Int_t N=100)

std::string	GetNature () const

std::vector< Int_t >	GetNbins () const

Double_t	GetNormalizedRate (std::vector< Double_t > point)
	It returns the intensity/rate (in seconds) corresponding to the generated distribution or formula evaluated at the position of the parameter space given by point. More...

std::vector< Double_t >	GetParameterizationNodes ()

Float_t	GetPrecision ()

ROOT::RVecD	GetRandom ()

std::vector< TVector2 >	GetRanges () const

Double_t	GetRate (std::vector< Double_t > point)
	It returns the intensity/rate (in seconds) corresponding to the generated distribution or formula evaluated at the position of the parameter space given by point. More...

Double_t	GetRawRate (std::vector< Double_t > point)
	It returns the intensity/rate (in seconds) corresponding to the generated distribution or formula evaluated at the position of the parameter space given by point. The returned rate is integrated to the granularity of the parameter space (cell size). To get a normalized rate use TRestComponent::GetNormalizedRate. More...

TRestResponse *	GetResponse () const

Int_t	GetSamples ()

Double_t	GetTotalRate ()
	This method integrates the rate to all the parameter space defined in the density function. The result will be returned in s-1. More...

std::vector< std::string >	GetVariables () const

Bool_t	HasNodes ()
	It returns true if any nodes have been defined. More...

void	Initialize () override
	It initializes the random number. We avoid to define the section name here since we will never define a TRestComponent section in our RML file, since this class is pure virtual. It will be the inherited class the responsible to define the section name. More...

Bool_t	Interpolation ()

void	LoadResponse (const TRestResponse &resp)

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

void	PrintNodes ()
	It prints out on screen the values of the parametric node. More...

void	PrintStatistics ()

virtual void	RegenerateActiveNodeDensity ()

void	RegenerateHistograms (UInt_t seed=0)
	It will produce a histogram with the distribution defined using the variables and the weights for each of the parameter nodes. More...

void	RegenerateParametricNodes (Double_t from, Double_t to, Double_t step, Bool_t expIncrease=false)
	It allows to produce a parameter nodes list providing the initial value, the final value and the step. We might chose the step growing in linear increase steps or exponential. Linear is the default value. More...

Int_t	SetActiveNode (Double_t node)
	It returns the position of the fParameterizationNodes element for the variable name given by argument. More...

Int_t	SetActiveNode (Int_t n)

void	SetPrecision (const Float_t &pr)

void	SetSamples (Int_t samples)

	TRestComponent ()
	Default constructor. More...

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

	~TRestComponent ()
	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	FillHistograms () override
	It will produce a histogram with the distribution using the formula contributions. More...

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

Protected Member Functions inherited from TRestComponent
virtual void	FillHistograms ()=0

Int_t	GetVariableIndex (std::string varName)
	It returns the position of the fVariable element for the variable name given by argument. More...

Bool_t	HasDensity ()

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

Bool_t	ValidNode (Double_t node)
	It returns true if the node has been properly identified. 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
std::vector< TFormula >	fFormulas
	A vector of formulas that will be added up to integrate a given rate. More...

std::string	fFormulaUnits = "cm^-2*keV^-1"
	The formulas should be expressed in the following units. More...

Additional Inherited Members
Protected Attributes inherited from TRestComponent
Int_t	fActiveNode = -1
	It is used to define the node that will be accessed for rate retrieval. More...

TCanvas *	fCanvas = nullptr
	A canvas for drawing the active node component. More...

Bool_t	fExponential = false
	It true the parametric values automatically generated will grow exponentially. More...

Double_t	fFirstParameterValue = 0
	It defines the first parametric node value in case of automatic parameter generation. More...

Bool_t	fInterpolation = true
	Enables or disables the interpolation at TRestComponentDataSet::GetRawRate. More...

Double_t	fLastParameterValue = 0
	It defines the upper limit for the automatic parametric node values generation. More...

std::string	fNature = "unknown"
	It defines the component type (unknown/signal/background) More...

std::vector< Int_t >	fNbins
	The number of bins in which we should divide each variable. More...

std::vector< THnD * >	fNodeDensity
	The generated N-dimensional variable space density for a given node. More...

std::string	fParameter = ""
	It is used to parameterize a set of distribution densities (e.g. WIMP or axion mass) More...

std::vector< Double_t >	fParameterizationNodes
	It defines the nodes of the parameterization (Initialized by the dataset) More...

Float_t	fPrecision = 0.01
	A precision used to select the node value with a given range defined as a fraction of the value. More...

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

std::vector< TVector2 >	fRanges
	The range of each of the variables used to create the PDF distribution. More...

TRestResponse *	fResponse = nullptr
	A pointer to the detector response. More...

Int_t	fSamples = 0
	It introduces a fixed number of samples (if 0 it will take all available samples) More...

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

Double_t	fStepParameterValue = 0
	It defines the increasing step for automatic parameter list generation. More...

std::vector< std::string >	fVariables
	A list with the branches that will be used to create the distribution space. More...

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

◆ TRestComponentFormula() [1/2]

TRestComponentFormula::TRestComponentFormula	(	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 82 of file TRestComponentFormula.cxx.

◆ TRestComponentFormula() [2/2]

TRestComponentFormula::TRestComponentFormula ( )

Default constructor.

Definition at line 66 of file TRestComponentFormula.cxx.

◆ ~TRestComponentFormula()

TRestComponentFormula::~TRestComponentFormula ( )

Default destructor.

Definition at line 94 of file TRestComponentFormula.cxx.

Member Function Documentation

◆ FillHistograms()

void TRestComponentFormula::FillHistograms ( )

overrideprotectedvirtual

It will produce a histogram with the distribution using the formula contributions.

For the moment this method will just fill one node (without fParameter). But if the component expression depends on the node parameter it might require further development.

TODO: The histogram is filled just by evaluating the formula, but it would be more realistic that we fill the histograms with a number N of entries that mimic a MC generation scheme similar to TRestComponentDataSet.

Implements TRestComponent.

Definition at line 149 of file TRestComponentFormula.cxx.

◆ GetFormulaRate()

Double_t TRestComponentFormula::GetFormulaRate ( std::vector< Double_t > point )

It returns the intensity/rate (in seconds) corresponding to the formula evaluated at the position of the parameter space given by point and integrated to the parameter space cell volume.

The size of the point vector must have the same dimension as the dimensions of the variables of the distribution.

Definition at line 116 of file TRestComponentFormula.cxx.

◆ InitFromConfigFile()

void TRestComponentFormula::InitFromConfigFile ( )

overrideprotectedvirtual

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

For some reason I need to do this manually. Dont understand why!

Reimplemented from TRestComponent.

Definition at line 235 of file TRestComponentFormula.cxx.

◆ Initialize()

void TRestComponentFormula::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 TRestComponent.

Definition at line 100 of file TRestComponentFormula.cxx.

◆ PrintMetadata()

void TRestComponentFormula::PrintMetadata ( )

overridevirtual

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

Reimplemented from TRestComponent.

Definition at line 213 of file TRestComponentFormula.cxx.

Field Documentation

◆ fFormulas

std::vector<TFormula> TRestComponentFormula::fFormulas

private

A vector of formulas that will be added up to integrate a given rate.

Definition at line 35 of file TRestComponentFormula.h.

◆ fFormulaUnits

std::string TRestComponentFormula::fFormulaUnits = "cm^-2*keV^-1"

private

The formulas should be expressed in the following units.

Definition at line 38 of file TRestComponentFormula.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

◆ TRestComponentFormula() [1/2]

◆ TRestComponentFormula() [2/2]

◆ ~TRestComponentFormula()

Member Function Documentation

◆ FillHistograms()

◆ GetFormulaRate()

◆ InitFromConfigFile()

◆ Initialize()

◆ PrintMetadata()

Field Documentation

◆ fFormulas

◆ fFormulaUnits