Skip to content

Commit 3752a8b

Browse files
committed
Add detsim city documentation
1 parent f702265 commit 3752a8b

File tree

5 files changed

+50
-2
lines changed

5 files changed

+50
-2
lines changed

docs/source/detsim.rst

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
11
Detsim
22
==========
33

4-
.. caution::
5-
This page is currently not created, we are working on it. If you would like to contribute on this documentation, reach `me <[email protected]>`_!
4+
**Detsim**, from **Detector Simulation**, is a the city that simulates the *detector response* for *fast-simulated* events.
5+
A *fast-simulated* event consist of a collection of hits of position and energy desposition in the gaseous volume (left figure below). The *detecto respose* are the signals measured in the light-sensors in the form of time ordered waveforms (right figure below).
6+
7+
.. image:: images/detsim/fastsim_output.png
8+
:width: 45%
9+
.. image:: images/detsim/fullsim_output.png
10+
:width: 45%
11+
12+
13+
.. _Detsim input:
14+
15+
Input
16+
-----
17+
18+
Detsim input are NEXUS fast simulation tracks, these files must contain only the following non-empty information.
19+
20+
* ``/MC/hits``
21+
22+
.. _Detsim output:
23+
24+
Output
25+
------
26+
27+
* ``/MC/``: the data in the nexus input file is copied in the output file
28+
* ``/Run/event_map``: mapping between nexus event id and IC event id. This mapping is needed because **detsim** might split nexus events into multiple IC events
29+
* ``/Run/events``: IC event number and simulated timestamps based on **rate** configuration parameter
30+
* ``/Run/runInfo``: run number of each event
31+
* ``/pmtrd``: the PMT waveforms for each PMT
32+
* ``/sipmrd``: the SiPM waveforms for each SiPM
33+
* ``/Filters/active_hits``: nexus events without hits inside the active volume are filtered
34+
35+
.. _Detsim config:
36+
37+
Config
38+
------
39+
40+
These are the **detsim** parameters in each part of the city flow
41+
42+
.. image:: images/detsim/parameters.png
43+
:width: 55%
44+
45+
46+
Workflow
47+
--------
48+
49+
The city flow is explained in the following diagram
50+
51+
.. image:: images/detsim/workflow.png
52+
:width: 75%
53+
179 KB
Loading
126 KB
Loading
124 KB
Loading
171 KB
Loading

0 commit comments

Comments
 (0)