Detailed Description

This class is meant to perform the calibration of different runs.

TRestDataSetCalibration performs the calibration of a TRestDataSet, the calibration is performed over different peaks provided in the config file. The first peak provided in the config file should correspond to the maximum in the spectra. The expected position of the rest of the peaks are estimated with respect to the maximum.

A summary of the basic parameters is described below:

calObservable: Name of the observable to be calibrated
nBins: Number of bins for the calibration spectra
calibRange: Calibration range inside calObservable that will be used for the spectrum
dataSetName: Name of the dataSet to be calibrated
calibFile: Name of the calibration file to be used for the calibration parameters, if empty it performs the calibration over the dataSet provided.

The energy peaks to calibrate are given using peak metadata:

energy: Energy of the peak(s) to be calibrated in keV, note that the first peak should correspond to the maximum

The following metadata members are used as output after the fit:

calibPeaks: Position of the mean value of the peak after the fit using the same order as the energy peaks
fCalibFWHM: FWHM in percentage for the different peaks, using the same order as the energy peaks.

If an output file name is provided a new dataset will be generated with the corresponding metadata and calibration constants, while adding a new observable, calib_energy. In addition, the spectrum and the fit results will be stored in the output file.

Examples

RML example to calibrate a dataset with a peak at 5.89 keV

<TRestDataSetCalibration name="EnergyCalibration" verboseLevel="info">
   <peak energy="5.899" />
   <parameter name="calObservable" value="tckAna_MaxTrackEnergy"/>
   <parameter name="nBins" value="1024"/>
   <parameter name="calibRange" value="(0,20000)" />
   <parameter name="dataSetName" value="myDataSet.root"/>
</TRestDataSetCalibration>

Example to perform calibration over a calibration dataSet using restRoot:

[0] TRestDataSetCalibration cal ("calibration.rml");
[1] cal.SetDataSetName("myDataSet.root");
[2] cal.SetOutputFileName("myCalibratedDataSet.root");
[3] cal.Calibrate();

Example to perform calibration over a background dataSet using restRoot:

[0] TRestDataSetCalibration cal ("calibration.rml");
[1] cal.SetDataSetName("myBackgroundDataSet.root");
[2] cal.SetOutputFileName("myBackgroundCalibratedDataSet.root");
[3] cal.SetCalibrationFile("myCalibratedDataSet.root");
[4] cal.Calibrate();

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

History of developments:

2023-03: First implementation of TRestDataSetCalibration JuanAn Garcia

Author: : JuanAn Garcia e-mail: juana.nosp@m.ngp@.nosp@m.uniza.nosp@m.r.es

Definition at line 29 of file TRestDataSetCalibration.h.

#include <TRestDataSetCalibration.h>

Inheritance diagram for TRestDataSetCalibration:

Public Member Functions
void	Calibrate ()
	Performs the calibration of a given dataSet. If no calibration file is provided, it performs the gaussian fit to the different parameters provided in the config file. Otherwise, it takes the calibration constants from the provided calibration file. More...

	ClassDefOverride (TRestDataSetCalibration, 1)

auto	GetCalibFWHM () const

auto	GetCalibPeaks () const

std::string	GetCalObservable () const

double	GetIntercept () const

double	GetSlope () const

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

void	SetCalibrationFile (const std::string &calibFile)

void	SetDataSetName (const std::string &dSName)

void	SetOutputFileName (const std::string &outName)

	TRestDataSetCalibration ()
	Default constructor. More...

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

	~TRestDataSetCalibration ()
	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 Member Functions
void	InitFromConfigFile () override
	Function to initialize some variables from configfile, in case that the variable is not found in the rml it checks the input file pattern. More...

void	Initialize () override
	Function to initialize input/output event members and define the section name. More...

Private Attributes
std::string	fCalibFile = ""
	Name of the calibration file to be used. More...

std::vector< double >	fCalibFWHM
	Vector containing calibrated sigma in ADCs. More...

std::vector< double >	fCalibPeaks
	Vector containing calibrated peaks in ADCs. More...

TVector2	fCalibRange
	Range to be calibrated. More...

std::string	fCalObservable = ""
	Calibration variable to be used. More...

std::string	fDataSetName = ""
	Name of the dataSet inside the config file. More...

std::vector< double >	fEnergyPeaks
	Vector containing expected energy peaks in keV must be sorted. More...

Double_t	fIntercept = 0
	Intercept of the calibration fit. More...

Int_t	fNBins
	Number of bins used in the calibration. More...

std::string	fOutputFileName = ""
	Name of the output file. More...

Double_t	fSlope = 0
	Slope from the calibration fit. 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

◆ TRestDataSetCalibration() [1/2]

TRestDataSetCalibration::TRestDataSetCalibration ( )

Default constructor.

Definition at line 109 of file TRestDataSetCalibration.cxx.

◆ TRestDataSetCalibration() [2/2]

