obsplus.events.get_events module

Module for adding a get_events method to obspy events.

obsplus.events.get_events.get_event_summary(cat, **kwargs)[source]

Return a dataframe from a events object after applying filters.

Parameters:

  • starttime (obspy.UTCDateTime or valid input to such, optional) – Limit to events on or after the specified start time.

  • endtime (obspy.UTCDateTime or valid input to such, optional) – Limit to events on or before the specified end time.

  • minlatitude (float, optional) – Limit to events with a latitude larger than the specified minimum.

  • maxlatitude (float, optional) – Limit to events with a latitude smaller than the specified maximum.

  • minlongitude (float, optional) – Limit to events with a longitude larger than the specified minimum.

  • maxlongitude (float, optional) – Limit to events with a longitude smaller than the specified maximum.

  • latitude (float, optional) – Specify the latitude to be used for a radius search.

  • longitude (float, optional) – Specify the longitude to the used for a radius search.

  • minradius (float, optional) – Limit to events within the specified minimum number of degrees from the geographic point defined by the latitude and longitude parameters.

  • maxradius (float, optional) – Limit to events within the specified maximum number of degrees from the geographic point defined by the latitude and longitude parameters.

  • mindepth (float, optional) – Limit to events with depth, in kilometers, larger than the specified minimum.

  • maxdepth (float, optional) – Limit to events with depth, in kilometers, smaller than the specified maximum.

  • minmagnitude (float, optional) – Limit to events with a magnitude larger than the specified minimum.

  • maxmagnitude (float, optional) – Limit to events with a magnitude smaller than the specified maximum.

  • magnitudetype (str, optional) – Specify a magnitude type to use for testing the minimum and maximum limits.

  • eventid (str (or sequence of such), optional) – Select specific event(s) by ID.

  • limit (int, optional) – Limit the results to the specified number of events.

  • offset (int, optional) – Return results starting at the event count specified, starting at 1.

  • contributor (str, optional) – Limit to events contributed by a specified contributor.

  • updatedafter (obspy.UTCDateTime or valid input to such, optional) – Limit to events updated after the specified time.

  • degrees (int, default True) – If False, the parameters maxradius and minradius are specified in m rather than degrees. Note: this parameter may not be supported by non-obsplus event clients.

Return type:

DataFrame

obsplus.events.get_events.get_events(cat, **kwargs)[source]

Return a subset of a events filtered on input parameters.

Parameters:

  • starttime (obspy.UTCDateTime or valid input to such, optional) – Limit to events on or after the specified start time.

  • endtime (obspy.UTCDateTime or valid input to such, optional) – Limit to events on or before the specified end time.

  • minlatitude (float, optional) – Limit to events with a latitude larger than the specified minimum.

  • maxlatitude (float, optional) – Limit to events with a latitude smaller than the specified maximum.

  • minlongitude (float, optional) – Limit to events with a longitude larger than the specified minimum.

  • maxlongitude (float, optional) – Limit to events with a longitude smaller than the specified maximum.

  • latitude (float, optional) – Specify the latitude to be used for a radius search.

  • longitude (float, optional) – Specify the longitude to the used for a radius search.

  • minradius (float, optional) – Limit to events within the specified minimum number of degrees from the geographic point defined by the latitude and longitude parameters.

  • maxradius (float, optional) – Limit to events within the specified maximum number of degrees from the geographic point defined by the latitude and longitude parameters.

  • mindepth (float, optional) – Limit to events with depth, in kilometers, larger than the specified minimum.

  • maxdepth (float, optional) – Limit to events with depth, in kilometers, smaller than the specified maximum.

  • minmagnitude (float, optional) – Limit to events with a magnitude larger than the specified minimum.

  • maxmagnitude (float, optional) – Limit to events with a magnitude smaller than the specified maximum.

  • magnitudetype (str, optional) – Specify a magnitude type to use for testing the minimum and maximum limits.

  • eventid (str (or sequence of such), optional) – Select specific event(s) by ID.

  • limit (int, optional) – Limit the results to the specified number of events.

  • offset (int, optional) – Return results starting at the event count specified, starting at 1.

  • contributor (str, optional) – Limit to events contributed by a specified contributor.

  • updatedafter (obspy.UTCDateTime or valid input to such, optional) – Limit to events updated after the specified time.

  • degrees (int, default True) – If False, the parameters maxradius and minradius are specified in m rather than degrees. Note: this parameter may not be supported by non-obsplus event clients.

Return type:

Catalog