API Reference

Data

lf.data.rx.LFData([mat_files, data_dicts])

Manage VLF data for a single transmit-receive path.

lf.data.rx.check_mat(mat_file[, variables])

Check if a .mat file is a valid LF data mat file

lf.data.rx.load_rx_data(mat_file[, …])

Properly format an LF AWESOME receiver’s output mat file

lf.data.rx.locate_mat(data_path, date, tx, …)

Determine the four mat_files associated with the provided Tx-Rx Path

lf.data.rx.rotate_vectors(NS, EW, rx, tx[, …])

Rotate a set of tuples from N/S, E/W orientation to Radial, Azimuthal orientation

lf.data.rx.rotate_vectors_ellipse(R, Az)

Rotate a set of tuples from Radial/Azimuthal orientation to a polarization ellipse format as described by Gross (2018), with a major and minor axis amplitude components, tilt angle, and start phase.

Data Quality

Data Table

Calibration

lf.calibration.Calibration([cal_table_path, …])

LF AWESOME Receiver calibration information

lf.calibration_lut.cal_lut

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2).

Utilities

lf.utils.repeatedNans(array)

Determine the number of repeated nans in a row

lf.utils.findNans(array)

Find the start and stop location of nans

lf.utils.get_azimuth(rx, tx)

Get the azimuth angle between the receiver and transmitter

lf.utils.rot_az(angle_deg)

Determine rotation factors for rotating azimuth

lf.utils.tx_rx_midpoint(tx, rx)

Compute the location of the midpoint between transmitter and receiver

lf.utils.solar_max_time(lat, lon[, day, dates])

Calculate when the sun is most abovehead