Arrakis module for the near detector data. This module can run in two modes, stand-alone or as part of an H5Flow. Input files should be flow files from nd-larsim or data runs, which are then converted into training data sets for Blip.
Nicholas Carrara, UC Davis, Dept. of Physics [nmcarrara@ucdavis.edu],
Marjolein van Nuland, National Institute for Subatomic Physics (NIKHEF)[mnuland@nikhef.nl]
- Getting the Repository
- Quick Start
- Labeling Logic
- Usage
- Versioning
- Contact (Authors)
- Citation
- License
- Support
In the terminal, one can clone this repository by typing the command:
git clone https://personal_username@github.com/Neutron-Calibration-in-DUNE/ArrakisND.git
This uses the HTTPS protocol. For environments (e.g. computing clusters) where one has to use the SSH protocol:
git clone git@github.com:Neutron-Calibration-in-DUNE/ArrakisND.git
Anyone in the "Neutron-Calibration-in-DUNE" organization should be able to develop (push changes to the remote repository).
Please contact Nicholas Carrara, Marjolein van Nuland or Georgette Kufatty about becoming involved in development before merging with the master branch.
ArrakisND works in the same spirit as Arrakis, which is the LArSoft version of this software. The basic idea is to split up the labeling into two stages, the first of which gathers all relevant event information into various maps and arrays that can be queried easily. The TPC data is organized in the following arrays:
| Feature | Type | Description |
|---|---|---|
| x | float | position of a charge signal along the x direction |
| y | float | position of a charge signal along the y direction |
| z | float | position of a charge signal along the z direction |
| Q | float | value of the reconstructed charge signal |
The second stage consists of a set of functions, each of which processes different particles and their detector output. The labeling scheme currently consists of assigning seven different labels to each reconstructed charge/light point in the TPC. The seven labels are shown in the following tables:
| High-level features | Description |
|---|---|
| topology | topological descriptor of physics (e.g. blip, track, shower) |
| particle | the pdg code of the particle which caused the energy deposition |
| physics_micro | low-level descriptor of physics processes (e.g. mip_ionization, gamma_conversion, etc.) |
| physics_meso | mid-level descriptor of physics processes (e.g. hip, delta_electron, capture_gamma, etc.) |
| physics_macro | high-level descriptor of physics processes (e.g. cc_qe, neutron_capture, radiological, etc.) |
| unique_topology | unique identifier of individual topology instances |
| unique_particle | unique identifier of individual particle instances (i.e. track id) |
| unique_physics_* | unique identifier of individual physics instances |
For information on how each of these labels is assigned to each reconstructed point, see the documentation for BLIP which can be found at
For the versions available, see the tags on this repository.
If you have questions, please contact Nicholas Carrara, nmcarrara@ucdavis.edu.
See also the list of contributors who participate in this project.
See AUTHORS.md for information on the developers.
- Bugs: Please report bugs to the issue tracker on Github such that we can keep track of them and eventually fix them. Please explain how to reproduce the issue (including code) and which system you are running on.
- Help: Help can be provided also via the issue tracker by tagging your issue with 'question'
- Contributing: Please fork this repository then make a pull request. In this pull request, explain the details of your change and include tests.
When you use arrakis_nd, please say so in your slides or publications (for publications, see Zenodo link above). This is important for us being able to get funding to support this project.
