query_events

gwosc.datasets.query_events(select, host='https://gwosc.org', session=None, pagesize=None)

Return a list of events filtered by the parameters in select

Parameters:
select

A list of strings where each element is a range constrain on the event parameters. All ranges should have inclusive ends (<= and => operators).

host='https://gwosc.org'

the URL of the GWOSC host to query

session=None

HTTP session to use for making requests, defaults to using a new session for each API call

pagesize=None

the number of results per page

Examples

>>> from gwosc.datasets import query_events
>>> query_events(
...     select=[
...         "mass-1-source >= 1.4",
...         "200 >= luminosity-distance >= 100",
...     ]
... )
['GW190425-v1', 'GW190425-v2', 'GW190425_081805-v3']

Notes

Operators:

  • <= (or =<)

  • => (or >=)

Parameters:

  • gps-time [s],

  • mass-1-source [solar mass],

  • mass-2-source [solar mass],

  • network-matched-filter-snr,

  • luminosity-distance [Mpc],

  • chi-eff,

  • total-mass-source [solar mass],

  • chirp-mass [solar mass],

  • chirp-mass-source [solar mass],

  • redshift,

  • far [events/year],

  • p-astro,

  • final-mass-source [solar mass],

For a full description of all parameters see https://www.gwosc.org/apidocs/#event5