The readEvents() function - geoscience-community-codes/GISMO GitHub Wiki

The readEvents() function is used to read event metadata (origin time, lon, lat, depth, mag etc.) from various different data sources such as IRIS DMC, and catalog formats such as those produced by Seisan, Antelope, hypoinverse, hypoellipse etc., into a Catalog object.

The aim is to support the same name-value parameter pairs supported by irisFetch.m. Currently supported are:

  • startTime
  • endTime
  • eventId
  • fetchLimit
  • magnitudeType
  • minimumLongitude
  • maximumLongitude
  • minimumLatitude
  • maximumLatitude
  • minimumMagnitude
  • maximumMagnitude
  • minimumDepth
  • maximumDepth

And the two convenience parameters:

  • radialcoordinates, which is a vector [centerLatitude, centerLongitude, maximumRadius]
  • boxcoordinates, which is a vector [minimumLatitude maximumLatitude minimumLongitude maximumLongitude]

Calls to readEvents() are like:

>> catalogObject = readEvents(dataformat, 'param1', value1, ..., 'paramN', valueN)

dataformat may be:

  • 'iris' (for IRIS DMC, using irisFetch.m),
  • 'antelope' (for a CSS3.0 Antelope/Datascope database)
  • 'seisan' (for a Seisan database that uses the "Nordic" REA/YYYY/MM/ directory structure)

The aim is to also add support to read from other FDSN data centers and from other catalog formats, such as hypoinverse, hypoellipse, hypocenter, hypo71 etc.

The plan is also to optionally load arrival data too, from dataformat's that contain that information.