<commit_before>============
Event format
============

All data available for the current event is stored in the event data structure. Input plugins are required to fill the event with a bare amount of raw information. Transform plugins subsequently add their processed variables. 

.. autoclass:: pax.datastructure.Event
    :members:
    :undoc-members:

There are variables within the class that refer to :class:`pax.datastructure.Peak` and :class:`pax.datastructure.ReconstructedPosition` objects.  These have their own class structure.  For example, both S1 and S2 peaks follow the following syntax.

.. autoclass:: pax.datastructure.Peak
    :members:
    :undoc-members:<commit_msg>Update format.rst<commit_after>============
Event format
============

In this document, we explain the `pax` event class.  This even class is central to how `pax` works but also in how you analyze the resulting data.



All data available for the current event is stored in the event data structure. Input plugins are required to fill the event with a bare amount of raw information. Transform plugins subsequently add their processed variables. 


.. autoclass:: pax.datastructure.Event
    :members:
    :undoc-members:

There are variables within the class that refer to :class:`pax.datastructure.Peak` and :class:`pax.datastructure.ReconstructedPosition` objects.  These have their own class structure.  For example, both S1 and S2 peaks follow the following syntax.

.. autoclass:: pax.datastructure.Peak
    :members:
    :undoc-members:
{'fraction_non_alphanumeric': 0.09393346379647749, 'fraction_numerical': 0.002609262883235486, 'mean_word_length': 4.459074733096085, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1495291', 'n_tokens_mistral': 407, 'n_tokens_neox': 394, 'n_words': 181}