Detailed Description

It defines a background/signal model distribution in a given parameter space (tipically x,y,en)

This class ...

<TRestComponentDataSet name="agSignal_vacuum">
<!-- We add here all the axion-photon coupling components -->
    <dataset filename="${DUST}/Dataset_BabyIAXO_XMM_mm_Vacuum.root" weight="1" />
    <variable name="final_posX" range="(-10,10)mm" bins="10" />
    <variable name="final_posY" range="(-10,10)mm" bins="10" />
    <variable name="final_energy" range="(0,10)keV" bins="20" />
    <parameter name="weights" value="{NGamma}"/>
    <parameter name="parameter" value="final_mass" />
    <parameter name="parameterizationNodes" value="" />
</TRestComponentDataSet>

restRoot
[0] TRestComponentDataSet comp("components.rml", "agSignal_vacuum");
[1] comp.LoadDataSets()
[2] TFile *f = TFile::Open("vacuumComponent.root", "RECREATE");
[3] comp.Write("agSignal_vacuum");

restRoot vacuumComponents.root
[0] TCanvas *c = agVacuum->DrawComponent( { "final_posX", "final_posY"}, {"final_energy"}, 2);
   [1] c->Print("component_hitmaps.png");

A 2-dimensional histogram scan versus the `final_energy` observable, generated by the DrawComponent method

restRoot vacuumComponents.root
[0] TCanvas *c = agVacuum->DrawComponent( { "final_energy"}, {"final_posX", "final_posY"}, 2);
   [1] c->Print("component_hitmaps.png");

In both cases each plot will regroup 2 bins.

A 1-dimensional histogram scan versus the `final_posX` and `final_posY` observables, generated by the DrawComponent method

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

History of developments:

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

#include <TRestComponentDataSet.h>

Inheritance diagram for TRestComponentDataSet:

Public Member Functions
	ClassDefOverride (TRestComponentDataSet, 1)

TCanvas *	DrawComponent (std::vector< std::string > drawVariables, std::vector< std::string > scanVariables, Int_t binScanSize=1, TString drawOption="")

THnD *	GetDensity ()

THnD *	GetDensityForActiveNode ()

THnD *	GetDensityForNode (Double_t value)

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

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.

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.

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.

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.

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.

Double_t	GetRate (std::vector< Double_t > point) override
	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	GetTotalRate () override
	This method integrates the rate to all the parameter space defined in the density function. The result will be returned in s-1.

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

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

Bool_t	IsDataSetLoaded ()
	This method should go to TRestComponentDataSet.

Bool_t	LoadDataSets ()
	A method responsible to import a list of TRestDataSet into fDataSet and check that the variables and weights defined by the user can be found inside the dataset.

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

void	PrintStatistics ()
	It prints out the statistics available for each parametric node.

	TRestComponentDataSet ()
	Default constructor.

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

	~TRestComponentDataSet ()
	Default destructor.

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

Int_t	GetActiveNode ()

Double_t	GetActiveNodeValue ()

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

void	PrintStatistics ()

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

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

	TRestComponent ()
	Default constructor.

	~TRestComponent ()
	Default destructor.

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

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

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.

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

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.

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.

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

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

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

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.

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

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

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

Int_t	GetVersionCode ()

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

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

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.

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)=delete

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

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

void	PrintMessageBuffer ()
	Print the buffered message.

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

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

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

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

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

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

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

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

	TRestMetadata (const TRestMetadata &)=delete

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

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

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

	~TRestMetadata ()
	TRestMetadata default destructor.

Protected Member Functions
std::vector< Int_t >	ExtractNodeStatistics ()
	It returns a vector with the number of entries found for each parameterization node. More...

std::vector< Double_t >	ExtractParameterizationNodes ()
	It returns a vector with all the different values found on the dataset column for the user given parameterization variable. More...

void	FillHistograms ()
	It will produce a histogram with the distribution defined using the variables and the weights for each of the parameter nodes.

Bool_t	VariablesOk ()
	It returns true if all variables have been found inside TRestDataSet.

Bool_t	WeightsOk ()
	It returns true if all weights have been found inside TRestDataSet.

Protected Member Functions inherited from TRestComponent
Int_t	GetVariableIndex (std::string varName)
	It returns the position of the fVariable element for the variable name given by argument.

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

Bool_t	ValidNode (Double_t node)
	It returns true if the node has been properly identified.

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.

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, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name".

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

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified 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.

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, std::string buffer)

std::string	GetKEYDefinition (std::string keyName, size_t &Position, 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, std::string buffer)

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

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

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

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::string	GetParameter (std::string parName, size_t &pos, std::string inputString)
	Returns the value for the parameter name parName found in inputString. 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.

TString	GetSearchPath ()

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

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.

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.

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.

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

	TRestMetadata ()
	TRestMetadata default constructor.

	TRestMetadata (const char *configFilename)
	constructor

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

Private Member Functions
Bool_t	ValidDataSet ()
	Takes care of initializing datasets if have not been initialized. On sucess it returns true.

Private Attributes
TRestDataSet	fDataSet
	The dataset used to initialize the distribution. More...

std::vector< std::string >	fDataSetFileNames
	The filename of the dataset used.

Bool_t	fDataSetLoaded = false
	It is true of the dataset was loaded without issues.

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

std::vector< Int_t >	fNSimPerNode
	It defines the number of entries for each parameterization node (Initialized by the dataset)

std::vector< std::string >	fWeights
	A list with the dataset columns used to weight the distribution density and define rate.

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.

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

endl_t	RESTendl
	Termination flag object for TRestStringOutput.

Constructor & Destructor Documentation

TRestComponentDataSet::TRestComponentDataSet	(	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 116 of file TRestComponentDataSet.cxx.

Member Function Documentation

TCanvas * TRestComponentDataSet::DrawComponent	(	std::vector< std::string >	drawVariables,
		std::vector< std::string >	scanVariables,
		Int_t	binScanSize = `1`,
		TString	drawOption = `""`
	)

Finding canvas division scheme

Definition at line 199 of file TRestComponentDataSet.cxx.

std::vector< Int_t > TRestComponentDataSet::ExtractNodeStatistics ( )

protected

It returns a vector with the number of entries found for each parameterization node.

If fNSimPerNode has already been initialized it will directly return its value.

Definition at line 628 of file TRestComponentDataSet.cxx.

std::vector< Double_t > TRestComponentDataSet::ExtractParameterizationNodes ( )

protected

It returns a vector with all the different values found on the dataset column for the user given parameterization variable.

If fParameterizationNodes has already been initialized it will directly return its value.

Definition at line 596 of file TRestComponentDataSet.cxx.

Double_t TRestComponentDataSet::GetRate ( std::vector< Double_t > point )

overridevirtual

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 density should be normalized to the corresponding parameter space. During the component construction, the user is responsible to initialize the component with the appropriate units. For example, if the parameter space is 2 spatial dimensions and 1 energy dimension, the contribution of each cell or event to the component will be expressed in mm-2 keV-1 which are the default units for distance and energy.

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

Implements TRestComponent.

Definition at line 150 of file TRestComponentDataSet.cxx.

Field Documentation

TRestDataSet TRestComponentDataSet::fDataSet

private

The dataset used to initialize the distribution.

TODO we need to define multiple datasets and weigth. The weight will be used to create a model, such as weighting different background contaminations or different signal coupling contributions. TODO Then we probably need here a std::vector <TRestDataSet> and another vector with the weights (isotope activity/flux/etc).

Definition at line 54 of file TRestComponentDataSet.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation