Detailed Description

A response matrix that might be applied to a given component inside a TRestComponent.

Documentation TOBE written

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

History of developments:

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

#include <TRestResponse.h>

Inheritance diagram for TRestResponse:

Public Member Functions
Bool_t	ApplyInterpolation ()

	ClassDefOverride (TRestResponse, 1)

Double_t	GetBinSize () const

TVector2	GetInputRange () const

std::vector< std::vector< Float_t > >	GetMatrix () const

TVector2	GetOrigin () const

TVector2	GetOutputRange () const

std::vector< std::pair< Double_t, Double_t > >	GetResponse (Double_t input)
	This method will return a vector of std::pair, each pair will contain the output energy together with the corresponding response (or efficiency), for the given input energy. More...

std::string	GetResponseFilename () const

std::string	GetVariable () 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...

void	Interpolate (Bool_t interpolate=true)

void	LoadResponse (Bool_t transpose=true)
	It loads into the fResponseMatrix data member the response from a file. More...

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

void	PrintResponseMatrix (Int_t fromRow, Int_t toRow)
	Prints on screen the information about the metadata members of TRestAxionSolarFlux. More...

void	SetBinSize (Double_t bSize)

void	SetOrigin (const TVector2 &v)

void	SetResponseFilename (std::string responseFile)

void	SetVariable (const std::string &var)

	TRestResponse ()
	Default constructor. More...

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

	~TRestResponse ()
	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...

Private Attributes
Double_t	fBinSize = 0.1
	The resolution of the response matrix (binning) More...

std::string	fFilename = ""
	The filename used to import the response matrix. More...

Bool_t	fInterpolation = false
	It allows to decide if the returned response should be interpolated (default:false) More...

TVector2	fOrigin = TVector2(0, 0)
	First element of the response matrix (input/incident, output/detected) More...

std::vector< std::vector< Float_t > >	fResponseMatrix
	The response matrix. More...

Bool_t	fTransposed = false
	Determines if the response matrix has been transposed. More...

std::string	fVariable = ""
	It defines the variable name for which the response should be applied to. More...

Additional Inherited Members
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...

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

◆ TRestResponse() [1/2]

