gemlog.read_gem

gemlog.read_gem(path='raw', nums=array([0, 1, 2, ..., 9997, 9998, 9999]), SN='', units='Pa', bitweight=nan, bitweight_V=nan, bitweight_Pa=nan, verbose=True, network='', station='', location='', return_debug_output=False, require_gps=True, gps_strict_level=1)

Read raw Gem files.

Parameters

  • path (str, default '.') – Path of folder containing raw Gem data files to read.

  • nums (list or np.array of integers) – Numbers of raw Gem files to read. By default, it reads all files in ‘path’ for the specified serial number.

  • SN (str) – One Gem serial number to read. Use a loop to read multiple Gems.

  • units (str, default 'Pa') – Desired output units. Options are ‘Pa’ (Pascals), ‘V’ (Volts), or ‘counts’.

  • bitweight (float) – The value of each count when converting between counts and other units (typically Pascals, possibly Volts). By default, it looks up the correct bitweight given the Gem’s serial number and gain configuration. Leave this blank unless the Gem has been modified in a way that changes the bitweight.

  • bitweight_V (float) – The value of each count when converting between counts and Volts. By default, it looks up the correct bitweight given the Gem’s serial number and gain configuration. Leave blank unless the Gem has been modified in a way that changes the voltage bitweight.

  • bitweight_Pa (float) – The value of each count when converting between counts and Pascals. By default, it looks up the correct bitweight given the Gem’s serial number and gain configuration. Leave this blank unless the Gem has been modified in a way that changes the pressure bitweight.

  • verbose (boolean, default True) – Whether to print verbose progress messages to the screen.

  • network (str) – Two-character name of the sensor network. Leaving this blank is usually fine in subsequent data processing.

  • station (str) – Name of the station (up to five characters) to assign to the data. If not provided, uses the Gem’s serial number as the station ID.

  • location (str) – Two-character location code for this Gem. Leaving this blank is usually fine in subsequent data processing.

  • return_debug_output (boolean, default False) – If True, return extra output to understand the internal state of the function.

  • require_gps (boolean, default True) – If True, read files whether or not they have GPS data. Sample times will not be precise enough for array processing.

Returns

dict with keys –

  • data : obspy.Stream, infrasound data

  • header : pandas.dataframe, information on raw Gem data files

  • metadata : pandas.dataframe, state-of-health and other metadata time series

  • gps : pandas.dataframe, GPS timing and location values

Note

All sample times involving the Gem (and most other passive seismic/acoustic data) are in UTC; time zones are not supported.