mth5.clients.phoenix

Classes

PhoenixClient

Module Contents

class mth5.clients.phoenix.PhoenixClient(data_path: str | pathlib.Path, sample_rates: list[int] = [150, 24000], save_path: str | pathlib.Path | None = None, receiver_calibration_dict: dict | str | pathlib.Path = {}, sensor_calibration_dict: dict | str | pathlib.Path = {}, mth5_filename: str = 'from_phoenix.h5', **kwargs: dict)[source]

Bases: mth5.clients.base.ClientBase

property receiver_calibration_dict: dict[source]

Receiver calibrations.

Returns:: Dictionary mapping receiver IDs to calibration file paths.
Return type:: dict

Examples

>>> client = PhoenixClient('data/path')
>>> client.receiver_calibration_dict = {'RX001': Path('RX001_rxcal.json')}
>>> client.receiver_calibration_dict
{'RX001': Path('RX001_rxcal.json')}

property sensor_calibration_dict: dict[source]

Sensor calibration dictionary.

Returns:: Dictionary mapping sensor IDs to PhoenixCalibration objects.
Return type:: dict

Examples

>>> client = PhoenixClient('data/path')
>>> client.sensor_calibration_dict = {'H001': PhoenixCalibration('H001_scal.json')}
>>> client.sensor_calibration_dict['H001']
<PhoenixCalibration object>

collection[source]

make_mth5_from_phoenix(**kwargs: dict) → str | pathlib.Path | None[source]

Make an MTH5 from Phoenix files.

Split into runs, account for filters. Updates the MTH5 file with Phoenix data.

Parameters:: **kwargs (dict) – Optional keyword arguments to override instance attributes.
Returns:: Path to the saved MTH5 file.
Return type:: str, Path, or None

Examples

>>> client = PhoenixClient('data/path', save_path='output.h5')
>>> client.make_mth5_from_phoenix()
'output.h5'