Detailed Description

A class that calculates the reflection path of X-rays through a Wolter 1 telescope.

TRestAxionWolterOptics is a class that inherits from TRestAxionOptics.

This class defines an optics device using conical aproximation as it is ilustrated in the following figure.

Wolter optics schematic figure

The parameters shown there correspond to the geometrical description of each of the mirrors that build the optics device. Those parameters will be retrieved by TRestAxionOptics, and they will be placed inside TRestAxionOptics::fOpticsData. This class will use those parameters to implement the ray-tracing interactions inside the mirrors, and to define the entrance/middle/interface masks. The format of the file must follow the same specifications as the file XMM.Wolter.

The optical parameters extracted from this file, in particular R1, R3 and R5, will be used to generate the TRestRingsMask at each of the optical interfaces, entrance, middle, and exit. An additional mask, a TRestSpiderMask, common to all the interfaces must be defined in the RML configuration. The TRestRingsMask and the TRestSpiderMask will be used to build a TRestCombinedMask at each interface.

RML definition

Examples of RML optics definitions can be found at the axion-lib data repository.

<TRestAxionWolterOptics name="xmm" verboseLevel="warning" >
    <parameter name="opticsFile" value="XMM.Wolter" />
 
    <parameter name="mirrorLength" value="300" />
 
    <TRestAxionOpticsMirror name="XMM">
        <parameter name="mirrorType" value="Single" />
 
        <parameter name="layerTop" value="Au" />
        <parameter name="layerThicknessTop" value="250" />
        <parameter name="sigmaTop" value="0.4" />
 
        <parameter name="substrate" value="Ni" />
    </TRestAxionOpticsMirror>
 
    <TRestSpiderMask name="spider" verboseLevel="warning">
        <parameter name="maskRadius" value="70cm"/>
        <parameter name="offset" value="(0,0)cm"/>
        <parameter name="rotationAngle" value="0"/>
        <parameter name="armsWidth" value="2.5deg"/>
        <parameter name="armsSeparationAngle" value="180./16degrees"/>
        <parameter name="initialRadius" value="0cm"/>
    </TRestSpiderMask>
</TRestAxionWolterOptics>

The previous definition corresponds to the following image, that was generated using the method TRestAxionOptics::DrawDensityMaps, where we can visualize the XY projection of the photons at different Z-positions.

Hitmaps for the XMM definition, using TRestAxionWolterOptics

This image was generated using the macro REST_Axion_XMMPlots.C which is available when entering the ROOT interface using the restRootMacros command. It corresponds with the flux of a perfectly aligned photon flux, deviation=0, for a TRestAxionWolterOptics definition of the XMM optics. The RML description used, xmm.rml, can be found at the axion-lib data repository.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2022-February: First concept and implementation of TRestAxionWolterOptics class. Johanna von Oy

2022-May: Final integration Javier Galan

Author: Johanna von Oy vonoy.nosp@m.@phy.nosp@m.sik.u.nosp@m.ni-b.nosp@m.onn.d.nosp@m.e; Javier Galan javie.nosp@m.r.ga.nosp@m.lan@u.nosp@m.niza.nosp@m.r.es

Definition at line 33 of file TRestAxionWolterOptics.h.

#include <TRestAxionWolterOptics.h>

Inheritance diagram for TRestAxionWolterOptics:

Public Member Functions
	ClassDefOverride (TRestAxionWolterOptics, 1)

TPad *	DrawMirrors () override
	A method to to draw an optics schematic including the mirrors geometry. More...

std::vector< Double_t >	GetAlpha ()
	It returns a vector with the values of alpha. More...

Double_t	GetEntrancePositionZ () override
	It returns the entrance Z-position defined by the optical axis. More...

Double_t	GetExitPositionZ () override
	It returns the exit Z-position defined by the optical axis. More...

std::vector< Double_t >	GetR1 ()
	It returns a vector with the values of R1. More...

std::vector< Double_t >	GetR2 ()
	It returns a vector with the values of R2. More...

std::vector< Double_t >	GetR3 ()
	It returns a vector with the values of R3. More...

std::vector< Double_t >	GetR4 ()
	It returns a vector with the values of R4. More...

std::vector< Double_t >	GetR5 ()
	It returns a vector with the values of R5. More...

std::pair< Double_t, Double_t >	GetRadialLimits () override
	It returns the lower/higher radius range where photons are allowed. More...

std::vector< Double_t >	GetThickness ()
	It returns a vector with the values of mirror thickness. More...

