REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Public Member Functions | Private Member Functions | Private Attributes
TRestAxionWolterOptics Class Reference

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.

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" />
<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" />
<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"/>
A metadata class accessing the Henke database to load reflectivity data.
A class that calculates the reflection path of X-rays through a Wolter 1 telescope.
A class used to define and generate a spider structure mask.

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.

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:
TRestAxionOptics TRestMetadata

Public Member Functions

 ClassDefOverride (TRestAxionWolterOptics, 1)
 
TPad * DrawMirrors () override
 A method to to draw an optics schematic including the mirrors geometry.
 
std::vector< Double_t > GetAlpha ()
 It returns a vector with the values of alpha.
 
Double_t GetEntrancePositionZ () override
 It returns the entrance Z-position defined by the optical axis.
 
Double_t GetExitPositionZ () override
 It returns the exit Z-position defined by the optical axis.
 
std::vector< Double_t > GetR1 ()
 It returns a vector with the values of R1.
 
std::vector< Double_t > GetR2 ()
 It returns a vector with the values of R2.
 
std::vector< Double_t > GetR3 ()
 It returns a vector with the values of R3.
 
std::vector< Double_t > GetR4 ()
 It returns a vector with the values of R4.
 
std::vector< Double_t > GetR5 ()
 It returns a vector with the values of R5.
 
std::pair< Double_t, Double_t > GetRadialLimits () override
 It returns the lower/higher radius range where photons are allowed.
 
std::vector< Double_t > GetThickness ()
 It returns a vector with the values of mirror thickness.
 
void InitFromConfigFile () override
 Initialization of TRestAxionWolterOptics field members through a RML file.
 
void Initialize () override
 Initialization of TRestAxionWolterOptics members. More...
 
void PrintMetadata () override
 Prints on screen the information about the metadata members of TRestAxionWolterOptics.
 
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.
 
void SetMirror () override
 It must be implemented at the inherited optics, making use of fEntrancePosition.
 
 TRestAxionWolterOptics ()
 Default constructor.
 
 TRestAxionWolterOptics (const char *cfgFileName, std::string name="")
 Constructor loading data from a config file. More...
 
 ~TRestAxionWolterOptics ()
 Default destructor.
 
- 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.
 
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...
 
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...
 
Double_t GetEntranceAngle ()
 It returns the entrance angle to the optical axis (in radians).
 
TVector3 GetEntranceDirection ()
 Returns the entrance position from the latest propagated photon.
 
TRestCombinedMask *const & GetEntranceMask () const
 Returns a pointer to access directly the entrance mask information.
 
TVector3 GetEntrancePosition ()
 Returns the entrance position from the latest propagated photon.
 
TVector3 GetExitDirection ()
 Returns the exit position from the latest propagated photon.
 
TRestCombinedMask *const & GetExitMask () const
 Returns a pointer to access directly the exit mask information.
 
TVector3 GetExitPosition ()
 Returns the exit position from the latest propagated photon.
 
TVector3 GetLastGoodDirection ()
 It returns the last valid particle direction known in the particle tracking.
 
TVector3 GetLastGoodPosition ()
 It returns the last valid particle position known in the particle tracking.
 
TVector3 GetMiddleDirection ()
 Returns the middle position from the latest propagated photon.
 
TRestCombinedMask *const & GetMiddleMask () const
 Returns a pointer to access directly the middle mask information.
 
TVector3 GetMiddlePosition ()
 Returns the middle position from the latest propagated photon.
 
TRestAxionOpticsMirror *const & GetMirrorProperties () const
 Returns a pointer to access directly the exit mask information.
 
Int_t GetNumberOfReflections ()
 It returns the total number of reflections. Considering maximum 1-reflection per mirror.
 
Bool_t IsFirstMirrorReflection ()
 It returns true if the photon got reflected in the first mirror.
 
Bool_t IsSecondMirrorReflection ()
 It returns true if the photon got reflected in the second mirror.
 
void PrintEntranceMask ()
 Prints on screen the mask used on the entrance optics plane.
 
void PrintExitMask ()
 Prints on screen the mask used on the exit optics plane.
 
void PrintMasks ()
 Prints on screen the 3-optical masks used on the optics planes.
 
void PrintMiddleMask ()
 Prints on screen the mask used on the middle optics plane.
 
void PrintMirror ()
 Prints on screen the 3-optical masks used on the optics planes.
 
void PrintPhotonTrackingSummary ()
 Prints the positions taken by the photon after ray-tracing that should have been updated using the method PropagatePhoton.
 
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.
 
