ltsva

Documentation for the wrapper function ltsva, which stands for Least Trimmed Squares Velocity Azimuth - estimation. This function is the main interface for users to run the processing codes in the package. See the function comments for more details.

lts_array.ltsva(st, lat_list, lon_list, window_length, window_overlap, alpha=1.0, plot_array_coordinates=False, remove_elements=None)[source]

Process infrasound or seismic array data with least trimmed squares (LTS).

Parameters:
  • st – Obspy stream object. Assumes response has been removed.
  • lat_list (list) – List of latitude values for each element in st.
  • lon_list (list) – List of longitude values for each element in st.
  • window_length (float) – Window length in seconds.
  • window_overlap (float) – Window overlap in the range (0.0 - 1.0).
  • alpha (float) – Fraction of data for LTS subsetting [0.5 - 1.0]. Choose 1.0 for ordinary least squares (default).
  • plot_array_coordinates (bool) – Plot array coordinates? Defaults to False.
  • remove_elements (list) – (Optional) Remove element number(s) from st, lat_list, and lon_list before processing. Here numbering refers to the Python index (e.g. [0] = remove 1st element in stream).
Returns:

A tuple of array processing parameters: lts_vel (array): An array of trace velocity estimates. lts_baz (array): An array of back-azimuth estimates. t (array): An array of times centered on the processing windows. mdccm (array): An array of median cross-correlation maxima. stdict (dict): A dictionary of flagged element pairs. sigma_tau (array): An array of sigma_tau values. conf_int_vel (array): An array of 95% confidence intervals for the trace velocity. conf_int_baz (array): An array of 95% confidence intervals for the back-azimuth.
Return type:

(tuple)