 |
REST-for-Physics
v2.3
Rare Event Searches ToolKit for Physics
|
|
REST-for-Physics
v2.3
Rare Event Searches ToolKit for Physics
|
A metadata class to define the gas properties used in axion search calculations.
TRestAxionBufferGas is a class used to create an interface to the gas properties used in axion search calculations, such as the photon density and photon absorption.
This class will allow us to create an arbitray gas mixture by specifying the atomic components, and its contribution to the density. The available elements can be found at the data/bufferGas/ directory, which are currenty He, Ne, Ar and Xe.
The following examples show how to create a particular gas mixture. Both examples should lead to the same mixture.
Example 1:
Example 2:
The corresponding RML section for initialization through a configuration file would be as follows.
Example 3:
We may also use a definition found inside the official REST-for-Physics data directory.
RESTsoft - Software for Rare Event Searches with TPCs
History of developments:
2019-March: First concept and implementation of TRestAxionBufferGas class. Javier Galan
Definition at line 29 of file TRestAxionBufferGas.h.
#include <TRestAxionBufferGas.h>
Public Member Functions | |
| Double_t | cmToeV (double l_Inv) |
| It transforms cm-1 to eV. | |
| Double_t | GetAbsorptionCoefficient (TString gasName, Double_t energy) |
| It returns the absorption coefficient, in cm2/g, for the given gas component and energy in keV. | |
| Double_t | GetDensityForMass (double m_gamma, double en=4.2) |
| It returns the equivalent gas density for a given photon mass expressed in eV and a given axion energy Ea (4.2 by default). More... | |
| Double_t | GetFormFactor (TString gasName, Double_t energy) |
It returns the atomic form factor of the gasName component at the given energy. More... | |
| Double_t | GetGasDensity (TString gasName) |
| It returns the gas density - from the chosen gasName component - in g/cm3. | |
| Int_t | GetNumberOfGases () |
| It returns the number of gases in the mixture. | |
| Double_t | GetPhotonAbsorptionLength (Double_t energy) |
| It returns the inverse of the absorption lenght, for the gas mixture, in cm-1, for the given energy in keV. | |
| Double_t | GetPhotonAbsorptionLengthIneV (Double_t energy) |
| It returns the inverse of the absorption lenght, for the gas mixture, in eV, for the given energy in keV. | |
| Double_t | GetPhotonMass (double en) |
| It returns the equivalent photon mass (in eV) for the gas mixture at the given input energy expressed in keV. | |
| void | PrintAbsorptionGasData (TString gasName) |
| Prints out the absorption coefficients as function of the energy for the given gas component, for debugging pourposes. | |
| void | PrintFormFactorGasData (TString gasName) |
| Prints out the atomic form factors as function of the energy for the given gas component, for debugging pourposes. | |
| void | PrintMetadata () |
| Prints on screen the information about the metadata members of TRestAxionBufferGas. | |
| void | SetGasDensity (TString gasName, Double_t density) |
| It adds a new gas component to the mixture. If it already exists it will update its density. More... | |
| void | SetGasMixture (TString gasMixture, TString gasDensities="0") |
| It re-initializes the gas mixture to the one provided by argument. More... | |
| TRestAxionBufferGas () | |
| Default constructor. | |
| TRestAxionBufferGas (const char *cfgFileName, std::string name="") | |
| Constructor loading data from a config file. More... | |
| ~TRestAxionBufferGas () | |
| Default destructor. | |
 Public Member Functions inherited from TRestMetadata | |