Double_t PropagatePhoton (const TVector3 &pos, const TVector3 &dir, Double_t energy)
 Propagating photon. More...
 
 ~TRestAxionOptics ()
 Default destructor.
 

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.
 
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.
 

Private Attributes

std::vector< Double_t > fAlpha
 Mirror angle (alpha) in radians. See schematic figure.
 
std::vector< Double_t > fBackVertex
 The Z-position of the cone vertex defined by the back mirrors.
 
std::vector< Double_t > fCosAlpha
 Mirror pre-calculated cosine angle (alpha). See schematic figure.
 
std::vector< Double_t > fCosAlpha_3
 Mirror pre-calculated cosine angle (alpha). See schematic figure.
 
TRestRingsMaskfEntranceRingsMask = nullptr
 The rings structure to be used at entrance as an optical opaque mask.
 
TRestRingsMaskfExitRingsMask = nullptr
 The rings structure to be used at entrance as an optical opaque mask.
 
std::vector< Double_t > fFrontVertex
 The Z-position of the cone vertex defined by the front mirrors.
 
TRestRingsMaskfMiddleRingsMask = nullptr
 The rings structure to be used at entrance as an optical opaque mask.
 
std::vector< Double_t > fR1
 Entrance radius R1 in mm. See schematic figure.
 
std::vector< Double_t > fR2
 Radius R2 in mm. See schematic figure.
 
std::vector< Double_t > fR3
 Radius R3 in mm. See schematic figure.
 
std::vector< Double_t > fR4
 Radius R4 in mm. See schematic figure.
 
std::vector< Double_t > fR5
 Radius R5 in mm. See schematic figure.
 
TRestSpiderMaskfSpiderMask = nullptr
 The spider structure to be used as an optical opaque mask (common to all planes)
 
std::vector< Double_t > fThickness
 Mirror thickness in mm. See schematic figure.
 
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.
 
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.
 
 TRestAxionOptics (const char *cfgFileName, std::string name="")
 Constructor loading data from a config file. More...
 
- Protected Attributes inherited from TRestAxionOptics
Int_t fCurrentMirror = -1
 During the photon propagation it keeps track of the active mirror shell.
 
TVector3 fEntranceDirection
 The particle position at the optics plane entrance.
 
TRestCombinedMaskfEntranceMask = nullptr
 The entrance optical mask that defines a pattern with regions identified with a number.
 
TVector3 fEntrancePosition
 The particle position at the optics plane entrance.
 
TVector3 fExitDirection
 The particle position at the optics plane exit.
 
TRestCombinedMaskfExitMask = nullptr
 The exit optical mask that defines a pattern with regions identified with a number.
 
TVector3 fExitPosition
 The particle position at the optics plane exit.
 
Bool_t fFirstInteraction = false
 During the photon propagation it tells us if the photon interacted in the first mirror.
 
TVector3 fFirstInteractionPosition
 The particle position at the front mirror interaction point.
 
Double_t fFocal = -1
 The calculated focal in mm. It is updated by the method TRestAxionOptics::FindFocal.
 
TVector3 fMiddleDirection
 The particle position at the optics plane middle.
 
TRestCombinedMaskfMiddleMask = nullptr
 The middle optical mask that defines a pattern with regions identified with a number.
 
TVector3 fMiddlePosition
 The particle position at the optics plane middle.
 
Double_t fMirrorLength = 0
 The mirror length. If all mirrors got the same length. Otherwise will be zero.
 
TRestAxionOpticsMirrorfMirrorProperties = nullptr
 The mirror properties.
 
std::vector< std::vector< Double_t > > fOpticsData
 The optics data table extracted from fOpticsFile.
 
std::string fOpticsFile = ""
 An optics file that contains all the specific optics parameters.
 
TVector3 fOriginPosition
 The particle position at the origin.
 
TPad * fPad = nullptr
 A pad pointer to be used by the drawing methods.
 
TRandom3 * fRandom = nullptr
 Random number generator.
 
Bool_t fSecondInteraction = false
 During the photon propagation it tells us if the photon interacted in the second mirror.
 
TVector3 fSecondInteractionPosition
 The particle position at the back mirror interaction point.
 

Constructor & Destructor Documentation

◆ TRestAxionWolterOptics()

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
cfgFileNameA const char* giving the path to an RML file.
nameThe 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.

Member Function Documentation

◆ 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.

◆ 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.

Field Documentation

◆ 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: