Detailed Description

A metadata class to create x-ray transmission window definitions.

TRestAxionXrayWindow implements parameters that define the window properties, such as material and thickness. This class will load the transmission data to calculate the transmission for a photon of a given energy and position. The window might be defined as a uniform foil or using a particular pattern using a TRestPatternMask definition.

If we include the pattern definition using TRestPatternMask, then, the limits for the window will be imposed by TRestPatternMask. In the contrary, if no TRestPatternMask definition is included in the TRestAxionXrayWindow definition, then the window will have no limits, it will be just an infinite foil with a given material transmission.

The following parameters are used to define the window transmission:

center: It will emplace the window definition at a given position.
material: The material used by the window. The name must match the name of one of the files found at data/transmission/ removing the extension.
thickness: The depth of the window that defines finally the total x-ray photon absorption.

Then, as it was mentioned before, we might define different types of window patterns, such as a strong back where photon opacity is only defined at a regular grid or stripped pattern. The window transmission will only be applied in the regions where the particle hits the pattern. Otherwise, the particle will just go through the empty regions and the transmission/efficiency will be equal to 1.

We may define the window pattern using any of the classes inheriting from TRestPatternMask, such as TRestGridMask, TRestStrippedMask, or event TRestSpiderMask and TRestRingsMask.

Once all the parameters have been defined inside an instance of this class, we will be able to recover the transmission at any given point inside the window using the method TRestAxionXrayWindow::GetEfficiecy.

The corresponding RML section for initialization through a configuration file would be as follows.

<TRestAxionXrayWindow name="strongBack" verboseLevel="warning">
    <parameter name="center" value="(0,0,0)mm" />
<parameter name="thickness" value="200um" />
    <parameter name="material" value="Si" />
 
    <TRestGridMask name="mask" verboseLevel="warning"
     maskRadius="8mm" offset="(2,2)mm"
        rotationAngle="0.5" gridGap="4mm" gridThickness="0.5mm" />
</TRestAxionXrayWindow>

The pipeline example found at pipeline/transmission/windowPlot.py will use a definition with 3 layers to generate the following plot.

Windows trasmission at energy ranges (0-5)keV, (5-10)keV and (10-15)keV.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2019-March: First concept and implementation of TRestAxionXrayWindow class. Javier Galan

Author: Javier Galan

Definition at line 30 of file TRestAxionXrayWindow.h.

#include <TRestAxionXrayWindow.h>

Inheritance diagram for TRestAxionXrayWindow:

Public Member Functions
TRestPatternMask *	GetMask () const

Double_t	GetTransmission (Double_t energy, Double_t x, Double_t y)
	It returns the window transmission probability for the given energy (in keV) and window position, using energy linear interpolation. More...

Double_t	GetWindowRadius ()

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

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

void	PrintTransmissionData ()
	Prints out the transmission probability curve loaded in memory. for debugging pourposes. More...

	TRestAxionXrayWindow ()
	Default constructor. More...

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

	~TRestAxionXrayWindow ()
	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
Int_t	GetEnergyIndex (Double_t energy)
	It returns the vector element index, from `fEnergy`, that is just below the given input energy. More...

Bool_t	HitsPattern (Double_t x, Double_t y)
	It returns true if the window pattern is hitted. False otherwise. More...

void	Initialize ()
	Initialization of TRestAxionXrayWindow members. It removes all gases. More...

void	ReadMaterial ()
	It reads the data files from the corresponding material that needs to be found in the axiolib database with .sol extension. Usually placed under `data/axion/transmission/` More...

Private Attributes
std::vector< Double_t >	fEnergy
	A vector with the energies loaded from the material file. Not stored in disk. More...

TRestPatternMask *	fMask = nullptr
	A mask defining a pattern where the transmission will be effective. More...

std::string	fMaterial = "Vacuum"
	Window material name. More...

Double_t	fThickness = 0.0
	Thicknesss of window material in mm. More...

std::vector< Double_t >	fTransmission
	A vector with the transmission already renormalized using the material thickness. Not stored in disk. 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

◆ TRestAxionXrayWindow() [1/2]

TRestAxionXrayWindow::TRestAxionXrayWindow ( )

Default constructor.

Definition at line 108 of file TRestAxionXrayWindow.cxx.

◆ TRestAxionXrayWindow() [2/2]

