======================
SecondaryScintillation
======================

Link to source: `SecondaryScintillation <https://github.com/XENONnT/fuse/blob/master/fuse/plugins/detector_physics/secondary_scintillation.py>`_ 

Plugin Description
==================
Plugin to simulate the secondary scintillation process in the gas
phase.

Technical Details
-----------------

.. code-block:: python

   depends_on = ('microphysics_summary', 'drifted_electrons', 'extracted_electrons')
   provides = ('s2_photons', 's2_photons_sum')
   data_kind = {'s2_photons': 'individual_electrons', 's2_photons_sum': 'interactions_in_roi'}
   __version__ = 0.3.0


Provided Columns
================

s2_photons
----------

.. list-table::
   :widths: 25 25 50
   :header-rows: 1

   * - Field Name
     - Data Type
     - Comment
   * - n_s2_photons
     - int32
     - Number of photons produced by the extracted electron
   * - time
     - int64
     - Start time since unix epoch [ns]
   * - endtime
     - int64
     - Exclusive end time since unix epoch [ns]

s2_photons_sum
--------------

.. list-table::
   :widths: 25 25 50
   :header-rows: 1

   * - Field Name
     - Data Type
     - Comment
   * - sum_s2_photons
     - int32
     - Sum of all photons produced by electrons originating from the same cluster
   * - time
     - int64
     - Start time since unix epoch [ns]
   * - endtime
     - int64
     - Exclusive end time since unix epoch [ns]

Config Options
==============

.. list-table::
   :widths: 25 25 10 40
   :header-rows: 1

   * - Option
     - default
     - track
     - Help
   * - debug
     - False
     - False
     - Show debug informations
   * - deterministic_seed
     - True
     - True
     - Set the random seed from lineage and run_id, or pull the seed from the OS
   * - digitizer_bits
     - take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=digitizer_bits
     - True
     - Number of bits of the digitizer boards
   * - digitizer_voltage_range
     - take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=digitizer_voltage_range
     - True
     - Voltage range of the digitizer boards [V]
   * - gain_model_mc
     - list-to-array://xedocs://pmt_area_to_pes?as_list=True&sort=pmt&detector=tpc&run_id=plugin.run_id&version=ONLINE&attr=value
     - True
     - PMT gain model
   * - p_double_pe_emision
     - take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=p_double_pe_emision
     - True
     - Probability of double photo-electron emission
   * - pmt_circuit_load_resistor
     - take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=pmt_circuit_load_resistor
     - True
     - PMT circuit load resistor [kg m^2/(s^3 A)]
   * - s2_correction_map
     - itp_map://resource://simulation_config://SIMULATION_CONFIG_FILE.json?&key=s2_correction_map&fmt=json
     - True
     - S2 correction map
   * - s2_secondary_sc_gain_mc
     - take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=s2_secondary_sc_gain
     - True
     - Secondary scintillation gain [PE/e-]
   * - se_gain_from_map
     - take://resource://SIMULATION_CONFIG_FILE.json?&fmt=json&take=se_gain_from_map
     - True
     - Boolean indication if the secondary scintillation gain is taken from a map
   * - se_gain_map
     - itp_map://resource://simulation_config://SIMULATION_CONFIG_FILE.json?&key=se_gain_map&fmt=json
     - True
     - Map of the single electron gain
   * - user_defined_random_seed
     - None
     - True
     - Define the random seed manually. You need to set deterministic_seed to False

Dependency Graph
================


