Detailed Description

Container class for WIMP metadata

TRestWimpSensitivity is the main class used to generate senstitivity prospects for WIMP searches experiments. It requires different inputs from an rml file to define different paramented such as the target elements, WIMP density, velocity distributions of the WIMPs in the lab reference frame, exposure, background level, energy spectra for the nuclear recoil, energy range for the sensitivity derivation and the use of the quenching factor.

#RML definition

addElement : Add an element to the target material, at least one element should be present with the following parameters:
nucleusName : Name of the nucleus to add
anum : Atomic number of the nucleus
znum : Number of protons in the nucleus
abundance : Mass percentage of the nucleus in the target material.
wimpDensity : WIMP density in the DM halo in GeV/cm3
labVelocity : WIMP velocity in the lab (Earth) frame reference in km/s
escapeVelocity : WIMP escape velocity (km/s)
rmsVelocity : WIMP RMS velocity (km/s)
exposure : Detector exposure in kg*day
backgroundLevel : Detector background level in c/keV/day
energySpectra : Energy range for the recoil spectra in keV
energySpectraStep : Energy step for the recoil spectra in keV
energyRange : Energy range for the sensitivity prospects in keV
useQuenchingFactor : Use or not quenching factor The following example illustrates the definition of the common WIMP parameters for a Ne+Isobutane mixture at 98% in volume.

<TRestWimpSensitivity name="WIMPSensitivity" title="WIMP Sensitivity" verboseLevel="info">
    <addElement nucleusName="Ne" anum="20.1797" znum="10" abundance="0.95" />
    <addElement nucleusName="C" anum="12.0107" znum="6" abundance="0.04" />
    <addElement nucleusName="H" anum="1.00784" znum="1" abundance="0.01" />
    <parameter name="wimpDensity" value="0.3" />
    <parameter name="labVelocity" value="232"/>
    <parameter name="rmsVelocity" value="220"/>
    <parameter name="escapeVelocity" value="544"/>
    <parameter name="exposure" value="116.8"/>
    <parameter name="backgroundLevel" value="1"/>
    <parameter name="energySpectra" value="(0,2)"/>
    <parameter name="energySpectraStep" value="0.01"/>
    <parameter name="energyRange" value="(0.1,1.1)"/>
    <parameter name="useQuenchingFactor" value="true"/>
</TRestWimpSensitivity>

Besides target material elements, the other parameters are optional, and if not provided they will take their default values.

/// ### Using this class

Once we have created an instance of this class we will be able to access the different parameters to derive the WIMP sensitivity.

For example, the following code will perform the derivation of the WIMP sensitivity for a given rml file.

TRestWimpSensitivity WS("wimp.rml");
WS.PrintMetadata();
double wimpMass = 0.25; //GeV
const double sensitivity = WS.GetSensitivity(wimpMass);
  if(sensitivity > 0 ){
    std::cout<<"WIMP mass "<<wimpMass<<" Sensitivity "<<sens<< " cm-2"<<std::endl;
  } else {
    std::cout<<"Cannot provide sensititivy with this configuration try to
    incresase the WIMP mass"<<std::endl;
  }

This will return the expected sensitivity for the rml file used above for a WIMP mass of 0.25 GeV.

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

History of developments:

2022-October First implementation JuanAn Garcia

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

Definition at line 33 of file TRestWimpSensitivity.h.

#include <TRestWimpSensitivity.h>

Inheritance diagram for TRestWimpSensitivity:

Public Member Functions
const std::string	BuildOutputFileName (const std::string &extension=".txt")
	Return output file format with different parameters used in the calculation.

void	CalculateQuenchingFactor ()
	Calculate Quenching factor and stores in a map.

	ClassDefOverride (TRestWimpSensitivity, 1)

std::map< std::string, TH1D * >	GetFormFactor ()
	Return a map of histograms with the Form Factor of the different elements.

auto	GetQuenchingFactor ()

std::map< std::string, TH1D * >	GetRecoilSpectra (const double wimpMass, const double crossSection)
	Get recoil spectra for a given WIMP mass and cross section.

const Double_t	GetSensitivity (const double wimpMass)
	Get sensitivity for a give WIMP mass.

void	InitFromConfigFile () override
	Initialization of TRestWimpSensitivity members through a RML file.

void	Initialize () override
	Initialization of TRestWimpSensitivity members.

void	PrintMetadata () override
	Prints on screen the details about WIMP parameters, stored in TRestWimpSensitivity.

void	ReadNuclei ()
	Initialization of TRestWimpSensitivity members through a RML file.

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

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

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

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.

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.

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

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

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.

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.

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.

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

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

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

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 &)

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

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

void	PrintMessageBuffer ()
	Print the buffered message.

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

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 &)

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.

Private Attributes
Double_t	fBackground = 1
	Detector background level in c/keV/day.

TVector2	fEnergyRange = TVector2(0.1, 1.1)
	Energy range for the sensitivity prospects in keV.

TVector2	fEnergySpectra = TVector2(0, 2)
	Energy range for the recoil spectra in keV.

Double_t	fEnergySpectraStep = 0.01
	Energy step for the recoil spectra in keV.

Double_t	fEscapeVelocity = 544
	WIMP escape velocity (km/s)

Double_t	fExposure = 365. * 0.32
	Detector exposure in kg*day.

Double_t	fLabVelocity = 232
	WIMP velocity in the lab (Earth) frame reference in km/s.

std::vector< TRestWimpNucleus >	fNuclei
	A vector containing TRestWimpNucleus with different nucleus parameters.

Double_t	fRmsVelocity = 220
	WIMP RMS velocity (km/s)

Bool_t	fUseQuenchingFactor = true
	Use or not quenching factor.

Double_t	fWimpDensity = 0.3
	WIMP density in GeV/cm3.

std::map< std::string, TH1D * >	quenchingFactor
	Map containing quenching factor for a nucleus.

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

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.

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

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

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

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

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.

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.

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

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.

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.

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.

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

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.

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

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.

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

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

	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.

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.

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

◆ TRestWimpSensitivity()

TRestWimpSensitivity::TRestWimpSensitivity	(	const char *	configFilename,
		const std::string &	name = `""`
	)

Constructor loading data from a config file.

Parameters

configFilename	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 TRestWimpSensitivity section inside the RML.

Definition at line 128 of file src/TRestWimpSensitivity.cxx.

◆ ~TRestWimpSensitivity()

TRestWimpSensitivity::~TRestWimpSensitivity ( )

Default destructor.

Definition at line 137 of file src/TRestWimpSensitivity.cxx.

Member Function Documentation

◆ BuildOutputFileName()

const std::string TRestWimpSensitivity::BuildOutputFileName ( const std::string & extension = ".txt" )

Return output file format with different parameters used in the calculation.

Definition at line 302 of file src/TRestWimpSensitivity.cxx.

◆ CalculateQuenchingFactor()

void TRestWimpSensitivity::CalculateQuenchingFactor ( )

Calculate Quenching factor and stores in a map.

Definition at line 275 of file src/TRestWimpSensitivity.cxx.

◆ GetFormFactor()

std::map< std::string, TH1D * > TRestWimpSensitivity::GetFormFactor ( )

Return a map of histograms with the Form Factor of the different elements.

Definition at line 330 of file src/TRestWimpSensitivity.cxx.

◆ GetQuenchingFactor()

auto TRestWimpSensitivity::GetQuenchingFactor ( )

inline

Definition at line 78 of file TRestWimpSensitivity.h.

◆ GetRecoilSpectra()

std::map< std::string, TH1D * > TRestWimpSensitivity::GetRecoilSpectra	(	const double	wimpMass,
		const double	crossSection
	)

Get recoil spectra for a given WIMP mass and cross section.

Definition at line 180 of file src/TRestWimpSensitivity.cxx.

◆ GetSensitivity()

const Double_t TRestWimpSensitivity::GetSensitivity ( const double wimpMass )

Get sensitivity for a give WIMP mass.

Definition at line 206 of file src/TRestWimpSensitivity.cxx.

◆ InitFromConfigFile()

void TRestWimpSensitivity::InitFromConfigFile ( )

overridevirtual

Initialization of TRestWimpSensitivity members through a RML file.

Reimplemented from TRestMetadata.

Definition at line 151 of file src/TRestWimpSensitivity.cxx.

