Detailed Description

A process to introduce the magnetic field profile integration along the track.

This process is designed to work with the most general case of the magnetic field description using the help of TRestAxionMagneticField metadata class. This means that the magnetic field volume can be made of several magnetic field "regions" (as described in the documentation of TRestAxionMagneticField, where each "region" is defined by a separate <addMagnetVolume...> line in its RML configuration file. One such example of generic magnetic field volume description is shown in the following figure, where the volume consists of four regions labeled #1 . . . #4. In the following example the regions appear as connected regions although in general they could be completely unconnected, or isolated regions. Anywhere where no region is defined the field will be equal to zero.

Here, the boundaries of each region are represented by blue lines. Also, in some (or all) regions the magnetic field can be zero in its outer parts in order to define a more complex field shape inside. These parts where $B = 0$ are shown in blue, while the parts of the regions with $B \neq 0$ are shown in green. In this case, it is possible that the particle, right after entering the region, passes through the part where $B = 0$ before traversing the section with $B \neq 0$ . Also, just before exiting the region, the particle can again pass through the section with $B = 0$ .

This process will use the profile of the transversal magnetic field component at each of the volumes along the path to calculate the probability the particle is in a photon state at the end of the trajectory,

In a first approach this process will be only valid for the axion propagation inside a single magnetic volume, until it is confirmed the process is valid for any number of volumes.

This process requires at least the definition of a magnetic field using a TRestAxionMagneticField metadata definition. Optionally, if the field uses a buffer gas we may define a TRestAxionBufferGas that will include all the necessary gas properties, such as photon mass or absorption.

Two metadata parameters can be defined inside this process:

bufferGasAdditionalLength (Default:0mm): In the case we use a buffer gas we may include an additional length that the particle needs to travel inside that buffer gas but outside the magnetic field volume, the result will be written as an independent efficiency at the transmission observable inside the analysis tree.
accuracy (Default:0.1): The integration method will try to get an error lower than 10%.
numIntervals (Default:100): The max number of intervals used by the integration method.
qawoLevels (Default:20): The size of pre-generated table for cosine integrals.
reMap (Default: (30,30,100)mm): The mesh cell size of the magnetic field will be re-mapped to the value provided in this parameter.

List of observables generated by this process:

probability: The final axion-photon conversion probability.
error: The error on the final axion-photon conversion probability.
transmission: This observable will register the photon transmission produced by an additional buffer gas length at the end of the magnetic region.

This process can be tested using the RML files found inside the directory /pipeline/ray-tracing/axion-field/. The following commands will generate plots with different distributions containing different axion-photon probability calculations.

restManager --c photonConversion.rml

restManager --c plots.rml --f AxionPhotonProbability.root

The previous commands were used to generate the following plots where a total of 100,000 events were generated.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2019-March: First prototyping of the process. Javier Galan

2019-July: Implementation of boundaries and magnetic field evaluation. Eve Pachoud

2020-March: Review and validation of this process. Javier Galan and Krešimir Jakovčić

2022-November: Finally including non-homogeneous field integration Javier Galan

Author: Javier Galan javie.nosp@m.r.ga.nosp@m.lan@u.nosp@m.niza.nosp@m.r.es; Krešimir Jakovčić kjako.nosp@m.v@ir.nosp@m.b.hr

Definition at line 35 of file TRestAxionFieldPropagationProcess.h.

#include <TRestAxionFieldPropagationProcess.h>

Inheritance diagram for TRestAxionFieldPropagationProcess:

Public Member Functions
	ClassDefOverride (TRestAxionFieldPropagationProcess, 2)

RESTValue	GetInputEvent () const override
	Get pointer to input event. Must be implemented in the derived class.

RESTValue	GetOutputEvent () const override
	Get pointer to output event. Must be implemented in the derived class.

const char *	GetProcessName () const override
	Returns the name of this process.

void	InitProcess () override
	Process initialization. Data members that require initialization just before start processing should be initialized here.

void	PrintMetadata () override
	It prints out the process parameters stored in the metadata structure.

TRestEvent *	ProcessEvent (TRestEvent *eventInput) override
	Process one event. More...

	TRestAxionFieldPropagationProcess ()
	Default constructor.

	TRestAxionFieldPropagationProcess (char *cfgFileName)
	Constructor loading data from a config file. More...

	~TRestAxionFieldPropagationProcess ()
	Default destructor.

Public Member Functions inherited from TRestAxionEventProcess
virtual void	BeginOfEventProcess (TRestEvent *evInput=nullptr) override
	Begin of event process, preparation work. Called right before ProcessEvent() More...

	ClassDefOverride (TRestAxionEventProcess, 3)

virtual void	EndOfEventProcess (TRestEvent *evInput=nullptr) override
	End of event process. Called directly after ProcessEvent() More...

	TRestAxionEventProcess ()

	~TRestAxionEventProcess ()

Public Member Functions inherited from TRestEventProcess
virtual Bool_t	AddInputFile (const std::string &file)

bool	ApplyCut ()

	ClassDefOverride (TRestEventProcess, 3)

virtual void	EndProcess ()
	To be executed at the end of the run (outside event loop)

TRestAnalysisTree *	GetAnalysisTree () const
	Return the local analysis tree (dummy)

TCanvas *	GetCanvas () const
	Get canvas.

TRestAnalysisTree *	GetFullAnalysisTree ()

std::vector< std::string >	GetListOfAddedObservables ()

TRestRun *	GetRunInfo () const
	Return the pointer of the hosting TRestRun object.

virtual Long64_t	GetTotalBytes () const

virtual Long64_t	GetTotalBytesRead () const
	Interface to external file reading, get the read bytes. To be implemented in external processes.

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

Bool_t	isExternal () const
	Return whether this process is external process.

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

virtual void	NotifyAnalysisTreeReset ()
	In case the analysis tree is reset(switched to new file), some process needs to have action.

virtual Bool_t	OpenInputFiles (const std::vector< std::string > &files)

std::vector< std::string >	ReadObservables ()

void	RegisterAllObservables (Bool_t value=true)

virtual Bool_t	ResetEntry ()

void	SetAnalysisTree (TRestAnalysisTree *tree)
	Set analysis tree of this process, then add observables to it.

void	SetCanvasSize (Int_t x, Int_t y)
	Set canvas size.

void	SetFriendProcess (TRestEventProcess *p)
	Add friendly process to this process.

void	SetObservableValidation (bool validate)

void	SetParallelProcess (TRestEventProcess *p)
	Add parallel process to this process.

void	SetRunInfo (TRestRun *r)
	Set TRestRun for this process.

Bool_t	singleThreadOnly () const
	Return whether this process is single std::thread only.

	TRestEventProcess ()

	~TRestEventProcess ()

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 &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. 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
void	Initialize () override
	Function to initialize input/output event members and define the section name.

Private Attributes
Double_t	fAccuracy = 0.1
	The tolerance or accuracy used inside the GSL integrator.

TRestAxionField *	fAxionField = nullptr
	A pointer to TRestAxionField that implements probability calculations.

TRestAxionBufferGas *	fBufferGas = nullptr
	A pointer to TRestBufferGas given to TRestAxionField to perform calculations in a particular gas.

Double_t	fBufferGasAdditionalLength = 0
	The additional length in mm that the converted photon propagates without magnetic field.

TRestAxionMagneticField *	fMagneticField = nullptr
	A pointer to the magnetic field description stored in TRestRun.

Int_t	fNumIntervals = 100
	Number of intervales used by the GSL integrator.

Int_t	fQawoLevels = 20
	Number of levels used by the GSL integrator to parameterize the cosine integral.

TVector3	fReMap = TVector3(30, 30, 100)
	It will re-size the cells in the magnetic field (affecting the time required for integral computation)

Additional Inherited Members
Protected Types inherited from TRestEventProcess
enum	REST_Process_Output { No_Output , Observable , Internal_Var , Full_Output }

Protected Member Functions inherited from TRestAxionEventProcess
void	BeginPrintProcess ()
	Pre-defined printer, can be used at the beginning in the implementation of PrintMetadata() More...

void	EndPrintProcess ()
	Adds the footer for PrintMetadata.

TVector3	GetCenter () const

Protected Member Functions inherited from TRestEventProcess
void	BeginPrintProcess ()
	[name, cut range]

void	CreateCanvas ()
	Create the canvas.

void	EndPrintProcess ()

TRestEventProcess *	GetFriend (const std::string &nameOrType)

TRestEventProcess *	GetFriendLive (const std::string &nameOrType)

template<class T >
T *	GetMetadata ()
	Get a metadata object from the host TRestRun. More...

TRestMetadata *	GetMetadata (const std::string &nameOrType)

size_t	GetNumberOfParallelProcesses () const

template<class T >
T	GetObservableValue (const std::string &name)

TRestEventProcess *	GetParallel (int i)

template<class T >
std::vector< T >	GetParallelDataMembers (T *member_of_process)
	Get a list of data members from parallel processes which is same to this process's certain data member. More...

template<class T >
void	SetObservableValue (const std::string &name, const T &value)
	Set observable value for AnalysisTree. 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.

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.

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 TRestAxionEventProcess
TRestAxionEvent *	fAxionEvent
	A pointer to the specific TRestAxionEvent.

Protected Attributes inherited from TRestEventProcess
TRestAnalysisTree *	fAnalysisTree = nullptr

TCanvas *	fCanvas = nullptr
	< Canvas for some viewer event

TVector2	fCanvasSize
	Canvas size.

std::vector< std::pair< std::string, TVector2 > >	fCuts
	Stores cut definitions. Any listed observables should be in the range. More...

bool	fDynamicObs = false
	It defines whether to use added observables only or all the observables appear in the code.

bool	fIsExternal = false
	It defines if the process reads event data from an external source.

std::map< std::string, int >	fObservablesDefined
	Stores the list of all the appeared process observables in the code. More...

std::map< std::string, int >	fObservablesUpdated
	Stores the list of process observables updated when processing this event.

bool	fReadOnly = false
	not used, keep for compatibility

TRestRun *	fRunInfo = nullptr
	< Pointer to TRestRun object where to find metadata.

bool	fSingleThreadOnly = false

bool	fValidateObservables = false
	It defines if observable names should be added to the validation list.

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.

Constructor & Destructor Documentation

◆ TRestAxionFieldPropagationProcess()

TRestAxionFieldPropagationProcess::TRestAxionFieldPropagationProcess ( char * cfgFileName )

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.

Definition at line 142 of file TRestAxionFieldPropagationProcess.cxx.

Member Function Documentation

◆ ProcessEvent()

TRestEvent * TRestAxionFieldPropagationProcess::ProcessEvent ( TRestEvent * inputEvent )

overridevirtual

Process one event.

Missing to propagate the axion to the end of magnet bore? May not be necessary, it can be done by TRestAxionTransportProcess if user needs any process that changes direction, this is done for example by optics processes internally

Implements TRestEventProcess.

Definition at line 194 of file TRestAxionFieldPropagationProcess.cxx.

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

◆ TRestAxionFieldPropagationProcess()

Member Function Documentation

◆ ProcessEvent()