.. raw:: html

    <!-- Title: %3 Pages: 1 -->
    <svg width="354pt" height="908pt"
     viewBox="0.00 0.00 353.93 908.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
    <g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 904)">
    <title>%3</title>
    <polygon fill="white" stroke="transparent" points="-4,4 -4,-904 349.93,-904 349.93,4 -4,4"/>
    <!-- s2_photons_sum -->
    <g id="node1" class="node">
    <title>s2_photons_sum</title>
    <g id="a_node1"><a xlink:href="#s2-photons-sum" xlink:title="s2_photons_sum">
    <ellipse fill="#56c46c" stroke="black" cx="91.84" cy="-882" rx="87.18" ry="18"/>
    <text text-anchor="middle" x="91.84" y="-878.3" font-family="Times,serif" font-size="14.00">s2_photons_sum</text>
    </a>
    </g>
    </g>
    <!-- microphysics_summary -->
    <g id="node2" class="node">
    <title>microphysics_summary</title>
    <g id="a_node2"><a xlink:href="#microphysics-summary" xlink:title="microphysics_summary">
    <ellipse fill="#56c46c" stroke="black" cx="143.84" cy="-594" rx="119.68" ry="18"/>
    <text text-anchor="middle" x="143.84" y="-590.3" font-family="Times,serif" font-size="14.00">microphysics_summary</text>
    </a>
    </g>
    </g>
    <!-- s2_photons_sum&#45;&gt;microphysics_summary -->
    <g id="edge1" class="edge">
    <title>s2_photons_sum&#45;&gt;microphysics_summary</title>
    <path fill="none" stroke="black" d="M80.92,-864.12C56.3,-823.75 1.9,-719.69 44.84,-648 53.55,-633.46 67.77,-622.68 82.74,-614.79"/>
    <polygon fill="black" stroke="black" points="84.65,-617.75 92.12,-610.24 81.6,-611.45 84.65,-617.75"/>
    </g>
    <!-- drifted_electrons -->
    <g id="node3" class="node">
    <title>drifted_electrons</title>
    <g id="a_node3"><a xlink:href="#drifted-electrons" xlink:title="drifted_electrons">
    <ellipse fill="#56c46c" stroke="black" cx="143.84" cy="-666" rx="89.88" ry="18"/>
    <text text-anchor="middle" x="143.84" y="-662.3" font-family="Times,serif" font-size="14.00">drifted_electrons</text>
    </a>
    </g>
    </g>
    <!-- s2_photons_sum&#45;&gt;drifted_electrons -->
    <g id="edge2" class="edge">
    <title>s2_photons_sum&#45;&gt;drifted_electrons</title>
    <path fill="none" stroke="black" d="M91.45,-863.53C91.29,-833.36 93.34,-769.93 110.84,-720 114.16,-710.54 119.39,-700.99 124.72,-692.65"/>
    <polygon fill="black" stroke="black" points="127.76,-694.4 130.45,-684.15 121.96,-690.49 127.76,-694.4"/>
    </g>
    <!-- extracted_electrons -->
    <g id="node4" class="node">
    <title>extracted_electrons</title>
    <g id="a_node4"><a xlink:href="#extracted-electrons" xlink:title="extracted_electrons">
    <ellipse fill="#f44e43" stroke="black" cx="227.84" cy="-810" rx="102.88" ry="18"/>
    <text text-anchor="middle" x="227.84" y="-806.3" font-family="Times,serif" font-size="14.00">extracted_electrons</text>
    </a>
    </g>
    </g>
    <!-- s2_photons_sum&#45;&gt;extracted_electrons -->
    <g id="edge3" class="edge">
    <title>s2_photons_sum&#45;&gt;extracted_electrons</title>
    <path fill="none" stroke="black" d="M122.7,-865.12C141.73,-855.32 166.36,-842.65 186.99,-832.02"/>
    <polygon fill="black" stroke="black" points="188.87,-835 196.16,-827.31 185.67,-828.77 188.87,-835"/>
    </g>
    <!-- interactions_in_roi -->
    <g id="node5" class="node">
    <title>interactions_in_roi</title>
    <g id="a_node5"><a xlink:href="#interactions-in-roi" xlink:title="interactions_in_roi">
    <ellipse fill="#56c46c" stroke="black" cx="96.84" cy="-378" rx="96.68" ry="18"/>
    <text text-anchor="middle" x="96.84" y="-374.3" font-family="Times,serif" font-size="14.00">interactions_in_roi</text>
    </a>
    </g>
    </g>
    <!-- microphysics_summary&#45;&gt;interactions_in_roi -->
    <g id="edge4" class="edge">
    <title>microphysics_summary&#45;&gt;interactions_in_roi</title>
    <path fill="none" stroke="black" d="M120.36,-576.14C109.48,-566.86 97.69,-554.32 91.84,-540 73.8,-495.85 82.02,-439.07 89.51,-406.09"/>
    <polygon fill="black" stroke="black" points="92.94,-406.8 91.88,-396.26 86.13,-405.16 92.94,-406.8"/>
    </g>
    <!-- quanta -->
    <g id="node6" class="node">
    <title>quanta</title>
    <g id="a_node6"><a xlink:href="#quanta" xlink:title="quanta">
    <ellipse fill="#56c46c" stroke="black" cx="143.84" cy="-522" rx="42.79" ry="18"/>
    <text text-anchor="middle" x="143.84" y="-518.3" font-family="Times,serif" font-size="14.00">quanta</text>
    </a>
    </g>
    </g>
    <!-- microphysics_summary&#45;&gt;quanta -->
    <g id="edge5" class="edge">
    <title>microphysics_summary&#45;&gt;quanta</title>
    <path fill="none" stroke="black" d="M143.84,-575.7C143.84,-567.98 143.84,-558.71 143.84,-550.11"/>
    <polygon fill="black" stroke="black" points="147.34,-550.1 143.84,-540.1 140.34,-550.1 147.34,-550.1"/>
    </g>
    <!-- electric_field_values -->
    <g id="node7" class="node">
    <title>electric_field_values</title>
    <g id="a_node7"><a xlink:href="#electric-field-values" xlink:title="electric_field_values">
    <ellipse fill="#56c46c" stroke="black" cx="228.84" cy="-450" rx="103.98" ry="18"/>
    <text text-anchor="middle" x="228.84" y="-446.3" font-family="Times,serif" font-size="14.00">electric_field_values</text>
    </a>
    </g>
    </g>
    <!-- microphysics_summary&#45;&gt;electric_field_values -->
    <g id="edge6" class="edge">
    <title>microphysics_summary&#45;&gt;electric_field_values</title>
    <path fill="none" stroke="black" d="M163.97,-576.26C174.61,-566.56 187.21,-553.6 195.84,-540 208.08,-520.72 216.74,-496.23 222.1,-477.83"/>
    <polygon fill="black" stroke="black" points="225.52,-478.61 224.82,-468.04 218.77,-476.74 225.52,-478.61"/>
    </g>
    <!-- drifted_electrons&#45;&gt;microphysics_summary -->
    <g id="edge18" class="edge">
    <title>drifted_electrons&#45;&gt;microphysics_summary</title>
    <path fill="none" stroke="black" d="M143.84,-647.7C143.84,-639.98 143.84,-630.71 143.84,-622.11"/>
    <polygon fill="black" stroke="black" points="147.34,-622.1 143.84,-612.1 140.34,-622.1 147.34,-622.1"/>
    </g>
    <!-- electrons_at_interface -->
    <g id="node13" class="node">
    <title>electrons_at_interface</title>
    <g id="a_node13"><a xlink:href="#electrons-at-interface" xlink:title="electrons_at_interface">
    <ellipse fill="#f44e43" stroke="black" cx="232.84" cy="-738" rx="113.18" ry="18"/>
    <text text-anchor="middle" x="232.84" y="-734.3" font-family="Times,serif" font-size="14.00">electrons_at_interface</text>
    </a>
    </g>
    </g>
    <!-- extracted_electrons&#45;&gt;electrons_at_interface -->
    <g id="edge19" class="edge">
    <title>extracted_electrons&#45;&gt;electrons_at_interface</title>
    <path fill="none" stroke="black" d="M229.08,-791.7C229.63,-783.98 230.29,-774.71 230.9,-766.11"/>
    <polygon fill="black" stroke="black" points="234.4,-766.33 231.62,-756.1 227.42,-765.83 234.4,-766.33"/>
    </g>
    <!-- clustered_interactions -->
    <g id="node8" class="node">
    <title>clustered_interactions</title>
    <g id="a_node8"><a xlink:href="#clustered-interactions" xlink:title="clustered_interactions">
    <ellipse fill="#fbce56" stroke="black" cx="120.84" cy="-162" rx="114.28" ry="18"/>
    <text text-anchor="middle" x="120.84" y="-158.3" font-family="Times,serif" font-size="14.00">clustered_interactions</text>
    </a>
    </g>
    </g>
    <!-- interactions_in_roi&#45;&gt;clustered_interactions -->
    <g id="edge7" class="edge">
    <title>interactions_in_roi&#45;&gt;clustered_interactions</title>
    <path fill="none" stroke="black" d="M89.96,-359.99C78.89,-330 60.06,-266.14 77.84,-216 81.5,-205.68 88.13,-195.9 95.1,-187.61"/>
    <polygon fill="black" stroke="black" points="97.72,-189.94 101.8,-180.16 92.51,-185.26 97.72,-189.94"/>
    </g>
    <!-- volume_properties -->
    <g id="node9" class="node">
    <title>volume_properties</title>
    <g id="a_node9"><a xlink:href="#volume-properties" xlink:title="volume_properties">
    <ellipse fill="#fbce56" stroke="black" cx="183.84" cy="-234" rx="96.68" ry="18"/>
    <text text-anchor="middle" x="183.84" y="-230.3" font-family="Times,serif" font-size="14.00">volume_properties</text>
    </a>
    </g>
    </g>
    <!-- interactions_in_roi&#45;&gt;volume_properties -->
    <g id="edge8" class="edge">
    <title>interactions_in_roi&#45;&gt;volume_properties</title>
    <path fill="none" stroke="black" d="M97.07,-359.98C98.06,-341.05 101.92,-310.23 115.84,-288 123.38,-275.97 134.66,-265.58 145.88,-257.27"/>
    <polygon fill="black" stroke="black" points="148.19,-259.92 154.38,-251.32 144.18,-254.18 148.19,-259.92"/>
    </g>
    <!-- volume_selection -->
    <g id="node10" class="node">
    <title>volume_selection</title>
    <g id="a_node10"><a xlink:href="#volume-selection" xlink:title="volume_selection">
    <ellipse fill="#fbce56" stroke="black" cx="214.84" cy="-306" rx="90.18" ry="18"/>
    <text text-anchor="middle" x="214.84" y="-302.3" font-family="Times,serif" font-size="14.00">volume_selection</text>
    </a>
    </g>
    </g>
    <!-- interactions_in_roi&#45;&gt;volume_selection -->
    <g id="edge9" class="edge">
    <title>interactions_in_roi&#45;&gt;volume_selection</title>
    <path fill="none" stroke="black" d="M124.51,-360.59C140.63,-351.02 161.16,-338.85 178.57,-328.52"/>
    <polygon fill="black" stroke="black" points="180.53,-331.42 187.35,-323.31 176.96,-325.4 180.53,-331.42"/>
    </g>
    <!-- quanta&#45;&gt;interactions_in_roi -->
    <g id="edge15" class="edge">
    <title>quanta&#45;&gt;interactions_in_roi</title>
    <path fill="none" stroke="black" d="M133.52,-504.36C127.61,-494.19 120.46,-480.72 115.84,-468 108.53,-447.86 103.63,-424.08 100.64,-406.17"/>
    <polygon fill="black" stroke="black" points="104.07,-405.45 99.06,-396.12 97.16,-406.54 104.07,-405.45"/>
    </g>
    <!-- quanta&#45;&gt;electric_field_values -->
    <g id="edge16" class="edge">
    <title>quanta&#45;&gt;electric_field_values</title>
    <path fill="none" stroke="black" d="M162.71,-505.46C173.86,-496.28 188.2,-484.47 200.67,-474.2"/>
    <polygon fill="black" stroke="black" points="203.05,-476.77 208.55,-467.71 198.6,-471.37 203.05,-476.77"/>
    </g>
    <!-- electric_field_values&#45;&gt;interactions_in_roi -->
    <g id="edge17" class="edge">
    <title>electric_field_values&#45;&gt;interactions_in_roi</title>
    <path fill="none" stroke="black" d="M198.23,-432.76C179.82,-423 156.19,-410.47 136.38,-399.97"/>
    <polygon fill="black" stroke="black" points="137.77,-396.74 127.29,-395.15 134.49,-402.92 137.77,-396.74"/>
    </g>
    <!-- geant4_interactions -->
    <g id="node11" class="node">
    <title>geant4_interactions</title>
    <g id="a_node11"><a xlink:href="#geant4-interactions" xlink:title="geant4_interactions">
    <ellipse fill="#40c4f3" stroke="black" cx="120.84" cy="-18" rx="102.88" ry="18"/>
    <text text-anchor="middle" x="120.84" y="-14.3" font-family="Times,serif" font-size="14.00">geant4_interactions</text>
    </a>
    </g>
    </g>
    <!-- clustered_interactions&#45;&gt;geant4_interactions -->
    <g id="edge10" class="edge">
    <title>clustered_interactions&#45;&gt;geant4_interactions</title>
    <path fill="none" stroke="black" d="M107.7,-143.91C100.92,-134.01 93.35,-120.96 89.84,-108 85.66,-92.56 85.66,-87.44 89.84,-72 92.42,-62.48 97.19,-52.92 102.22,-44.59"/>
    <polygon fill="black" stroke="black" points="105.22,-46.39 107.7,-36.09 99.34,-42.6 105.22,-46.39"/>
    </g>
    <!-- cluster_index -->
    <g id="node12" class="node">
    <title>cluster_index</title>
    <g id="a_node12"><a xlink:href="#cluster-index" xlink:title="cluster_index">
    <ellipse fill="#40c4f3" stroke="black" cx="171.84" cy="-90" rx="72.59" ry="18"/>
    <text text-anchor="middle" x="171.84" y="-86.3" font-family="Times,serif" font-size="14.00">cluster_index</text>
    </a>
    </g>
    </g>
    <!-- clustered_interactions&#45;&gt;cluster_index -->
    <g id="edge11" class="edge">
    <title>clustered_interactions&#45;&gt;cluster_index</title>
    <path fill="none" stroke="black" d="M133.19,-144.05C139.33,-135.63 146.87,-125.28 153.65,-115.97"/>
    <polygon fill="black" stroke="black" points="156.55,-117.93 159.61,-107.79 150.89,-113.81 156.55,-117.93"/>
    </g>
    <!-- volume_properties&#45;&gt;clustered_interactions -->
    <g id="edge13" class="edge">
    <title>volume_properties&#45;&gt;clustered_interactions</title>
    <path fill="none" stroke="black" d="M168.59,-216.05C160.97,-207.58 151.59,-197.17 143.18,-187.82"/>
    <polygon fill="black" stroke="black" points="145.68,-185.37 136.39,-180.28 140.48,-190.05 145.68,-185.37"/>
    </g>
    <!-- volume_selection&#45;&gt;volume_properties -->
    <g id="edge14" class="edge">
    <title>volume_selection&#45;&gt;volume_properties</title>
    <path fill="none" stroke="black" d="M207.34,-288.05C203.81,-280.09 199.52,-270.41 195.58,-261.51"/>
    <polygon fill="black" stroke="black" points="198.74,-260 191.49,-252.28 192.34,-262.84 198.74,-260"/>
    </g>
    <!-- cluster_index&#45;&gt;geant4_interactions -->
    <g id="edge12" class="edge">
    <title>cluster_index&#45;&gt;geant4_interactions</title>
    <path fill="none" stroke="black" d="M159.5,-72.05C153.45,-63.75 146.04,-53.58 139.33,-44.38"/>
    <polygon fill="black" stroke="black" points="142.15,-42.3 133.43,-36.28 136.49,-46.42 142.15,-42.3"/>
    </g>
    <!-- electrons_at_interface&#45;&gt;microphysics_summary -->
    <g id="edge21" class="edge">
    <title>electrons_at_interface&#45;&gt;microphysics_summary</title>
    <path fill="none" stroke="black" d="M240.6,-719.94C247.96,-700.99 256.1,-670.14 242.84,-648 234.13,-633.46 219.92,-622.68 204.94,-614.79"/>
    <polygon fill="black" stroke="black" points="206.09,-611.45 195.56,-610.24 203.03,-617.75 206.09,-611.45"/>
    </g>
    <!-- electrons_at_interface&#45;&gt;drifted_electrons -->
    <g id="edge20" class="edge">
    <title>electrons_at_interface&#45;&gt;drifted_electrons</title>
    <path fill="none" stroke="black" d="M211.3,-720.05C199.73,-710.96 185.32,-699.63 172.79,-689.77"/>
    <polygon fill="black" stroke="black" points="174.9,-686.98 164.88,-683.55 170.58,-692.48 174.9,-686.98"/>
    </g>
    </g>
    </svg>