void	InitFromConfigFile () override
	Initialization of TRestAxionWolterOptics field members through a RML file. More...

void	Initialize () override
	Initialization of TRestAxionWolterOptics members. More...

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

void	PrintParameters ()
	It prints out the Wolter (relevant) parameters extracted from the optics data file, and other parameters calculated after those input parameters, such as the vertex and angles. More...

void	PrintSpider ()
	It prints out the spider mask common to all the optical planes. More...

void	SetMirror () override
	It must be implemented at the inherited optics, making use of fEntrancePosition. More...

	TRestAxionWolterOptics ()
	Default constructor. More...

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

	~TRestAxionWolterOptics ()
	Default destructor. More...

Public Member Functions inherited from TRestAxionOptics
Double_t	CalculateSpotSize (Double_t energy, Double_t z, Int_t particles=15000)
	It measures the spot size through Monte Carlo at a given plane given by z. If z=0 this method will check for the spot size at the focal point, which is the default behaviour. More...

TPad *	CreatePad (Int_t nx=1, Int_t ny=1)
	A prototype method to be implemented by specific optics to draw an schematic including the mirrors geometry. More...

TPad *	DrawDensityMaps (Double_t z, Double_t energy=0, Double_t deviation=0, Int_t particles=1000, Double_t focalHint=7500)
	It implements a generic method to identify the optimum focal point. It can be reimplemented at each specific optics class. More...

virtual TPad *	DrawMirrors ()=0
	It draws the mirrors using a TGraph. To be implemented at the inherited class. More...

TPad *	DrawParticleTracks (Double_t deviation=0, Int_t particles=10)
	A method to draw an optics schematic including the mirrors geometry, and few photon tracks. This method is intended for debugging the photon tracking implementation. More...

TPad *	DrawScatterMaps (Double_t z, Double_t energy=0, Double_t deviation=0, Int_t particles=1000, Double_t focalHint=7500)
	It implements a generic method to identify the optimum focal point. It can be reimplemented at each specific optics class. More...

virtual Double_t	FindFocal (Double_t from, Double_t to, Double_t energy, Double_t precision=1, Bool_t recalculate=false, Int_t particles=5000)
	It implements a generic method to identify the optimum focal point. It can be reimplemented at each specific optics class. More...

virtual Int_t	FirstMirrorReflection (const TVector3 &pos, const TVector3 &dir)=0
	It updates the values fFirstInteractionPosition and fMiddleDirection. Returns 0 if is not in region. More...

Double_t	GetEntranceAngle ()
	It returns the entrance angle to the optical axis (in radians). More...

TVector3	GetEntranceDirection ()
	Returns the entrance position from the latest propagated photon. More...

TRestCombinedMask *const &	GetEntranceMask () const
	Returns a pointer to access directly the entrance mask information. More...

TVector3	GetEntrancePosition ()
	Returns the entrance position from the latest propagated photon. More...

virtual Double_t	GetEntrancePositionZ ()=0
	It returns the entrance Z-position defined by the optical axis. More...

TVector3	GetExitDirection ()
	Returns the exit position from the latest propagated photon. More...

TRestCombinedMask *const &	GetExitMask () const
	Returns a pointer to access directly the exit mask information. More...

TVector3	GetExitPosition ()
	Returns the exit position from the latest propagated photon. More...

virtual Double_t	GetExitPositionZ ()=0
	It returns the exit Z-position defined by the optical axis. More...

TVector3	GetLastGoodDirection ()
	It returns the last valid particle direction known in the particle tracking. More...

TVector3	GetLastGoodPosition ()
	It returns the last valid particle position known in the particle tracking. More...

TVector3	GetMiddleDirection ()
	Returns the middle position from the latest propagated photon. More...

TRestCombinedMask *const &	GetMiddleMask () const
	Returns a pointer to access directly the middle mask information. More...

TVector3	GetMiddlePosition ()
	Returns the middle position from the latest propagated photon. More...

TRestAxionOpticsMirror *const &	GetMirrorProperties () const
	Returns a pointer to access directly the exit mask information. More...

Int_t	GetNumberOfReflections ()
	It returns the total number of reflections. Considering maximum 1-reflection per mirror. More...

virtual std::pair< Double_t, Double_t >	GetRadialLimits ()=0
	It returns the lower/higher radius range where photons are allowed. More...

void	InitFromConfigFile ()
	Initialization of TRestAxionOptics field members through a RML file. More...

virtual void	Initialize ()
	Initialization of TRestAxionOptics members. More...

Bool_t	IsFirstMirrorReflection ()
	It returns true if the photon got reflected in the first mirror. More...

Bool_t	IsSecondMirrorReflection ()
	It returns true if the photon got reflected in the second mirror. More...

void	PrintEntranceMask ()
	Prints on screen the mask used on the entrance optics plane. More...

void	PrintExitMask ()
	Prints on screen the mask used on the exit optics plane. More...

void	PrintMasks ()
	Prints on screen the 3-optical masks used on the optics planes. More...

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

void	PrintMiddleMask ()
	Prints on screen the mask used on the middle optics plane. More...

void	PrintMirror ()
	Prints on screen the 3-optical masks used on the optics planes. More...

void	PrintPhotonTrackingSummary ()
	Prints the positions taken by the photon after ray-tracing that should have been updated using the method PropagatePhoton. More...

Double_t	PropagateMonteCarloPhoton (Double_t energy, Double_t deviation)
	It will produce a MonteCarlo photon spatially distributed in XY as defined by the GetRadialLimits method (extended by 50%), and with direction along the Z-axis with a maximum deviation angle fixed by the `deviation` input parameter. If `deviation=0` the photons will always be parallel to the z-axis. The photons will be launched from z=-3*fMirrorLength. More...

Double_t	PropagatePhoton (const TVector3 &pos, const TVector3 &dir, Double_t energy)
	Propagating photon. More...

virtual Int_t	SecondMirrorReflection (const TVector3 &pos, const TVector3 &dir)=0
	It updates the values fSecondInteractionPosition and fExitDirection. Returns 0 if is not in region. More...

	~TRestAxionOptics ()
	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	FirstMirrorReflection (const TVector3 &pos, const TVector3 &dir) override
	Implementation of first mirror interaction. It updates fFirstInteractionPosition and fMiddleDirection making use of fEntrancePosition and fEntranceDirection. More...

Int_t	SecondMirrorReflection (const TVector3 &pos, const TVector3 &dir) override
	Implementation of first mirror interaction. It updates fSecondInteractionPosition and fExitDirection making use of fMiddlePosition and fMiddleDirection. More...

Private Attributes
std::vector< Double_t >	fAlpha
	Mirror angle (alpha) in radians. See schematic figure. More...

std::vector< Double_t >	fBackVertex
	The Z-position of the cone vertex defined by the back mirrors. More...

std::vector< Double_t >	fCosAlpha
	Mirror pre-calculated cosine angle (alpha). See schematic figure. More...

std::vector< Double_t >	fCosAlpha_3
	Mirror pre-calculated cosine angle (alpha). See schematic figure. More...

TRestRingsMask *	fEntranceRingsMask = nullptr
	The rings structure to be used at entrance as an optical opaque mask. More...

TRestRingsMask *	fExitRingsMask = nullptr
	The rings structure to be used at entrance as an optical opaque mask. More...

std::vector< Double_t >	fFrontVertex
	The Z-position of the cone vertex defined by the front mirrors. More...

TRestRingsMask *	fMiddleRingsMask = nullptr
	The rings structure to be used at entrance as an optical opaque mask. More...

std::vector< Double_t >	fR1
	Entrance radius R1 in mm. See schematic figure. More...

std::vector< Double_t >	fR2
	Radius R2 in mm. See schematic figure. More...

std::vector< Double_t >	fR3
	Radius R3 in mm. See schematic figure. More...

std::vector< Double_t >	fR4
	Radius R4 in mm. See schematic figure. More...

std::vector< Double_t >	fR5
	Radius R5 in mm. See schematic figure. More...

TRestSpiderMask *	fSpiderMask = nullptr
	The spider structure to be used as an optical opaque mask (common to all planes) More...

std::vector< Double_t >	fThickness
	Mirror thickness in mm. See schematic figure. More...

std::vector< Double_t >	fXSep

Additional Inherited Members
Protected Member Functions inherited from TRestAxionOptics
Int_t	GetMirror ()
	It returns the mirror index to be used in the photon reflection. More...

virtual void	SetMirror ()=0
	It must be implemented at the inherited optics, making use of fEntrancePosition. More...

Int_t	TransportToEntrance (const TVector3 &pos, const TVector3 &dir)
	It moves the incoming particle at the entrance of the optics plane and returns the region number where the particle is entering. More...

Int_t	TransportToExit (const TVector3 &pos, const TVector3 &dir)
	It moves the incoming particle to the exit of the optics plane and returns the region number where the particle is entering. More...