TRestResponse::TRestResponse	(	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 64 of file TRestResponse.cxx.

◆ TRestResponse() [2/2]

TRestResponse::TRestResponse ( )

Default constructor.

Definition at line 48 of file TRestResponse.cxx.

◆ ~TRestResponse()

TRestResponse::~TRestResponse ( )

Default destructor.

Definition at line 75 of file TRestResponse.cxx.

Member Function Documentation

◆ ApplyInterpolation()

Bool_t TRestResponse::ApplyInterpolation ( )

inline

Definition at line 58 of file TRestResponse.h.

◆ GetBinSize()

Double_t TRestResponse::GetBinSize ( ) const

inline

Definition at line 61 of file TRestResponse.h.

◆ GetInputRange()

TVector2 TRestResponse::GetInputRange ( ) const

inline

Definition at line 66 of file TRestResponse.h.

◆ GetMatrix()

std::vector< std::vector< Float_t > > TRestResponse::GetMatrix ( ) const

inline

Definition at line 84 of file TRestResponse.h.

◆ GetOrigin()

TVector2 TRestResponse::GetOrigin ( ) const

inline

Definition at line 63 of file TRestResponse.h.

◆ GetOutputRange()

TVector2 TRestResponse::GetOutputRange ( ) const

inline

Definition at line 70 of file TRestResponse.h.

◆ GetResponse()

std::vector< std::pair< Double_t, Double_t > > TRestResponse::GetResponse ( Double_t input )

This method will return a vector of std::pair, each pair will contain the output energy together with the corresponding response (or efficiency), for the given input energy.

The output value will be mapped following the binning and the origin given on the metadata members.

Definition at line 140 of file TRestResponse.cxx.

◆ GetResponseFilename()

std::string TRestResponse::GetResponseFilename ( ) const

inline

Definition at line 62 of file TRestResponse.h.

◆ GetVariable()

std::string TRestResponse::GetVariable ( ) const

inline

Definition at line 64 of file TRestResponse.h.

◆ Initialize()

void TRestResponse::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 81 of file TRestResponse.cxx.

◆ Interpolate()

void TRestResponse::Interpolate ( Bool_t interpolate = true )

inline

Definition at line 59 of file TRestResponse.h.

◆ LoadResponse()

void TRestResponse::LoadResponse ( Bool_t transpose = true )

It loads into the fResponseMatrix data member the response from a file.

For the moment only binary data files with format .N???f have been implemented.

The response file should be arranged in a way that the more internal std::vector (row) inside the std::vector <std::vector> table corresponds to a specific transformed energy (output). For example, if we have the incident particle energy (input) and the expected detected energy response (output) for that energy, then each row in the matrix corresponds to a detected energy and each element of that row defines the fraction of incident energies that contributed to that detected energy.

Thats why we may need to transpose the matrix, so that when we can extract a row (detected energy) from the matrix directly, such as fMatrix[n], and we just get the vector that should convolute with the Signal(Ei) that is a vector of signals as a function of incident energy. The resulting scalar product will give the expected signal at the detection energy.

Definition at line 102 of file TRestResponse.cxx.

◆ PrintMetadata()

void TRestResponse::PrintMetadata ( )

overridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 215 of file TRestResponse.cxx.

◆ PrintResponseMatrix()

void TRestResponse::PrintResponseMatrix	(	Int_t	fromRow = `0`,
		Int_t	toRow = `0`
	)

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

Definition at line 208 of file TRestResponse.cxx.

◆ SetBinSize()

void TRestResponse::SetBinSize ( Double_t bSize )

inline

Definition at line 53 of file TRestResponse.h.

◆ SetOrigin()

void TRestResponse::SetOrigin ( const TVector2 & v )

inline

Definition at line 55 of file TRestResponse.h.

◆ SetResponseFilename()

void TRestResponse::SetResponseFilename ( std::string responseFile )

inline

Definition at line 54 of file TRestResponse.h.

◆ SetVariable()

void TRestResponse::SetVariable ( const std::string & var )

inline

Definition at line 56 of file TRestResponse.h.

Field Documentation

◆ fBinSize

Double_t TRestResponse::fBinSize = 0.1

private

The resolution of the response matrix (binning)

Definition at line 41 of file TRestResponse.h.

◆ fFilename

std::string TRestResponse::fFilename = ""

private

The filename used to import the response matrix.

Definition at line 32 of file TRestResponse.h.

◆ fInterpolation

Bool_t TRestResponse::fInterpolation = false

private

It allows to decide if the returned response should be interpolated (default:false)

Definition at line 50 of file TRestResponse.h.

◆ fOrigin

TVector2 TRestResponse::fOrigin = TVector2(0, 0)

private

First element of the response matrix (input/incident, output/detected)

Definition at line 38 of file TRestResponse.h.

◆ fResponseMatrix

std::vector<std::vector<Float_t> > TRestResponse::fResponseMatrix

private

The response matrix.

Definition at line 44 of file TRestResponse.h.

◆ fTransposed

Bool_t TRestResponse::fTransposed = false

private

Determines if the response matrix has been transposed.

Definition at line 47 of file TRestResponse.h.

◆ fVariable

std::string TRestResponse::fVariable = ""

private

It defines the variable name for which the response should be applied to.

Definition at line 35 of file TRestResponse.h.

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

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestResponse() [1/2]

◆ TRestResponse() [2/2]

◆ ~TRestResponse()

Member Function Documentation

◆ ApplyInterpolation()

◆ GetBinSize()

◆ GetInputRange()

◆ GetMatrix()

◆ GetOrigin()

◆ GetOutputRange()

◆ GetResponse()

◆ GetResponseFilename()

◆ GetVariable()

◆ Initialize()

◆ Interpolate()

◆ LoadResponse()

◆ PrintMetadata()

◆ PrintResponseMatrix()

◆ SetBinSize()

◆ SetOrigin()

◆ SetResponseFilename()

◆ SetVariable()

Field Documentation

◆ fBinSize

◆ fFilename

◆ fInterpolation

◆ fOrigin

◆ fResponseMatrix

◆ fTransposed

◆ fVariable