Detailed Description

A metadata class to load tabulated solar axion fluxes.

TRestAxionSolarFlux encapsulates common metadata members and methods that can be later used as a common way to evaluate the axion solar flux from different implementations.

At present, two different implemenations exist: TRestAxionSolarQCDFlux and TRestAxionSolarHiddenPhotonFlux.

Common metadata members defined by this class

In order to trace the nature and intensity of the coupling in future ray-tracking results we need to define the parameters couplingType and couplingStrength. The ray-tracing processing will be done for different coupling components in different event processing chains that will be combined in a final sensitivity plot.

couplingType: A string describing the coupling type, i.e. g_ag, g_ae, g_an, ...
couplingStrength: The intensity of the coupling used to calculate the values given in the solar flux tables.

Pre-generated solar axion flux tables

Some tables will be available at the axionlib-data repository. The different RML flux definitions used to load those tables will be found at the fluxes.rml file found at the axionlib-data repository.

Inside a local REST installation, the fluxes.rml file will be found at the REST installation directory, and it will be located automatically by the TRestMetadata::SearchFile method when initializing a TRestAxionSolarFlux class.

Re-implementing a specific TRestAxionSolarXYZFlux class

Different pure virtual methods must be re-implemented in the inherited class:

IntegratedFluxInRange: It should return a double value with the total integrated flux in cm-2 s-1 for a given energy range.
GetTotalFlux: It should return the total flux in cm-2 s-1
GetRandomEnergyAndRadius: It should return a random (energy,radius) sample based on the flux distribution initialized.
LoadTables: It is called by TRestAxionSolarFlux::Initialize to allow the inherited class to load all the necessary tables in memory.
GetEnergySpectrum: It should return a TH1F pointer with a energy spectrum histogram.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2022-February: Recovered from original TRestAxionSolarModel implementation Javier Galan 2023-May: This class has been transformed into a pure abstract class

Author: Javier Galan

Definition at line 33 of file TRestAxionSolarFlux.h.

#include <TRestAxionSolarFlux.h>

Inheritance diagram for TRestAxionSolarFlux:

Public Member Functions
Bool_t	AreTablesLoaded ()

TCanvas *	DrawFluxFile (std::string fname, Double_t binSize=0.01)
	It draws the contents of a .flux file. This method just receives the name of the .flux file and it works stand-alone. More...

virtual TCanvas *	DrawSolarFlux ()
	It draws the contents of a .flux file. This method just receives the. More...

virtual void	ExportTables (Bool_t ascii=false)

virtual TH1F *	GetEnergySpectrum (Double_t m=0)=0
	It returns an energy integrated spectrum in cm-2 s-1 keV-1. More...

TH1F *	GetFluxHistogram (std::string fname, Double_t binSize=0.01)
	It builds a histogram using the contents of the .flux file given in the argument. More...

virtual std::pair< Double_t, Double_t >	GetRandomEnergyAndRadius (TVector2 eRange=TVector2(-1, -1), Double_t mass=0)=0
	It defines how to generate Monte Carlo energy and radius values to reproduce the flux. More...

virtual Double_t	GetTotalFlux (Double_t mass=0)=0
	It returns the total integrated flux at earth in cm-2 s-1. More...

void	Initialize ()
	It is required in order to load solar flux tables into memory. More...

virtual Double_t	IntegrateFluxInRange (TVector2 eRange=TVector2(-1, -1), Double_t mass=0)=0
	It returns the integrated flux at earth in cm-2 s-1 for the given energy range. More...

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

	~TRestAxionSolarFlux ()
	Default destructor. More...

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

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

TVector2	Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1))

TString	GetCommit ()
	Returns the REST commit value stored in fCommit. More...

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

std::string	GetDataMemberValue (std::string memberName)
	Get the value of data member as string. More...

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

TString	GetDataPath ()
	Returns a std::string with the path used for data storage. More...

Double_t	GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL)
	Gets the value of the parameter name parName, after applying unit conversion. More...

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

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

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

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

Int_t	GetNumberOfErrors () const

Int_t	GetNumberOfWarnings () const

std::string	GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns corresponding REST Metadata parameter from multiple sources. More...

std::string	GetSectionName ()
	Returns the section name of this class, defined at the beginning of fSectionName. More...

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

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

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

Int_t	GetVersionCode ()

UInt_t	GetVersionMajor () const

UInt_t	GetVersionMinor () const

UInt_t	GetVersionPatch () const

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

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

virtual void	Initialize ()
	Making default settings. More...

