rest-for-physics · jgalan · Aug 30, 2022 · Feb 17, 2022 · Feb 18, 2022 · Feb 18, 2022
diff --git a/.github/workflows/validation.yml b/.github/workflows/validation.yml
@@ -80,7 +80,7 @@ jobs:
         restRoot -b -q GetMagneticField_test.C
         cd ../boundary/
         restRoot -b -q Boundaries_test.C
-    - name: Optics
+    - name: Optics Mirrors
       run: |
         source ${{ env.REST_PATH }}/thisREST.sh
         cd pipeline/metadata/optics/
@@ -91,8 +91,12 @@ jobs:
         wget https://sultan.unizar.es/axionlib-data/opticsMirror/Reflectivity_Single_Au_250_Ni_0.4.N901f
         wget https://sultan.unizar.es/axionlib-data/opticsMirror/Transmission_Single_Au_250_Ni_0.4.N901f
         python mirrors.py
-        #python optics.py
-        #python basic.py
+    - name: MCPL Optics
+      run: |
+        source ${{ env.REST_PATH }}/thisREST.sh
+        cd pipeline/metadata/optics/
+        wget https://sultan.unizar.es/axionlib-data/optics/optics.rml
+        python mcpl.py
     - name: X-ray transmission
       run: |
         source ${{ env.REST_PATH }}/thisREST.sh
@@ -114,3 +118,29 @@ jobs:
         python solarTests.py
         python solarPlot.py
         python compare.py
+
+  Ray-tracing:
+    name: Check ray-tracing processing chain
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/lobis/root-geant4-garfield:rest-for-physics
+    needs: [ build-axionlib ]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Restore cache
+      uses: actions/cache@v3
+      id: axionlib-install-cache
+      with:
+        key: ${{ env.BRANCH_NAME }}-${{ github.sha }}
+        path: ${{ env.REST_PATH }}
+    - name: XMM optics bench ray-tracing
+      run: |
+        source ${{ env.REST_PATH }}/thisREST.sh
+        export REST_NEVENTS=1000
+        export REST_RUN=100
+        wget https://sultan.unizar.es/axionlib-data/optics/xmm.rml
+        wget https://sultan.unizar.es/axionlib-data/optics/XMM.Wolter
+        wget https://sultan.unizar.es/axionlib-data/opticsMirror/Reflectivity_Single_Au_250_Ni_0.4.N901f
+        wget https://sultan.unizar.es/axionlib-data/opticsMirror/Transmission_Single_Au_250_Ni_0.4.N901f
+        restManager --c opticsBench.rml
+        restRoot ValidateXMM.C'("OpticsBench_Yaw_0.02_Dev_0.005_BabyIAXO_Run00100.root")'
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -5,6 +5,7 @@ stages:
   - build
   - loadRESTLibs
   - metadata
+  - ray-tracing
 
 before_script:
     - export USER="axion"
@@ -104,6 +105,17 @@ mirrors:
       variables:
         - $CRONJOB
 
+MCPL Optics:
+  stage: metadata
+  script:
+    - . ${CI_PROJECT_DIR}/install/thisREST.sh
+    - cd ${CI_PROJECT_DIR}/pipeline/metadata/optics/
+    - wget https://sultan.unizar.es/axionlib-data/optics/optics.rml
+    - python mcpl.py
+  except:
+      variables:
+        - $CRONJOB
+
 xRayTransmission:
   stage: metadata
   script:
@@ -131,3 +143,20 @@ solarFlux:
   except:
       variables:
         - $CRONJOB
+
+XMM optics bench ray-tracing:
+  stage: ray-tracing
+  script:
+    - . ${CI_PROJECT_DIR}/install/thisREST.sh
+    - cd ${CI_PROJECT_DIR}/pipeline/ray-tracing/
+    - export REST_NEVENTS=1000
+    - export REST_RUN=100
+    - wget https://sultan.unizar.es/axionlib-data/opticsMirror/Reflectivity_Single_Au_250_Ni_0.4.N901f
+    - wget https://sultan.unizar.es/axionlib-data/opticsMirror/Transmission_Single_Au_250_Ni_0.4.N901f
+    - wget https://sultan.unizar.es/axionlib-data/optics/xmm.rml
+    - wget https://sultan.unizar.es/axionlib-data/optics/XMM.Wolter
+    - restManager --c opticsBench.rml
+    - restRoot ValidateXMM.C'("OpticsBench_Yaw_0.05_Dev_0.005_BabyIAXO_Run00100.root")'
+  except:
+      variables:
+        - $CRONJOB
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -68,5 +68,10 @@ INSTALL(DIRECTORY ./data/
     COMPONENT install
     )
 
