==========
ChunkInput
==========

Link to source: `ChunkInput <https://github.com/XENONnT/fuse/blob/master/fuse/plugins/micro_physics/input.py>`_ 

Plugin Description
==================
Plugin to read XENONnT Geant4 root or csv files.

The plugin can distribute the events in time based on a source rate
and will create multiple chunks of data if needed.


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

.. code-block:: python

   depends_on = ()
   provides = ('geant4_interactions',)
   data_kind = geant4_interactions
   __version__ = 0.4.1


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

geant4_interactions
-------------------

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

   * - Field Name
     - Data Type
     - Comment
   * - x
     - float32
     - x position of the energy deposit [cm]
   * - y
     - float32
     - y position of the energy deposit [cm]
   * - z
     - float32
     - z position of the energy deposit [cm]
   * - t
     - float64
     - Time with respect to the start of the event [ns]
   * - ed
     - float32
     - Energy deposit [keV]
   * - type
     - <U18
     - Particle type
   * - trackid
     - int16
     - Geant4 track ID
   * - parenttype
     - <U18
     - Particle type of the parent particle
   * - parentid
     - int16
     - Trackid of the parent particle
   * - creaproc
     - <U25
     - Geant4 process creating the particle
   * - edproc
     - <U25
     - Geant4 process responsible for the energy deposit
   * - eventid
     - int32
     - Geant4 event ID
   * - x_pri
     - float32
     - x position of the primary particle [cm]
   * - y_pri
     - float32
     - y position of the primary particle [cm]
   * - z_pri
     - float32
     - z position of the primary particle [cm]
   * - 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
   * - cut_by_eventid
     - False
     - True
     - If selected, the next two arguments act on the G4 event id, and not the entry number (default)
   * - cut_delayed
     - 1e+18
     - True
     - All interactions happening after this time (including the event time) will be cut
   * - 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
   * - entry_start
     - 0
     - True
     - Geant4 event to start simulation from
   * - entry_stop
     - None
     - True
     - Geant4 event to stop simulation at. If None, all events are simulated
   * - file_name
     - <OMITTED>
     - False
     - Name of the input file
   * - first_chunk_left
     - 1000000.0
     - True
     - Time left of the first chunk
   * - fixed_event_spacing
     - False
     - True
     - If True, the events will be spaced with a fixed time difference of 1/source_rate
   * - last_chunk_length
     - 100000000.0
     - True
     - Time length of the last chunk
   * - maximal_er_energy
     - 10
     - True
     - Filter only nuclear recoil events (maximum ER energy deposit 10 keV)
   * - n_interactions_per_chunk
     - 100000.0
     - True
     - Minimum number of interaction per chunk
   * - nr_only
     - False
     - True
     - Filter only nuclear recoil events (maximum ER energy deposit according to maximal_er_energy)
   * - path
     - <OMITTED>
     - False
     - Path to the input file
   * - separation_scale
     - 100000000.0
     - True
     - Separation scale for the dynamic chunking in [ns]
   * - source_rate
     - 1
     - True
     - Source rate used to generate event times in 1/s.Use a value >0 to generate event times in fuseUse source_rate = 0 to use event times from the input file (only for csv input)
   * - subtract_first_interaction_time
     - True
     - True
     - If True, the time of the first interaction of each event is subtracted when source_rate > 0, before the random sampled event time is added.
   * - 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="213pt" height="44pt"
     viewBox="0.00 0.00 213.38 44.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 40)">
    <title>%3</title>
    <polygon fill="white" stroke="transparent" points="-4,4 -4,-40 209.38,-40 209.38,4 -4,4"/>
    <!-- geant4_interactions -->
    <g id="node1" class="node">
    <title>geant4_interactions</title>
    <g id="a_node1"><a xlink:href="#geant4-interactions" xlink:title="geant4_interactions">
    <ellipse fill="#40c4f3" stroke="black" cx="102.69" cy="-18" rx="102.88" ry="18"/>
    <text text-anchor="middle" x="102.69" y="-14.3" font-family="Times,serif" font-size="14.00">geant4_interactions</text>
    </a>
    </g>
    </g>
    </g>
    </svg>