TRestMetadata *	InstantiateChildMetadata (int index, std::string pattern="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `index` given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More...

TRestMetadata *	InstantiateChildMetadata (std::string pattern="", std::string name="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `name` given by argument. More...

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

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

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

Int_t	LoadConfigFromFile (const std::string &configFilename, const std::string &sectionName="")
	Give the file name, find out the corresponding section. Then call the main starter. More...

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)

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

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

void	PrintMessageBuffer ()
	Print the buffered message. More...

virtual void	PrintMetadata ()
	Implemented it in the derived metadata class to print out specific metadata information. More...

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

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

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

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

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

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

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

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

	TRestMetadata (const TRestMetadata &)

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

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

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

	~TRestMetadata ()
	TRestMetadata default destructor. More...

Protected Member Functions
virtual Bool_t	LoadTables ()=0
	It defines how to read the solar tables at the inhereted class. More...

	TRestAxionSolarFlux ()
	Default constructor. More...

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

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

TVector2	Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1))

Double_t	GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL)

TiXmlElement *	GetElement (std::string eleDeclare, TiXmlElement *e=nullptr)
	Get an xml element from a given parent element, according to its declaration. More...

TiXmlElement *	GetElementFromFile (std::string configFilename, std::string NameOrDecalre="")
	Open an xml encoded file and find its element. More...

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

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name". More...

std::string	GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0)
	Gets field value in an xml element string by parsing it as TiXmlElement. More...

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified name. More...

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

std::string	GetKEYDefinition (std::string keyName, size_t &Position)

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

std::string	GetKEYDefinition (std::string keyName, std::string buffer)

std::string	GetKEYStructure (std::string keyName)
	Gets the first key structure for keyName found inside buffer after fromPosition. More...

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

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

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

std::string	GetKEYStructure (std::string keyName, std::string buffer)

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

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

std::string	GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns the value for the parameter named parName in the given section. More...

std::pair< std::string, std::string >	GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr)
	Returns the unit string of the given parameter of the given xml section. More...

std::map< std::string, std::string >	GetParametersList ()
	It retrieves a map of all parameter:value found in the metadata class. More...

TString	GetSearchPath ()

virtual void	InitFromConfigFile ()
	To make settings from rml file. This method must be implemented in the derived class. More...

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

virtual Int_t	LoadSectionMetadata ()
	This method does some preparation of xml section. More...

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

void	ReadParametersList (std::map< std::string, std::string > &list)
	It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. More...

std::string	ReplaceConstants (const std::string buffer)
	Identifies "constants" in the input buffer, and replace them with corresponding value. More...

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

void	ReSetVersion ()
	Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. More...

std::string	SearchFile (std::string filename)
	Search files in current directory and directories specified in "searchPath" section. More...

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

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

	TRestMetadata ()
	TRestMetadata default constructor. More...

	TRestMetadata (const char *configFilename)
	constructor More...

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

Protected Attributes
TCanvas *	fCanvas = nullptr
	A canvas pointer for drawing. More...

TRandom3 *	fRandom = nullptr
	Random number generator. 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...

Private Attributes
Double_t	fCouplingStrength = 0
	Axion coupling strength. More...

std::string	fCouplingType = ""
	Axion coupling. Defines coupling type and strength. More...

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

Bool_t	fTablesLoaded = false
	A metadata member to control if this class has been initialized. More...

Constructor & Destructor Documentation

◆ TRestAxionSolarFlux() [1/2]

TRestAxionSolarFlux::TRestAxionSolarFlux ( )

protected

Default constructor.

Definition at line 93 of file TRestAxionSolarFlux.cxx.

◆ TRestAxionSolarFlux() [2/2]

TRestAxionSolarFlux::TRestAxionSolarFlux	(	const char *	cfgFileName,
		std::string	name = `""`
	)

protected

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 109 of file TRestAxionSolarFlux.cxx.

◆ ~TRestAxionSolarFlux()

TRestAxionSolarFlux::~TRestAxionSolarFlux ( )

Default destructor.

Definition at line 117 of file TRestAxionSolarFlux.cxx.

Member Function Documentation

◆ AreTablesLoaded()

Bool_t TRestAxionSolarFlux::AreTablesLoaded ( )

inline

Definition at line 84 of file TRestAxionSolarFlux.h.

◆ DrawFluxFile()

TCanvas * TRestAxionSolarFlux::DrawFluxFile	(	std::string	fname,
		Double_t	binSize = `0.01`
	)

It draws the contents of a .flux file. This method just receives the name of the .flux file and it works stand-alone.

Definition at line 170 of file TRestAxionSolarFlux.cxx.

◆ DrawSolarFlux()

TCanvas * TRestAxionSolarFlux::DrawSolarFlux ( )

virtual

It draws the contents of a .flux file. This method just receives the.

Reimplemented in TRestAxionSolarQCDFlux.

Definition at line 192 of file TRestAxionSolarFlux.cxx.

◆ ExportTables()

virtual void TRestAxionSolarFlux::ExportTables ( Bool_t ascii = false )

