gemlog.summarize_gps

gemlog.summarize_gps(gps_dir_pattern, station_info=None, output_file=None, t1=None, t2=None, include_SN=None, exclude_SN=None)

Read up-to-date GPS data from all Gems in a project, estimate their locations using a robust trimmed-mean method.

Parameters

  • gps_dir_pattern (str) – Path to folder or glob-style pattern describing folders containing GPS data to review.

  • station_info (str) – Path to text file containing table assigning serial numbers to network, station, and location codes.

  • output_file (str) – Path to file where output should be written (optional)

  • t1 (obspy.UTCDateTime or str) – Start time; ignore gps data before t1 (e.g., ‘2022-12-31’ or ‘2022-12-31_05:45:00’)

  • t2 (obspy.UTCDateTime or str) – End time; ignore gps data after t2

  • include_SN (list) – Serial numbers to process (default all)

  • exclude_SN (list) – Serial numbers not to process (default none)

Returns

pandas.DataFrame containing the following columns –

  • SN: serial number (str)

  • lat: calculated average latitude (float)

  • lon: calculated average longitude (float)

  • lat_SE: standard error of average latitude (float)

  • lon_SE: standard error of average longitude (float)

  • elevation: elevation provided by user (-9999 if not provided) (float)

  • starttime: time of first GPS data (obspy.UTCDateTime)

  • endtime: time of last GPS data (obspy.UTCDateTime)

  • num_samples: number of GPS strings recorded

If station_info is provided, then the following columns are also included:

  • network: network code (str)

  • station: station code (str)

  • location: location code (str)

  • elevation: elevation provided in station_info (str)