+INSTALL(DIRECTORY ./examples/
+    DESTINATION ./examples/axion/
+    COMPONENT install
+    )
+
 file(GLOB_RECURSE MAC "${CMAKE_CURRENT_SOURCE_DIR}/macros/*")
 INSTALL(FILES ${MAC} DESTINATION ./macros/axion)
diff --git a/README.md b/README.md
@@ -59,3 +59,10 @@ cd framework/build
 cmake -DRESTLIB_AXION=ON ../
 make -j4 install
 ```
+
+### Publications
+
+This repository makes use of the following published codes:
+- K. Altenmuller et al, REST-for-Physics, a ROOT-based framework for event oriented data analysis and combined Monte Carlo response, [Computer Physics Communications 273, April 2022, 108281](https://doi.org/10.1016/j.cpc.2021.108281).
+- S.Hoof, J.Jaeckel, T.J.Lennert, Quantifying uncertainties in the solar axion flux and their impact on determining axion model parameters, [JCAP09(2021)006](https://doi.org/10.1088/1475-7516/2021/09/006).
+- T.Kittelmann, E.Klinkby, E.B.Knudsen, P.Willendrup, X.X.Cai, K.Kanaki, Monte Carlo Particle Lists: MCPL, Computer Physics Communications 218 (2017) 17–42](http://dx.doi.org/10.17632/cby92vsv5g.1).
diff --git a/data b/data
diff --git a/examples/README.md b/examples/README.md
@@ -1 +1,3 @@
 TOBE written, say few words listing, and describing the examples, and briefly explain how to use them.
+
+- **opticsBench.rml**: It defines a simple generator with a parallel flux in order to validate the optics process.
diff --git a/examples/axionGenerator.rml b/examples/axionGenerator.rml
@@ -1,113 +1,80 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
-
-<!--This file is an example of REST simulation functionality. We process the output root file
-from restG4, converting its TRestGeant4Event to TRestDetectorSignalEvent. Observables and processes's
-internal values are saved.
--->
-
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <TRestManager name="RESTManagerSim" title="Template manager to process a simulation generated by restG4." verboseLevel="info">
-
-  <TRestRun name="axionRun" title="REST Metadata run info (template)" verboseLevel="info">
-    <parameter name="experimentName" value="babyIAXO"/>
-    <parameter name="runType" value="simulation"/>
-    <parameter name="runNumber" value="auto"/> <!-- it will find next run number from database when we use "auto" -->
-    <parameter name="runTag" value="Template"/>
-    <parameter name="runDescription" value="We launched 100000 events to check everything is ok for 1 volume and from a plane YZ."/>
-    <parameter name="user" value="${USER}"/>
-    <parameter name="verboseLevel" value="2"/>
-	<parameter name="outputFileName" value="./Run_[fExperimentName]_randomWall.root" />
-
-	<TRestAxionSolarModel name="sunPrimakoff" file="metadata.rml" verboseLevel="warning" />
-    <TRestAxionMagneticField name="bFieldBabyIAXO" file="metadata.rml"/>
-    <TRestAxionBufferGas name="helium" file="metadata.rml"/>
-    <!--<TRestAxionLikelihood name="babyIAXO" file="metadata.rml" verboseLevel="debug" />-->
-
-  </TRestRun>
-
-
-  <TRestProcessRunner name="EventProcess" verboseLevel="info">
-    <parameter name="eventsToProcess" value="10000" />
-    <parameter name="threadNumber" value="1"/>
-
-    <parameter name="inputAnalysis" value="on"/>
-    <parameter name="inputEvent" value="on"/>
-    <parameter name="outputEvent" value="on"/>
-
-	<addProcess type="TRestAxionGeneratorProcess" name="axionGen" value="ON" verboseLevel="info" >
-		<parameter name="energyStep" value="1.e-3keV" />
-
-		<parameter name="energyRange" value="(0,15)keV" /> 
-
-		<parameter name="axionMass" value="2.0e-3eV" />
-
-		<parameter name="angularDistribution" value="flux" />
-		<parameter name="angularDirection" value="(-1,0,1)mm" /> <!-- "(-1,0,5)mm"-->
-
-		<parameter name="spatialDistribution" value="circleWallXY" /> <!--circleWall or circleWallYZ or sphereIn or sphereOut -->
-		<parameter name="spatialRadius" value="6500mm" /> 
-		<parameter name="spatialOrigin" value="(10000,0,-1000)mm" /> 
-		<!--<parameter name="mode" value="nPlanRotation" />--> <!-- XYZRotation or nPlanRotation-->
-		<!--<parameter name="rotation" value="(0,-0.789,0)" />--> 
-		<!--<parameter name="normalWall" value="(-1,0,5)mm" />--> <!-- "(1,0,-10)mm"  -->
-	</addProcess>
-
-	<addProcess type="TRestAxionAnalysisProcess" name="axGen1" value="ON" verboseLevel="info" >
-		<observable name="energy" value="ON" />
-		<observable name="posX" value="ON" />
-		<observable name="posY" value="ON" />
-                <observable name="posZ" value="ON" /> 
-                <observable name="probability" value="ON" />
-	</addProcess>
-
-	<addProcess type="TRestAxionFieldPropagationProcess" name="babyMagnet" value="ON" verboseLevel="info" >
-                <parameter name="mode" value="plan" /> <!-- plan or distance -->
-                <parameter name="distance" value="30000mm" />
-                <parameter name="finalNPlan" value="(0,0,1)mm" />
-                <parameter name="finalPositionPlan" value="(0,0,10000)mm" />
-	</addProcess>
-
-	<addProcess type="TRestAxionTransmissionProcess" name="magnetWindow" value="ON" verboseLevel="info" >
-	</addProcess>
-
-	<addProcess type="TRestAxionOpticsResponseProcess" name="optics" value="ON" verboseLevel="info" >
-	</addProcess>
-
-	<addProcess type="TRestAxionTransmissionProcess" name="detectorWindow" value="ON" verboseLevel="info" >
-	</addProcess>
-
-        <addProcess type="TRestAxionAnalysisProcess" name="axGen2" value="ON" verboseLevel="info" >
-		<observable name="energy" value="ON" />
-		<observable name="posX" value="ON" />
-		<observable name="posY" value="ON" />
-                <observable name="posZ" value="ON" /> 
-                <observable name="probability" value="ON" />
-	</addProcess>
-
-	<!--	file="processes.rml"/> -->
-
-  </TRestProcessRunner>
-
-<!--
-	<TRestAxionSolarModel name="sunPrimakoff" file="metadata.rml" verboseLevel="info" />
-
-	<addTask command="sunPrimakoff->PrintMetadata()" value="ON"/>
-
-  <addTask type="processEvents" value="ON" />-->
-  <addTask command="EventProcess->RunProcess()" value="ON"/>
-
-      <!--<parameter name="outputLevel" value="internalvar" /> -->
-      <!-- options are : nooutput(0), observable(1), internalvar(2), fulloutput(3) --> -
-
-  <globals>
-    <parameter name="verboseLevel" value="essential" /> <!-- options are : silent(0), essential(1), info(2), info(3), extreme(4) -->
-    <parameter name="inputFileName" value=""/>
-
-    <searchPath value="$ENV{REST_INPUTDATA}/definitions/"/>
-
-	<variable name="PI" value="3.14" overwrite="false" />
-  </globals>
-
+    <globals>
+        <parameter name="verboseLevel" value="essential"/>
+        <!-- options are : silent(0), essential(1), info(2), info(3), extreme(4) -->
+        <parameter name="inputFileName" value=""/>
+        <parameter name="Pi" value="3.1415927"/>
+    </globals>
+    <TRestRun name="axionRun" title="BabyIAXO V1.0" verboseLevel="info">
+        <parameter name="experimentName" value="babyIAXO"/>
+        <parameter name="runType" value="simulation"/>
+        <parameter name="runNumber" value="auto"/>
+        <parameter name="runTag" value="Dummy"/>
+        <parameter name="runDescription" value=""/>
+        <parameter name="user" value="${USER}"/>
+        <parameter name="verboseLevel" value="2"/>
+        <parameter name="outputFileName" value="./Run_[fExperimentName]_[fRunTag]_PrimakoffDummy_[fRunNumber].root"/>
+        <TRestAxionSolarFlux name="combined" verboseLevel="info">
+            <parameter name="couplingType" value="g_ag"/>
+            <parameter name="couplingStrength" value="1.e-10"/>
+            <parameter name="fluxDataFile" value="Primakoff_Gianotti_201904.dat"/>
+            <parameter name="fluxSptFile" value="Dummy_Galan_202202.spt"/>
+            <parameter name="seed" value="137"/>
+        </TRestAxionSolarFlux>
+        <TRestAxionMagneticField name="bFieldBabyIAXO" title="bFieldBabyIAXO">
+            <addMagneticVolume fileName="Bykovskiy_201906.dat" position="(0,0,-4500)mm"/>
+        </TRestAxionMagneticField>
+        <TRestAxionBufferGas name="helium" verboseLevel="warning">
+            <gas name="He" density="0.0025e-6"/>
+        </TRestAxionBufferGas>
+    </TRestRun>
+    <TRestProcessRunner name="EventProcess" verboseLevel="info">
+        <parameter name="eventsToProcess" value="1000"/>
+        <parameter name="threadNumber" value="1"/>
+        <parameter name="inputAnalysis" value="on"/>
+        <parameter name="inputEvent" value="off"/>
+        <parameter name="outputEvent" value="on"/>
+        <addProcess type="TRestAxionGeneratorProcess" name="axionGen" value="ON" verboseLevel="info">
+            <parameter name="axionMass" value="5meV"/>
+            <parameter name="detectorRadius" value="75cm"/>
+        </addProcess>
+        <addProcess type="TRestAxionAnalysisProcess" name="axGen1" value="ON" verboseLevel="info">
+            <observable name="energy" value="ON"/>
+            <observable name="posX" value="ON"/>
+            <observable name="posY" value="ON"/>
+            <observable name="posZ" value="ON"/>
+        </addProcess>
+        <!-- We move the particle 1-m before origin -->
+        <addProcess type="TRestAxionTransportProcess" name="ToOpticsEntrance" zPosition="-1000">
+		</addProcess>
+        <addProcess type="TRestAxionAnalysisProcess" name="beforeOptics" value="ON" verboseLevel="info">
+            <observable name="energy" value="ON"/>
+            <observable name="posX" value="ON"/>
+            <observable name="posY" value="ON"/>
+            <observable name="posZ" value="ON"/>
+        </addProcess>
+        <addProcess type="TRestAxionFieldPropagationProcess" name="babyMagnet" value="OFF" verboseLevel="info">
+            <parameter name="center" value="(0,0,-5)m"/>
+            <parameter name="theta" value="10.*Pi/180."/>
+            <parameter name="phi" value="5.*Pi/180."/>
+            <parameter name="displacement" value="(7,-7)mm"/>
+        </addProcess>
+        <addProcess type="TRestAxionTransmissionProcess" name="magnetWindow" value="OFF" verboseLevel="info"> </addProcess>
+        <addProcess type="TRestAxionOpticsResponseProcess" name="optics" value="OFF" verboseLevel="info"> </addProcess>
+        <addProcess type="TRestAxionTransmissionProcess" name="detectorWindow" value="OFF" verboseLevel="info"> </addProcess>
+        <addProcess type="TRestAxionAnalysisProcess" name="axGen2" value="OFF" verboseLevel="info">
+            <observable name="energy" value="ON"/>
+            <observable name="posX" value="ON"/>
+            <observable name="posY" value="ON"/>
+            <observable name="posZ" value="ON"/>
+            <observable name="probability" value="ON"/>
+        </addProcess>
+    </TRestProcessRunner>
+    <!--
+		<TRestAxionSolarModel name="sunPrimakoff" file="metadata.rml" verboseLevel="info" />
+
+		<addTask command="sunPrimakoff->PrintMetadata()" value="ON"/> 
+	-->
+    <addTask command="EventProcess-&gt;RunProcess()" value="ON"/>
 </TRestManager>
-
-
-<!--paramater here is accessible to all the classes -->
diff --git a/examples/opticsBench.rml b/examples/opticsBench.rml
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<TRestManager name="RESTManagerSim" title="Template manager to process a simulation generated by restG4." verboseLevel="info">
+    <globals>
+        <parameter name="verboseLevel" value="essential"/>
+        <!-- options are : silent(0), essential(1), info(2), info(3), extreme(4) -->
+        <parameter name="inputFileName" value=""/>
+        <parameter name="Pi" value="3.1415927"/>
+        <variable name="REST_DEV" value="0.005"/>
+        <variable name="REST_YAW" value="0.05"/>
+        <variable name="REST_NEVENTS" value="1000000"/>
+        <variable name="REST_RUN" value="auto"/>
+    </globals>
+    <TRestRun name="axionRun" title="BabyIAXO V1.0" verboseLevel="info">
+        <parameter name="experimentName" value="BabyIAXO"/>
+        <parameter name="runType" value="OpticsBench"/>
+        <parameter name="runNumber" value="${REST_RUN}"/>
+        <parameter name="runTag" value="Yaw_${REST_YAW}_Dev_${REST_DEV}"/>
+        <parameter name="runDescription" value=""/>
+        <parameter name="user" value="${USER}"/>
+        <parameter name="verboseLevel" value="2"/>
+        <parameter name="outputFileName" value="[fRunType]_[fRunTag]_[fExperimentName]_Run[fRunNumber].root"/>
+        <!-- Optics definition -->
+        <TRestAxionWolterOptics file="xmm.rml"/>
+    </TRestRun>
+    <TRestProcessRunner name="EventProcess" verboseLevel="info">
+        <parameter name="eventsToProcess" value="${REST_NEVENTS}"/>
+        <parameter name="threadNumber" value="1"/>
+        <parameter name="inputAnalysis" value="on"/>
+        <parameter name="inputEvent" value="off"/>
+        <parameter name="outputEvent" value="on"/>
+        <addProcess type="TRestAxionGeneratorProcess" name="axionGen" value="ON" verboseLevel="info">
+            <parameter name="generatorType" value="flat"/>
+            <parameter name="maxEnergy" value="10"/>
+            <parameter name="axionMass" value="5meV"/>
+            <parameter name="targetRadius" value="40cm"/>
+        </addProcess>
+        <addProcess type="TRestAxionAnalysisProcess" name="axGen1" observable="all"/>
+        <!-- Moving to Z=-1000 -->
+        <addProcess type="TRestAxionTransportProcess" name="ToOpticsEntrance" zPosition="-350"/>
+        <addProcess type="TRestAxionDeviationProcess" name="deviation" devAngle="${REST_DEV}degrees" value="ON"/>
+        <addProcess type="TRestAxionAnalysisProcess" name="beforeOptics" verboseLevel="info">
+            <observable name="posX"/>
+            <observable name="posY"/>
+        </addProcess>
+        <!-- Optics response -->
+        <addProcess type="TRestAxionOpticsProcess" name="optics">
+            <parameter name="center" value="(0,0,0)"/>
+            <parameter name="yaw" value="${REST_YAW}degrees"/>
+            <parameter name="opticalAxis" value="false"/>
+            <observable name="efficiency" value="ON"/>
+        </addProcess>
+        <addProcess type="TRestAxionAnalysisProcess" name="afterOptics">
+            <observable name="posX"/>
+            <observable name="posY"/>
+        </addProcess>
+        <!-- Moving to Z=1500 -->
+        <addProcess type="TRestAxionTransportProcess" name="ToZ1500" zPosition="1500"/>
+        <addProcess type="TRestAxionAnalysisProcess" name="z1500">
+            <observable name="posX"/>
+            <observable name="posY"/>
+        </addProcess>
+        <!-- Moving to Z=7500 -->
+        <addProcess type="TRestAxionTransportProcess" name="ToFocalPoint" zPosition="7500"/>
+        <addProcess type="TRestAxionAnalysisProcess" name="focal">
+            <observable name="posX"/>
+            <observable name="posY"/>
+        </addProcess>
+    </TRestProcessRunner>
+    <addTask command="EventProcess-&gt;RunProcess()" value="ON"/>
+</TRestManager>
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		TOBE written, say few words listing, and describing the examples, and briefly explain how to use them.

		- opticsBench.rml: It defines a simple generator with a parallel flux in order to validate the optics process.