inlinevirtual

Reimplemented in TRestAxionSolarQCDFlux.

Definition at line 79 of file TRestAxionSolarFlux.h.

◆ GetEnergySpectrum()

virtual TH1F * TRestAxionSolarFlux::GetEnergySpectrum ( Double_t m = 0 )

pure virtual

It returns an energy integrated spectrum in cm-2 s-1 keV-1.

Implemented in TRestAxionSolarQCDFlux.

◆ GetFluxHistogram()

TH1F * TRestAxionSolarFlux::GetFluxHistogram	(	std::string	fname,
		Double_t	binSize = `0.01`
	)

It builds a histogram using the contents of the .flux file given in the argument.

Definition at line 146 of file TRestAxionSolarFlux.cxx.

◆ GetRandomEnergyAndRadius()

virtual std::pair< Double_t, Double_t > TRestAxionSolarFlux::GetRandomEnergyAndRadius	(	TVector2	eRange = `TVector2(-1, -1)`,
		Double_t	mass = `0`
	)

pure virtual

It defines how to generate Monte Carlo energy and radius values to reproduce the flux.

Implemented in TRestAxionSolarQCDFlux.

◆ GetTotalFlux()

virtual Double_t TRestAxionSolarFlux::GetTotalFlux ( Double_t mass = 0 )

pure virtual

It returns the total integrated flux at earth in cm-2 s-1.

Implemented in TRestAxionSolarQCDFlux.

◆ Initialize()

void TRestAxionSolarFlux::Initialize ( )

virtual

It is required in order to load solar flux tables into memory.

Initialization of TRestAxionSolarFlux members.

Reimplemented from TRestMetadata.

Definition at line 122 of file TRestAxionSolarFlux.cxx.

◆ IntegrateFluxInRange()

virtual Double_t TRestAxionSolarFlux::IntegrateFluxInRange	(	TVector2	eRange = `TVector2(-1, -1)`,
		Double_t	mass = `0`
	)

pure virtual

It returns the integrated flux at earth in cm-2 s-1 for the given energy range.

Implemented in TRestAxionSolarQCDFlux.

◆ LoadTables()

virtual Bool_t TRestAxionSolarFlux::LoadTables ( )

protectedpure virtual

It defines how to read the solar tables at the inhereted class.

Implemented in TRestAxionSolarQCDFlux.

◆ PrintMetadata()

void TRestAxionSolarFlux::PrintMetadata ( )

virtual

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

Reimplemented from TRestMetadata.

Reimplemented in TRestAxionSolarQCDFlux.

Definition at line 222 of file TRestAxionSolarFlux.cxx.

Field Documentation

◆ fCanvas

TCanvas* TRestAxionSolarFlux::fCanvas = nullptr

protected

A canvas pointer for drawing.

Definition at line 49 of file TRestAxionSolarFlux.h.

◆ fCouplingStrength

Double_t TRestAxionSolarFlux::fCouplingStrength = 0

private

Axion coupling strength.

Definition at line 39 of file TRestAxionSolarFlux.h.

◆ fCouplingType

std::string TRestAxionSolarFlux::fCouplingType = ""

private

Axion coupling. Defines coupling type and strength.

Definition at line 36 of file TRestAxionSolarFlux.h.

◆ fRandom

TRandom3* TRestAxionSolarFlux::fRandom = nullptr

protected

Random number generator.

Definition at line 52 of file TRestAxionSolarFlux.h.

◆ fSeed

Int_t TRestAxionSolarFlux::fSeed = 0

private

Seed used in random generator.

Definition at line 42 of file TRestAxionSolarFlux.h.

◆ fTablesLoaded

Bool_t TRestAxionSolarFlux::fTablesLoaded = false

private

A metadata member to control if this class has been initialized.

Definition at line 45 of file TRestAxionSolarFlux.h.

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

Detailed Description

Common metadata members defined by this class

Pre-generated solar axion flux tables

Re-implementing a specific TRestAxionSolarXYZFlux class

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ TRestAxionSolarFlux() [1/2]

◆ TRestAxionSolarFlux() [2/2]

◆ ~TRestAxionSolarFlux()

Member Function Documentation

◆ AreTablesLoaded()

◆ DrawFluxFile()

◆ DrawSolarFlux()

◆ ExportTables()

◆ GetEnergySpectrum()

◆ GetFluxHistogram()

◆ GetRandomEnergyAndRadius()

◆ GetTotalFlux()

◆ Initialize()

◆ IntegrateFluxInRange()

◆ LoadTables()

◆ PrintMetadata()

Field Documentation

◆ fCanvas

◆ fCouplingStrength

◆ fCouplingType

◆ fRandom

◆ fSeed

◆ fTablesLoaded