hermpy.data
===========

.. py:module:: hermpy.data


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/hermpy/data/data-containers/index
   /autoapi/hermpy/data/lists/index
   /autoapi/hermpy/data/spectrograms/index
   /autoapi/hermpy/data/timeseries/index
   /autoapi/hermpy/data/trajectories/index


Classes
-------

.. autoapisummary::

   hermpy.data.CrossingIntervalList
   hermpy.data.CrossingList
   hermpy.data.DurationEventList
   hermpy.data.EventList
   hermpy.data.InstantEventList


Functions
---------

.. autoapisummary::

   hermpy.data.fips_energy_bin_edges
   hermpy.data.parse_messenger_fips
   hermpy.data.add_field_magnitude
   hermpy.data.parse_messenger_mag
   hermpy.data.rotate_to_aberrated_coordinates


Package Contents
----------------

.. py:class:: CrossingIntervalList

.. py:class:: CrossingList

   .. py:method:: from_csv(csv_path: pathlib.Path, time_column='UTC') -> InstantEventList
      :classmethod:



.. py:class:: DurationEventList(table: astropy.table.QTable, start_time_column: str, end_time_column: str)

   Bases: :py:obj:`EventList`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: start_time_column


   .. py:attribute:: end_time_column


.. py:class:: EventList(table: astropy.table.QTable)

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: table


.. py:class:: InstantEventList(table: astropy.table.QTable, time_column: str)

   Bases: :py:obj:`EventList`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: time_column


.. py:function:: fips_energy_bin_edges() -> list[float]

   Returns calibration for FIPS energy channels. These are bin edges.

   Currently 'calibration' is assumed constant for all data modes.
   This is accepted within the literature and scientific community.


   Returns
   -------
   out : list[float]
       A list with an E/Q value for each of the 64 energy channels.



.. py:function:: parse_messenger_fips(file_paths: list[pathlib.Path], time_range: sunpy.time.TimeRange) -> xarray.Dataset

.. py:function:: add_field_magnitude(table: astropy.table.QTable) -> astropy.table.QTable

   A function to add magnetic field magnitude to any QTable with columns 'Bx',
   'By', and 'Bz'.
   Column '|B|' is added to the table.


.. py:function:: parse_messenger_mag(file_paths: list[pathlib.Path], time_range: sunpy.time.TimeRange) -> astropy.table.QTable

.. py:function:: rotate_to_aberrated_coordinates(table: astropy.table.QTable, time_column='UTC') -> astropy.table.QTable

   Add aberrated terms to a timeseries table, rotating around the Z axis by
   the aberration angle (updated daily). Caching of the aberration angle is
   used for quick computation. We assume an average solar wind speed of 400
   km/s.