◆ Initialize()

void TRestWimpSensitivity::Initialize ( )

overridevirtual

Initialization of TRestWimpSensitivity members.

Reimplemented from TRestMetadata.

Definition at line 142 of file src/TRestWimpSensitivity.cxx.

◆ PrintMetadata()

void TRestWimpSensitivity::PrintMetadata ( )

overridevirtual

Prints on screen the details about WIMP parameters, stored in TRestWimpSensitivity.

Reimplemented from TRestMetadata.

Definition at line 354 of file src/TRestWimpSensitivity.cxx.

◆ ReadNuclei()

void TRestWimpSensitivity::ReadNuclei ( )

Initialization of TRestWimpSensitivity members through a RML file.

Definition at line 161 of file src/TRestWimpSensitivity.cxx.

Field Documentation

◆ fBackground

Double_t TRestWimpSensitivity::fBackground = 1

private

Detector background level in c/keV/day.

Definition at line 48 of file TRestWimpSensitivity.h.

◆ fEnergyRange

TVector2 TRestWimpSensitivity::fEnergyRange = TVector2(0.1, 1.1)

private

Energy range for the sensitivity prospects in keV.

Definition at line 55 of file TRestWimpSensitivity.h.

◆ fEnergySpectra

TVector2 TRestWimpSensitivity::fEnergySpectra = TVector2(0, 2)

private

Energy range for the recoil spectra in keV.

Definition at line 51 of file TRestWimpSensitivity.h.

◆ fEnergySpectraStep

Double_t TRestWimpSensitivity::fEnergySpectraStep = 0.01

private

Energy step for the recoil spectra in keV.

Definition at line 53 of file TRestWimpSensitivity.h.

◆ fEscapeVelocity

Double_t TRestWimpSensitivity::fEscapeVelocity = 544

private

WIMP escape velocity (km/s)

Definition at line 42 of file TRestWimpSensitivity.h.

◆ fExposure

Double_t TRestWimpSensitivity::fExposure = 365. * 0.32

private

Detector exposure in kg*day.

Definition at line 46 of file TRestWimpSensitivity.h.

◆ fLabVelocity

Double_t TRestWimpSensitivity::fLabVelocity = 232

private

WIMP velocity in the lab (Earth) frame reference in km/s.

Definition at line 40 of file TRestWimpSensitivity.h.

◆ fNuclei

std::vector<TRestWimpNucleus> TRestWimpSensitivity::fNuclei

private

A vector containing TRestWimpNucleus with different nucleus parameters.

Definition at line 36 of file TRestWimpSensitivity.h.

◆ fRmsVelocity

Double_t TRestWimpSensitivity::fRmsVelocity = 220

private

WIMP RMS velocity (km/s)

Definition at line 44 of file TRestWimpSensitivity.h.

◆ fUseQuenchingFactor

Bool_t TRestWimpSensitivity::fUseQuenchingFactor = true

private

Use or not quenching factor.

Definition at line 57 of file TRestWimpSensitivity.h.

◆ fWimpDensity

Double_t TRestWimpSensitivity::fWimpDensity = 0.3

private

WIMP density in GeV/cm3.

Definition at line 38 of file TRestWimpSensitivity.h.

◆ quenchingFactor

std::map<std::string, TH1D*> TRestWimpSensitivity::quenchingFactor

private

Map containing quenching factor for a nucleus.

Definition at line 60 of file TRestWimpSensitivity.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

◆ TRestWimpSensitivity()

◆ ~TRestWimpSensitivity()

Member Function Documentation

◆ BuildOutputFileName()

◆ CalculateQuenchingFactor()

◆ GetFormFactor()

◆ GetQuenchingFactor()

◆ GetRecoilSpectra()

◆ GetSensitivity()

◆ InitFromConfigFile()

◆ Initialize()

◆ PrintMetadata()

◆ ReadNuclei()

Field Documentation

◆ fBackground

◆ fEnergyRange

◆ fEnergySpectra

◆ fEnergySpectraStep

◆ fEscapeVelocity

◆ fExposure

◆ fLabVelocity

◆ fNuclei

◆ fRmsVelocity

◆ fUseQuenchingFactor

◆ fWimpDensity

◆ quenchingFactor