| void | AddLog (std::string log="", bool print=true) |
| Add logs to messageBuffer. | |
| void | DoNotStore () |
| If this method is called the metadata information will not be stored in disk. | |
| TVector2 | Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1)) |
| TVector3 | Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1)) |
| TString | GetCommit () |
| Returns the REST commit value stored in fCommit. | |
| std::string | GetConfigBuffer () |
| Returns the config section of this class. | |
| std::string | GetDataMemberValue (std::string memberName) |
| Get the value of data member as string. More... | |
| std::vector< std::string > | GetDataMemberValues (std::string memberName, Int_t precision=0) |
| Get the value of datamember as a vector of strings. More... | |
| TString | GetDataPath () |
| Returns a std::string with the path used for data storage. | |
| Double_t | GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL) |
| Gets the value of the parameter name parName, after applying unit conversion. More... | |
| Bool_t | GetError () const |
| It returns true if an error was identified by a derived metadata class. | |
| TString | GetErrorMessage () |
| Returns a std::string containing the error message. | |
| TString | GetLibraryVersion () |
| Returns the REST libraty version stored in fLibraryVersion. | |
| TString | GetMainDataPath () |
| Gets a std::string with the path used for data storage. | |
| Int_t | GetNumberOfErrors () const |
| Int_t | GetNumberOfWarnings () const |
| std::string | GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR) |
| Returns corresponding REST Metadata parameter from multiple sources. More... | |
| std::string | GetSectionName () |
| Returns the section name of this class, defined at the beginning of fSectionName. | |
| TRestStringOutput::REST_Verbose_Level | GetVerboseLevel () |
| returns the verboselevel in type of REST_Verbose_Level enumerator | |
| TString | GetVerboseLevelString () |
| returns the verbose level in type of TString More... | |
| TString | GetVersion () |
| Returns the REST version stored in fVersion. | |
| Int_t | GetVersionCode () |
| 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. 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 §ionName="") |
| 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. More... | |
| void | PrintMessageBuffer () |
| Print the buffered message. | |
| void | PrintTimeStamp (Double_t timeStamp) |
| Print the current time on local machine. More... | |
| void | SetConfigFile (std::string configFilename) |
| set config file path from external | |
| void | SetError (std::string message="", bool print=true, int maxPrint=5) |
| A metadata class may use this method to signal that something went wrong. | |
| void | SetHostmgr (TRestManager *m) |
| Set the host manager for this class. | |
| void | SetSectionName (std::string sName) |
| set the section name, clear the section content | |
| void | SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v) |
| sets the verbose level | |
| void | SetWarning (std::string message="", bool print=true, int maxPrint=5) |
| A metadata class may use this method to signal that something went wrong. | |
| void | Store () |
| If this method is called the metadata information will be stored in disk. | |
| TRestMetadata (const TRestMetadata &) | |
| 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 Member Functions | |
| Int_t | FindGasIndex (TString gName) |
It returns the internal index of the gas component given by gasName. | |
| Int_t | GetEnergyIndex (std::vector< Double_t > enVector, Double_t energy) |
It returns the vector element index, from enVector, that is just below the given input energy. | |
| void | InitFromConfigFile () |
| Initialization of TRestAxionBufferGas field members through a RML file. | |
| void | Initialize () |
| Initialization of TRestAxionBufferGas members. It removes all gases. | |
| void | ReadGasData (TString gasName) |
| It reads the data files from the corresponding gas component. More... | |
Private Attributes | |
| std::vector< std::vector< Double_t > > | fAbsEnergy |
| Energy values for gas absorption coefficient in keV. | |
| std::vector< Double_t > | fBufferGasDensity |
| Gas density of the corresponding gasName in g/cm3. | |
| std::vector< TString > | fBufferGasName |
| Name of the buffer gas (He, Ne, Ar, Xe, ..., etc ) | |
| std::vector< std::vector< Double_t > > | fFactorEnergy |
| Energy values for gas form factor in keV. | |
| std::vector< std::vector< Double_t > > | fGasAbsCoefficient |
| Gas absorption coefficient in cm2/g. | |
| std::vector< std::vector< Double_t > > | fGasFormFactor |
| Gas form factor. | |
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. | |
| 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". | |
| 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. 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. | |
| 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. | |
| TString | GetSearchPath () |
| virtual void | InitFromRootFile () |
| Method called after the object is retrieved from root file. | |
| virtual Int_t | LoadSectionMetadata () |
| This method does some preparation of xml section. More... | |
| void | ReadAllParameters () |
| Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More... | |
| void | ReadParametersList (std::map< std::string, std::string > &list) |
| It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. | |
| std::string | ReplaceConstants (const std::string buffer) |
| Identifies "constants" in the input buffer, and replace them with corresponding value. More... | |
| std::string | ReplaceVariables (const std::string buffer) |
| Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More... | |
| void | ReSetVersion () |
| Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. | |
| std::string | SearchFile (std::string filename) |
| Search files in current directory and directories specified in "searchPath" section. More... | |
| void | SetLibraryVersion (TString version) |
| Set the library version of this metadata class. | |
| TiXmlElement * | StringToElement (std::string definition) |
| Parsing a string into TiXmlElement object. More... | |
| TRestMetadata () | |
| TRestMetadata default constructor. | |
| TRestMetadata (const char *configFilename) | |
| constructor | |
| void | UnSetVersion () |
| Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. | |
| Protected Attributes inherited from TRestMetadata | |
| std::string | configBuffer |
| The buffer where the corresponding metadata section is stored. Filled only during Write() | |
| std::string | fConfigFileName |
| Full name of the rml file. More... | |
| std::map< std::string, std::string > | fConstants |
| Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only. | |
| TiXmlElement * | fElement |
| Saving the sectional element together with global element. | |
| TiXmlElement * | fElementGlobal |
| Saving the global element, to be passed to the resident class, if necessary. | |
| Bool_t | fError = false |
| It can be used as a way to identify that something went wrong using SetError method. | |
| TString | fErrorMessage = "" |
| A std::string to store an optional error message through method SetError. | |
| TRestManager * | fHostmgr |
| All metadata classes can be initialized and managed by TRestManager. | |
| Int_t | fNErrors = 0 |
| It counts the number of errors notified. | |
| Int_t | fNWarnings = 0 |
| It counts the number of warnings notified. | |
| std::string | fSectionName |
| Section name given in the constructor of the derived metadata class. | |
| Bool_t | fStore |
| This variable is used to determine if the metadata structure should be stored in the ROOT file. | |
| std::map< std::string, std::string > | fVariables |
| Saving a list of rml variables. name-value std::pair. | |
| TRestStringOutput::REST_Verbose_Level | fVerboseLevel |
| Verbose level used to print debug info. | |
| Bool_t | fWarning = false |
| It can be used as a way to identify that something went wrong using SetWarning method. | |
| TString | fWarningMessage = "" |
| It can be used as a way to identify that something went wrong using SetWarning method. | |
| std::string | messageBuffer |
| The buffer to store the output message through TRestStringOutput in this class. | |
| endl_t | RESTendl |
| Termination flag object for TRestStringOutput. | |
| TRestAxionBufferGas::TRestAxionBufferGas | ( | const char * | cfgFileName, |
| 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.
| 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 TRestGeant4Metadata section inside the RML. |
Definition at line 116 of file TRestAxionBufferGas.cxx.
| Double_t TRestAxionBufferGas::GetDensityForMass | ( | double | m_gamma, |
| double | en = 4.2 |
||
| ) |
It returns the equivalent gas density for a given photon mass expressed in eV and a given axion energy Ea (4.2 by default).
This method is only valid for pure gases with only one gas component. Before calling the method one needs to define a gas with a single component, e.g. using TRestAxionBufferGas::SetGasDensity( "He", 0 )
The resulting density will be expressed in kg/mm^3, which are the standard REST Units.
Definition at line 436 of file TRestAxionBufferGas.cxx.
| Double_t TRestAxionBufferGas::GetFormFactor | ( | TString | gasName, |
| Double_t | energy | ||
| ) |
It returns the atomic form factor of the gasName component at the given energy.
Energy input parameter must be given in keV
Definition at line 316 of file TRestAxionBufferGas.cxx.
|
private |
It reads the data files from the corresponding gas component.
This method will need to find under data/bufferGas/ the corresponding scattering form factors and absorption files for component X, i.e. X.nff and X.abs.
TODO. This method might better use SearchFile method that searches in globals <searchPath definition.
Definition at line 239 of file TRestAxionBufferGas.cxx.
| void TRestAxionBufferGas::SetGasDensity | ( | TString | gasName, |
| Double_t | density | ||
| ) |
It adds a new gas component to the mixture. If it already exists it will update its density.
Density must be given in standard REST units: kg/mm^3
Definition at line 173 of file TRestAxionBufferGas.cxx.
| void TRestAxionBufferGas::SetGasMixture | ( | TString | gasMixture, |
| TString | gasDensities = "0" |
||
| ) |
It re-initializes the gas mixture to the one provided by argument.
The first argument must be the gas components separated by the sign +. The second argument are the corresponding densities with units.
Example : SetGasMixture("Ne+Xe", "2e-3g/cm3+3mg/cm3" );
If the second argument with densities is not given, the buffer gas will add the gas components with zero density.
Definition at line 190 of file TRestAxionBufferGas.cxx.
1.9.1