.. _gallery_nb_gallery_example_eventdata.ipynb:

Handling event data
===================

.. code:: ipython3

    from openkm3.store import KM3Store
    store = KM3Store()


.. parsed-literal::

    INFO:root:Loaded catalog from cache.


.. code:: ipython3

    store.list("evts20_01")



One week of ORCA 4-line data
----------------------------

+---------------------+---------------------+--------------------------------------------------+
| Identifier          | Title               | Description                                      |
+=====================+=====================+==================================================+
| evts20\_01\_file1   | ORCA4 events file   | Events from data taking with 4 strings of ORCA   |
+---------------------+---------------------+--------------------------------------------------+


.. code:: ipython3

    evts = store.get("evts20_01_file1")


.. parsed-literal::

    INFO:root:Loaded entry evts20_01_file1 as <class 'openkm3.dataclasses.HDFTable'>.


.. code:: ipython3

    evts.get_paraminfo()




.. parsed-literal::

    {'angular_error': '{"description": "place to store additional fit info for jgandalf see FitParameters.csv", "ktype": null, "path": "(event).tracks.fitinf", "type": "vec double"}',
     'azimuth': '{"parameters": {"x_param": "(event).tracks.dir_x:0", "y_param": "(event).tracks.dir_y:0"}, "description": "azimuth", "expression": "((km.phi_separg(np.array([x_param]), np.array([y_param])) + np.pi)%(2*np.pi)).item()", "imports": {"km": "km3pipe.math", "np": "numpy"}}',
     'dirz': '{"description": "track direction", "ktype": null, "path": "(event).tracks.dir_z", "type": "vec"}',
     'energy': '{"description": "Energy (either MC truth or reconstructed)", "ktype": null, "path": "(event).tracks.E", "type": "double"}',
     'mjd': '{"parameters": {"t_sec": "(event).t_sec", "t_ns": "(event).t_ns", "t_track": "(event).tracks.t:0"}, "description": "Julian date", "expression": "astro.Time(t_sec+(t_ns+t_track)/1.e9, format=\'unix\').mjd", "imports": {"astro": "astropy.time"}}',
     'nhit': '{"description": "place to store additional fit info for jgandalf see FitParameters.csv", "ktype": null, "path": "(event).tracks.fitinf", "type": "vec double"}',
     'quality': '{"description": "likelihood or lambda value (for aafit: lambda)", "ktype": null, "path": "(event).tracks.lik", "type": "double"}'}



.. code:: ipython3

    evts.conditions




.. parsed-literal::

    {'instrument': {'ORCA': {'runtypes': 'PHYS.1907v1-TUNEDSEAv2.190722-ACOU4Waves-AllTrigger-L1.20',
       'contraints': {'runtype': 'PHYSICS',
        'priority': '1',
        'duration': '>2h',
        'timedifference': '|(UTCmax-UTCmin)-Livetime| < 100 s',
        'HRVfraction': '< 0.2'}}},
     'selection': {'triggermask': {'parameter': '(event).trigger_mask',
       'constraint': 'x == 22'}}}



.. code:: ipython3

    df = evts.get_dataframe()
    df.plot(kind = "area", x="dirz", y="azimuth")




.. parsed-literal::

    <AxesSubplot:xlabel='dirz'>




.. image:: images/example_eventdata_0.png


.. code:: ipython3

    df.head(5)




.. raw:: html

    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }
    
        .dataframe tbody tr th {
            vertical-align: top;
        }
    
        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>angular_error</th>
          <th>azimuth</th>
          <th>dirz</th>
          <th>energy</th>
          <th>internalID</th>
          <th>mjd</th>
          <th>nhit</th>
          <th>quality</th>
          <th>group_id</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.004341</td>
          <td>5.108108</td>
          <td>-0.968124</td>
          <td>22.017775</td>
          <td>km3net.44.6151.000001</td>
          <td>58749.531438</td>
          <td>0.004535</td>
          <td>142.238125</td>
          <td>0</td>
        </tr>
        <tr>
          <th>1</th>
          <td>0.001181</td>
          <td>3.358250</td>
          <td>-0.990520</td>
          <td>128.639694</td>
          <td>km3net.44.6151.000002</td>
          <td>58749.531439</td>
          <td>0.001210</td>
          <td>372.726925</td>
          <td>1</td>
        </tr>
        <tr>
          <th>2</th>
          <td>0.003534</td>
          <td>6.146142</td>
          <td>-0.744035</td>
          <td>24.362326</td>
          <td>km3net.44.6151.000003</td>
          <td>58749.531461</td>
          <td>0.003501</td>
          <td>218.697835</td>
          <td>2</td>
        </tr>
        <tr>
          <th>3</th>
          <td>0.008247</td>
          <td>2.954967</td>
          <td>-0.784588</td>
          <td>15.714084</td>
          <td>km3net.44.6151.000004</td>
          <td>58749.531461</td>
          <td>0.008116</td>
          <td>93.015961</td>
          <td>3</td>
        </tr>
        <tr>
          <th>4</th>
          <td>0.006967</td>
          <td>5.618736</td>
          <td>-0.529338</td>
          <td>137.616933</td>
          <td>km3net.44.6151.000005</td>
          <td>58749.531441</td>
          <td>0.006780</td>
          <td>161.199415</td>
          <td>4</td>
        </tr>
      </tbody>
    </table>
    </div>




.. only:: html

    .. container:: sphx-glr-download

        **Download python script:** :download:`example_eventdata.py`

        **Download Jupyter notebook:** :download:`example_eventdata.ipynb`