TRestDataSetCalibration::TRestDataSetCalibration	(	const char *	configFilename,
		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

configFilename	A const char* that defines the RML filename.
name	The name of the metadata section. It will be used to find the corresponding TRestDataSetCalibration section inside the RML.

Definition at line 125 of file TRestDataSetCalibration.cxx.

◆ ~TRestDataSetCalibration()

TRestDataSetCalibration::~TRestDataSetCalibration ( )

Default destructor.

Definition at line 136 of file TRestDataSetCalibration.cxx.

Member Function Documentation

◆ Calibrate()

void TRestDataSetCalibration::Calibrate ( )

Performs the calibration of a given dataSet. If no calibration file is provided, it performs the gaussian fit to the different parameters provided in the config file. Otherwise, it takes the calibration constants from the provided calibration file.

Definition at line 181 of file TRestDataSetCalibration.cxx.

◆ GetCalibFWHM()

auto TRestDataSetCalibration::GetCalibFWHM ( ) const

inline

Definition at line 77 of file TRestDataSetCalibration.h.

◆ GetCalibPeaks()

auto TRestDataSetCalibration::GetCalibPeaks ( ) const

inline

Definition at line 76 of file TRestDataSetCalibration.h.

◆ GetCalObservable()

std::string TRestDataSetCalibration::GetCalObservable ( ) const

inline

Definition at line 81 of file TRestDataSetCalibration.h.

◆ GetIntercept()

double TRestDataSetCalibration::GetIntercept ( ) const

inline

Definition at line 80 of file TRestDataSetCalibration.h.

◆ GetSlope()

double TRestDataSetCalibration::GetSlope ( ) const

inline

Definition at line 79 of file TRestDataSetCalibration.h.

◆ InitFromConfigFile()

void TRestDataSetCalibration::InitFromConfigFile ( )

overrideprivatevirtual

Function to initialize some variables from configfile, in case that the variable is not found in the rml it checks the input file pattern.

Reimplemented from TRestMetadata.

Definition at line 149 of file TRestDataSetCalibration.cxx.

◆ Initialize()

void TRestDataSetCalibration::Initialize ( )

overrideprivatevirtual

Function to initialize input/output event members and define the section name.

Reimplemented from TRestMetadata.

Definition at line 142 of file TRestDataSetCalibration.cxx.

◆ PrintMetadata()

void TRestDataSetCalibration::PrintMetadata ( )

overridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 275 of file TRestDataSetCalibration.cxx.

◆ SetCalibrationFile()

void TRestDataSetCalibration::SetCalibrationFile ( const std::string & calibFile )

inline

Definition at line 74 of file TRestDataSetCalibration.h.

◆ SetDataSetName()

void TRestDataSetCalibration::SetDataSetName ( const std::string & dSName )

inline

Definition at line 72 of file TRestDataSetCalibration.h.

◆ SetOutputFileName()

void TRestDataSetCalibration::SetOutputFileName ( const std::string & outName )

inline

Definition at line 73 of file TRestDataSetCalibration.h.

Field Documentation

◆ fCalibFile

std::string TRestDataSetCalibration::fCalibFile = ""

private

Name of the calibration file to be used.

Definition at line 47 of file TRestDataSetCalibration.h.

◆ fCalibFWHM

std::vector<double> TRestDataSetCalibration::fCalibFWHM

private

Vector containing calibrated sigma in ADCs.

Definition at line 44 of file TRestDataSetCalibration.h.

◆ fCalibPeaks

std::vector<double> TRestDataSetCalibration::fCalibPeaks

private

Vector containing calibrated peaks in ADCs.

Definition at line 41 of file TRestDataSetCalibration.h.

◆ fCalibRange

TVector2 TRestDataSetCalibration::fCalibRange

private

Range to be calibrated.

Definition at line 53 of file TRestDataSetCalibration.h.

◆ fCalObservable

std::string TRestDataSetCalibration::fCalObservable = ""

private

Calibration variable to be used.

Definition at line 50 of file TRestDataSetCalibration.h.

◆ fDataSetName

std::string TRestDataSetCalibration::fDataSetName = ""

private

Name of the dataSet inside the config file.

Definition at line 35 of file TRestDataSetCalibration.h.

◆ fEnergyPeaks

std::vector<double> TRestDataSetCalibration::fEnergyPeaks

private

Vector containing expected energy peaks in keV must be sorted.

Definition at line 38 of file TRestDataSetCalibration.h.

◆ fIntercept

Double_t TRestDataSetCalibration::fIntercept = 0

private

Intercept of the calibration fit.

Definition at line 62 of file TRestDataSetCalibration.h.

◆ fNBins

Int_t TRestDataSetCalibration::fNBins

private

Number of bins used in the calibration.

Definition at line 56 of file TRestDataSetCalibration.h.

◆ fOutputFileName

std::string TRestDataSetCalibration::fOutputFileName = ""

private

Name of the output file.

Definition at line 32 of file TRestDataSetCalibration.h.

◆ fSlope

Double_t TRestDataSetCalibration::fSlope = 0

private

Slope from the calibration fit.

Definition at line 59 of file TRestDataSetCalibration.h.

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

Detailed Description

Examples

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestDataSetCalibration() [1/2]

◆ TRestDataSetCalibration() [2/2]

◆ ~TRestDataSetCalibration()

Member Function Documentation

◆ Calibrate()

◆ GetCalibFWHM()

◆ GetCalibPeaks()

◆ GetCalObservable()

◆ GetIntercept()

◆ GetSlope()

◆ InitFromConfigFile()

◆ Initialize()

◆ PrintMetadata()

◆ SetCalibrationFile()

◆ SetDataSetName()

◆ SetOutputFileName()

Field Documentation

◆ fCalibFile

◆ fCalibFWHM

◆ fCalibPeaks

◆ fCalibRange

◆ fCalObservable

◆ fDataSetName

◆ fEnergyPeaks

◆ fIntercept

◆ fNBins

◆ fOutputFileName

◆ fSlope