TRestAxionXrayWindow::TRestAxionXrayWindow	(	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.

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

Definition at line 124 of file TRestAxionXrayWindow.cxx.

◆ ~TRestAxionXrayWindow()

TRestAxionXrayWindow::~TRestAxionXrayWindow ( )

Default destructor.

Definition at line 136 of file TRestAxionXrayWindow.cxx.

Member Function Documentation

◆ GetEnergyIndex()

Int_t TRestAxionXrayWindow::GetEnergyIndex ( Double_t energy )

private

It returns the vector element index, from fEnergy, that is just below the given input energy.

Definition at line 287 of file TRestAxionXrayWindow.cxx.

◆ GetMask()

TRestPatternMask * TRestAxionXrayWindow::GetMask ( ) const

inline

Definition at line 61 of file TRestAxionXrayWindow.h.

◆ GetTransmission()

Double_t TRestAxionXrayWindow::GetTransmission	(	Double_t	energy,
		Double_t	x,
		Double_t	y
	)

It returns the window transmission probability for the given energy (in keV) and window position, using energy linear interpolation.

For the case of patterned window (stripped or grid), it will return 1 if the strip is not hitted.

Definition at line 198 of file TRestAxionXrayWindow.cxx.

◆ GetWindowRadius()

Double_t TRestAxionXrayWindow::GetWindowRadius ( )

inline

Definition at line 56 of file TRestAxionXrayWindow.h.

◆ HitsPattern()

Bool_t TRestAxionXrayWindow::HitsPattern	(	Double_t	x,
		Double_t	y
	)

private

It returns true if the window pattern is hitted. False otherwise.

Definition at line 241 of file TRestAxionXrayWindow.cxx.

◆ InitFromConfigFile()

void TRestAxionXrayWindow::InitFromConfigFile ( )

virtual

To make settings from rml file. This method must be implemented in the derived class.

Reimplemented from TRestMetadata.

Definition at line 306 of file TRestAxionXrayWindow.cxx.

◆ Initialize()

void TRestAxionXrayWindow::Initialize ( )

privatevirtual

Initialization of TRestAxionXrayWindow members. It removes all gases.

Reimplemented from TRestMetadata.

Definition at line 141 of file TRestAxionXrayWindow.cxx.

◆ PrintMetadata()

void TRestAxionXrayWindow::PrintMetadata ( )

virtual

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

Reimplemented from TRestMetadata.

Definition at line 324 of file TRestAxionXrayWindow.cxx.

◆ PrintTransmissionData()

void TRestAxionXrayWindow::PrintTransmissionData ( )

Prints out the transmission probability curve loaded in memory. for debugging pourposes.

Definition at line 297 of file TRestAxionXrayWindow.cxx.

◆ ReadMaterial()

void TRestAxionXrayWindow::ReadMaterial ( )

private

It reads the data files from the corresponding material that needs to be found in the axiolib database with .sol extension. Usually placed under data/axion/transmission/

Definition at line 163 of file TRestAxionXrayWindow.cxx.

Field Documentation

◆ fEnergy

std::vector<Double_t> TRestAxionXrayWindow::fEnergy

private

A vector with the energies loaded from the material file. Not stored in disk.

Definition at line 42 of file TRestAxionXrayWindow.h.

◆ fMask

TRestPatternMask* TRestAxionXrayWindow::fMask = nullptr

private

A mask defining a pattern where the transmission will be effective.

Definition at line 39 of file TRestAxionXrayWindow.h.

◆ fMaterial

std::string TRestAxionXrayWindow::fMaterial = "Vacuum"

private

Window material name.

Definition at line 36 of file TRestAxionXrayWindow.h.

◆ fThickness

Double_t TRestAxionXrayWindow::fThickness = 0.0

private

Thicknesss of window material in mm.

Definition at line 33 of file TRestAxionXrayWindow.h.

◆ fTransmission

std::vector<Double_t> TRestAxionXrayWindow::fTransmission

private

A vector with the transmission already renormalized using the material thickness. Not stored in disk.

Definition at line 45 of file TRestAxionXrayWindow.h.

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

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestAxionXrayWindow() [1/2]

◆ TRestAxionXrayWindow() [2/2]

◆ ~TRestAxionXrayWindow()

Member Function Documentation

◆ GetEnergyIndex()

◆ GetMask()

◆ GetTransmission()

◆ GetWindowRadius()

◆ HitsPattern()

◆ InitFromConfigFile()

◆ Initialize()

◆ PrintMetadata()

◆ PrintTransmissionData()

◆ ReadMaterial()

Field Documentation

◆ fEnergy

◆ fMask

◆ fMaterial

◆ fThickness

◆ fTransmission