hermpy.data

Submodules

• hermpy.data.data-containers
• hermpy.data.lists
• hermpy.data.spectrograms
• hermpy.data.timeseries
• hermpy.data.trajectories

Classes

CrossingIntervalList
CrossingList
DurationEventList	Helper class that provides a standard way to create an ABC using
EventList	Helper class that provides a standard way to create an ABC using
InstantEventList	Helper class that provides a standard way to create an ABC using

Functions

fips_energy_bin_edges(→ list[float])	Returns calibration for FIPS energy channels. These are bin edges.
parse_messenger_fips(→ xarray.Dataset)
add_field_magnitude(→ astropy.table.QTable)	A function to add magnetic field magnitude to any QTable with columns 'Bx',
parse_messenger_mag(→ astropy.table.QTable)
rotate_to_aberrated_coordinates(→ astropy.table.QTable)	Add aberrated terms to a timeseries table, rotating around the Z axis by

Package Contents

class hermpy.data.CrossingIntervalList

class hermpy.data.CrossingList

classmethod from_csv(csv_path: pathlib.Path, time_column='UTC') → InstantEventList

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

Bases: EventList

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

start_time_column

end_time_column

class hermpy.data.EventList(table: astropy.table.QTable)

Bases: abc.ABC

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

table

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

Bases: EventList

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

time_column

hermpy.data.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

outlist[float]

A list with an E/Q value for each of the 64 energy channels.

hermpy.data.parse_messenger_fips(file_paths: list[pathlib.Path], time_range: sunpy.time.TimeRange) → xarray.Dataset

hermpy.data.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.

hermpy.data.parse_messenger_mag(file_paths: list[pathlib.Path], time_range: sunpy.time.TimeRange) → astropy.table.QTable

hermpy.data.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.