Source code for ligo.skymap.io.events.gracedb
# Copyright (C) 2017-2022 Leo Singer
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
import logging
from ligo.gracedb import rest
from ligo.lw import ligolw
from .base import EventSource
from .ligolw import LigoLWEventSource, _read_xml
__all__ = ('GraceDBEventSource',)
log = logging.getLogger('BAYESTAR')
def _has_psds(xmldoc):
for elem in xmldoc.getElementsByTagName(ligolw.LIGO_LW.tagName):
if elem.hasAttribute('Name') and elem.Name == 'REAL8FrequencySeries':
return True
return False
class GraceDBEventSource(EventSource):
"""Read events from GraceDB.
Parameters
----------
graceids : list
List of GraceDB ID strings.
client : `ligo.gracedb.rest.GraceDb`, optional
Client object
Returns
-------
`~ligo.skymap.io.events.EventSource`
"""
def __init__(self, graceids, client=None):
if client is None:
client = rest.GraceDb()
self._client = client
self._graceids = graceids
def __iter__(self):
return iter(self._graceids)
def __getitem__(self, graceid):
coinc_file, _ = _read_xml(self._client.files(graceid, 'coinc.xml'))
if _has_psds(coinc_file):
psd_file = coinc_file
else:
log.warning('The coinc.xml should contain a PSD, but it does not. '
'Attempting to download psd.xml.gz.')
psd_file = self._client.files(graceid, 'psd.xml.gz')
event, = LigoLWEventSource(
coinc_file, psd_file=psd_file, coinc_def=None).values()
return event
def __len__(self):
return len(self._graceids)
open = GraceDBEventSource