Int_t	TransportToMiddle (const TVector3 &pos, const TVector3 &dir)
	It moves the incoming particle to the middle of the optics plane and returns the region number where the particle is entering. More...

	TRestAxionOptics ()
	Default constructor. More...

	TRestAxionOptics (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 inherited from TRestAxionOptics
Int_t	fCurrentMirror = -1
	During the photon propagation it keeps track of the active mirror shell. More...

TVector3	fEntranceDirection
	The particle position at the optics plane entrance. More...

TRestCombinedMask *	fEntranceMask = nullptr
	The entrance optical mask that defines a pattern with regions identified with a number. More...

TVector3	fEntrancePosition
	The particle position at the optics plane entrance. More...

TVector3	fExitDirection
	The particle position at the optics plane exit. More...

TRestCombinedMask *	fExitMask = nullptr
	The exit optical mask that defines a pattern with regions identified with a number. More...

TVector3	fExitPosition
	The particle position at the optics plane exit. More...

Bool_t	fFirstInteraction = false
	During the photon propagation it tells us if the photon interacted in the first mirror. More...

TVector3	fFirstInteractionPosition
	The particle position at the front mirror interaction point. More...

Double_t	fFocal = -1
	The calculated focal in mm. It is updated by the method TRestAxionOptics::FindFocal. More...

TVector3	fMiddleDirection
	The particle position at the optics plane middle. More...

TRestCombinedMask *	fMiddleMask = nullptr
	The middle optical mask that defines a pattern with regions identified with a number. More...

TVector3	fMiddlePosition
	The particle position at the optics plane middle. More...

Double_t	fMirrorLength = 0
	The mirror length. If all mirrors got the same length. Otherwise will be zero. More...

TRestAxionOpticsMirror *	fMirrorProperties = nullptr
	The mirror properties. More...

std::vector< std::vector< Double_t > >	fOpticsData
	The optics data table extracted from fOpticsFile. More...

std::string	fOpticsFile = ""
	An optics file that contains all the specific optics parameters. More...

TVector3	fOriginPosition
	The particle position at the origin. More...

TPad *	fPad = nullptr
	A pad pointer to be used by the drawing methods. More...

TRandom3 *	fRandom = nullptr
	Random number generator. More...

Bool_t	fSecondInteraction = false
	During the photon propagation it tells us if the photon interacted in the second mirror. More...

TVector3	fSecondInteractionPosition
	The particle position at the back mirror interaction point. 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

◆ TRestAxionWolterOptics() [1/2]

TRestAxionWolterOptics::TRestAxionWolterOptics ( )

Default constructor.

Definition at line 130 of file TRestAxionWolterOptics.cxx.

◆ TRestAxionWolterOptics() [2/2]

TRestAxionWolterOptics::TRestAxionWolterOptics	(	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 TRestAxionWolterOptics section inside the RML.

Definition at line 151 of file TRestAxionWolterOptics.cxx.

◆ ~TRestAxionWolterOptics()

TRestAxionWolterOptics::~TRestAxionWolterOptics ( )

Default destructor.

Definition at line 135 of file TRestAxionWolterOptics.cxx.

Member Function Documentation

◆ DrawMirrors()

TPad * TRestAxionWolterOptics::DrawMirrors ( )

overridevirtual

A method to to draw an optics schematic including the mirrors geometry.

Implements TRestAxionOptics.

Definition at line 414 of file TRestAxionWolterOptics.cxx.

◆ FirstMirrorReflection()

Int_t TRestAxionWolterOptics::FirstMirrorReflection	(	const TVector3 &	pos,
		const TVector3 &	dir
	)

overrideprivatevirtual

Implementation of first mirror interaction. It updates fFirstInteractionPosition and fMiddleDirection making use of fEntrancePosition and fEntranceDirection.

Implements TRestAxionOptics.

Definition at line 267 of file TRestAxionWolterOptics.cxx.

◆ GetAlpha()

std::vector< Double_t > TRestAxionWolterOptics::GetAlpha ( )

inline

It returns a vector with the values of alpha.

Definition at line 122 of file TRestAxionWolterOptics.h.

◆ GetEntrancePositionZ()

Double_t TRestAxionWolterOptics::GetEntrancePositionZ ( )

inlineoverridevirtual

It returns the entrance Z-position defined by the optical axis.

Implements TRestAxionOptics.

Definition at line 135 of file TRestAxionWolterOptics.h.

◆ GetExitPositionZ()

Double_t TRestAxionWolterOptics::GetExitPositionZ ( )

inlineoverridevirtual

It returns the exit Z-position defined by the optical axis.

Implements TRestAxionOptics.

Definition at line 141 of file TRestAxionWolterOptics.h.

◆ GetR1()

std::vector< Double_t > TRestAxionWolterOptics::GetR1 ( )

inline

It returns a vector with the values of R1.

Definition at line 92 of file TRestAxionWolterOptics.h.

◆ GetR2()

std::vector< Double_t > TRestAxionWolterOptics::GetR2 ( )

inline

It returns a vector with the values of R2.

Definition at line 98 of file TRestAxionWolterOptics.h.

◆ GetR3()

std::vector< Double_t > TRestAxionWolterOptics::GetR3 ( )

inline

It returns a vector with the values of R3.

Definition at line 104 of file TRestAxionWolterOptics.h.

◆ GetR4()

std::vector< Double_t > TRestAxionWolterOptics::GetR4 ( )

inline

It returns a vector with the values of R4.

Definition at line 110 of file TRestAxionWolterOptics.h.

◆ GetR5()

std::vector< Double_t > TRestAxionWolterOptics::GetR5 ( )

inline

It returns a vector with the values of R5.

Definition at line 116 of file TRestAxionWolterOptics.h.

◆ GetRadialLimits()

std::pair< Double_t, Double_t > TRestAxionWolterOptics::GetRadialLimits ( )

inlineoverridevirtual

It returns the lower/higher radius range where photons are allowed.

Implements TRestAxionOptics.

Definition at line 146 of file TRestAxionWolterOptics.h.

◆ GetThickness()

std::vector< Double_t > TRestAxionWolterOptics::GetThickness ( )

inline

It returns a vector with the values of mirror thickness.

Definition at line 129 of file TRestAxionWolterOptics.h.

◆ InitFromConfigFile()

void TRestAxionWolterOptics::InitFromConfigFile ( )

overridevirtual

Initialization of TRestAxionWolterOptics field members through a RML file.

Reimplemented from TRestAxionOptics.

Definition at line 358 of file TRestAxionWolterOptics.cxx.

◆ Initialize()

void TRestAxionWolterOptics::Initialize ( )

overridevirtual

Initialization of TRestAxionWolterOptics members.

Initializing Entrance mask

Initializing Middle mask

Initializing Exit mask

Reimplemented from TRestAxionOptics.

Definition at line 165 of file TRestAxionWolterOptics.cxx.

◆ PrintMetadata()

void TRestAxionWolterOptics::PrintMetadata ( )

overridevirtual

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

Reimplemented from TRestAxionOptics.

Definition at line 409 of file TRestAxionWolterOptics.cxx.

◆ PrintParameters()

void TRestAxionWolterOptics::PrintParameters ( )

It prints out the Wolter (relevant) parameters extracted from the optics data file, and other parameters calculated after those input parameters, such as the vertex and angles.

It will also evaluate the precision loss due to angle to mirror raddius transformation.

Definition at line 383 of file TRestAxionWolterOptics.cxx.

◆ PrintSpider()

void TRestAxionWolterOptics::PrintSpider ( )

It prints out the spider mask common to all the optical planes.

Definition at line 402 of file TRestAxionWolterOptics.cxx.

◆ SecondMirrorReflection()

Int_t TRestAxionWolterOptics::SecondMirrorReflection	(	const TVector3 &	pos,
		const TVector3 &	dir
	)

overrideprivatevirtual

Implementation of first mirror interaction. It updates fSecondInteractionPosition and fExitDirection making use of fMiddlePosition and fMiddleDirection.

Implements TRestAxionOptics.

Definition at line 317 of file TRestAxionWolterOptics.cxx.

◆ SetMirror()

void TRestAxionWolterOptics::SetMirror ( )

inlineoverridevirtual

It must be implemented at the inherited optics, making use of fEntrancePosition.

Implements TRestAxionOptics.

Definition at line 154 of file TRestAxionWolterOptics.h.

Field Documentation

◆ fAlpha

std::vector<Double_t> TRestAxionWolterOptics::fAlpha

private

Mirror angle (alpha) in radians. See schematic figure.

Definition at line 51 of file TRestAxionWolterOptics.h.

◆ fBackVertex

std::vector<Double_t> TRestAxionWolterOptics::fBackVertex

private

The Z-position of the cone vertex defined by the back mirrors.

Definition at line 83 of file TRestAxionWolterOptics.h.

◆ fCosAlpha

std::vector<Double_t> TRestAxionWolterOptics::fCosAlpha

private

Mirror pre-calculated cosine angle (alpha). See schematic figure.

Definition at line 74 of file TRestAxionWolterOptics.h.

◆ fCosAlpha_3

std::vector<Double_t> TRestAxionWolterOptics::fCosAlpha_3

private

Mirror pre-calculated cosine angle (alpha). See schematic figure.

Definition at line 77 of file TRestAxionWolterOptics.h.

◆ fEntranceRingsMask

TRestRingsMask* TRestAxionWolterOptics::fEntranceRingsMask = nullptr

private

The rings structure to be used at entrance as an optical opaque mask.

Definition at line 65 of file TRestAxionWolterOptics.h.

◆ fExitRingsMask

TRestRingsMask* TRestAxionWolterOptics::fExitRingsMask = nullptr

private

The rings structure to be used at entrance as an optical opaque mask.

Definition at line 71 of file TRestAxionWolterOptics.h.

◆ fFrontVertex

std::vector<Double_t> TRestAxionWolterOptics::fFrontVertex

private

The Z-position of the cone vertex defined by the front mirrors.

Definition at line 80 of file TRestAxionWolterOptics.h.

◆ fMiddleRingsMask

TRestRingsMask* TRestAxionWolterOptics::fMiddleRingsMask = nullptr

private

The rings structure to be used at entrance as an optical opaque mask.

Definition at line 68 of file TRestAxionWolterOptics.h.

◆ fR1

std::vector<Double_t> TRestAxionWolterOptics::fR1

private

Entrance radius R1 in mm. See schematic figure.

Definition at line 36 of file TRestAxionWolterOptics.h.

◆ fR2

std::vector<Double_t> TRestAxionWolterOptics::fR2

private

Radius R2 in mm. See schematic figure.

Definition at line 39 of file TRestAxionWolterOptics.h.

◆ fR3

std::vector<Double_t> TRestAxionWolterOptics::fR3

private

Radius R3 in mm. See schematic figure.

Definition at line 42 of file TRestAxionWolterOptics.h.

◆ fR4

std::vector<Double_t> TRestAxionWolterOptics::fR4

private

Radius R4 in mm. See schematic figure.

Definition at line 45 of file TRestAxionWolterOptics.h.

◆ fR5

std::vector<Double_t> TRestAxionWolterOptics::fR5

private

Radius R5 in mm. See schematic figure.

Definition at line 48 of file TRestAxionWolterOptics.h.

◆ fSpiderMask

TRestSpiderMask* TRestAxionWolterOptics::fSpiderMask = nullptr

private

The spider structure to be used as an optical opaque mask (common to all planes)

Definition at line 62 of file TRestAxionWolterOptics.h.

◆ fThickness

std::vector<Double_t> TRestAxionWolterOptics::fThickness

private

Mirror thickness in mm. See schematic figure.

Definition at line 54 of file TRestAxionWolterOptics.h.

◆ fXSep

std::vector<Double_t> TRestAxionWolterOptics::fXSep

private

Distance between mirror stacks in mm. See schematic figure. This is here calculated using the functions from https://backend.orbit.dtu.dk/ws/portalfiles/portal/122353510/phdthesis_for_DTU_orbit.pdf.

Definition at line 59 of file TRestAxionWolterOptics.h.

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

Detailed Description

RML definition

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestAxionWolterOptics() [1/2]

◆ TRestAxionWolterOptics() [2/2]

◆ ~TRestAxionWolterOptics()

Member Function Documentation

◆ DrawMirrors()

◆ FirstMirrorReflection()

◆ GetAlpha()

◆ GetEntrancePositionZ()

◆ GetExitPositionZ()

◆ GetR1()

◆ GetR2()

◆ GetR3()

◆ GetR4()

◆ GetR5()

◆ GetRadialLimits()

◆ GetThickness()

◆ InitFromConfigFile()

◆ Initialize()

◆ PrintMetadata()

◆ PrintParameters()

◆ PrintSpider()

◆ SecondMirrorReflection()

◆ SetMirror()

Field Documentation

◆ fAlpha

◆ fBackVertex

◆ fCosAlpha

◆ fCosAlpha_3

◆ fEntranceRingsMask

◆ fExitRingsMask

◆ fFrontVertex

◆ fMiddleRingsMask

◆ fR1

◆ fR2

◆ fR3

◆ fR4

◆ fR5

◆ fSpiderMask

◆ fThickness

◆ fXSep