From bec7d5cf16c7edcd860029ca5ddd7c0ac2236b52 Mon Sep 17 00:00:00 2001
From: Tanner Prestegard <tanner.prestegard@ligo.org>
Date: Fri, 22 Jun 2018 09:13:32 -0500
Subject: [PATCH] Adding VOEvents for superevents
Adding API resource for creating and getting VOEvents from superevents.
---
gracedb/alerts/superevent_utils.py | 15 +-
gracedb/superevents/api/serializers.py | 105 ++++-
gracedb/superevents/buildVOEvent.py | 537 +++++++++++++++++++++++++
gracedb/superevents/utils.py | 54 ++-
4 files changed, 702 insertions(+), 9 deletions(-)
create mode 100644 gracedb/superevents/buildVOEvent.py
diff --git a/gracedb/alerts/superevent_utils.py b/gracedb/alerts/superevent_utils.py
index 27016ce57..aa23f3c36 100644
--- a/gracedb/alerts/superevent_utils.py
+++ b/gracedb/alerts/superevent_utils.py
@@ -5,7 +5,7 @@ from .main import issue_alerts
from core.urls import build_absolute_uri
from superevents.api.serializers import SupereventSerializer, \
SupereventLogSerializer, SupereventLabelSerializer, \
- SupereventEMObservationSerializer
+ SupereventEMObservationSerializer, SupereventVOEventSerializer
from superevents.shortcuts import is_superevent
import logging
@@ -110,13 +110,22 @@ def issue_alert_for_superevent_label_removal(labelling, request=None):
description = "UPDATE: {label} removed".format(label=labelling.label.name)
# Send alerts
- # TODO: should this be a 'label' alert or an 'update' alert
issue_alerts(labelling.superevent, alert_type="update", url=url,
description=description, serialized_object=None)
def issue_alert_for_superevent_voevent(voevent, request=None):
- pass
+ # Get URL for superevent webview and serialized label
+ url, serialized_object = superevent_alert_helper(voevent,
+ SupereventVOEventSerializer, request=request)
+
+ # Description
+ description = "VOEVENT: {filename}".format(filename=voevent.filename)
+
+ # Send alerts
+ issue_alerts(voevent.superevent, alert_type="update", url=url,
+ file_name=voevent.filename, description=description,
+ serialized_object=serialized_object)
def issue_alert_for_superevent_emobservation(emobservation, request=None):
diff --git a/gracedb/superevents/api/serializers.py b/gracedb/superevents/api/serializers.py
index acac88e09..cc0f30274 100644
--- a/gracedb/superevents/api/serializers.py
+++ b/gracedb/superevents/api/serializers.py
@@ -377,6 +377,18 @@ class SupereventLogTagSerializer(serializers.ModelSerializer):
class SupereventVOEventSerializer(serializers.ModelSerializer):
+ default_error_messages = {
+ 'no_gpstime': _('Cannot build a VOEvent because preferred event does '
+ 'not have a gpstime.'),
+ 'skymap_file_required': _('Skymap filename is required for initial '
+ 'and update VOEvents.'),
+ 'skymap_type_required': _('Skymap type is required for initial and '
+ 'update VOEvents.'),
+ 'skymap_not_found': _('Skymap file {filename} not found for this '
+ 'superevent.'),
+ 'skymap_image_not_found': _('Skymap image file {filename} not found '
+ 'for this superevent.'),
+ }
# Read only fields
issuer = serializers.SlugRelatedField(slug_field='username',
read_only=True)
@@ -384,16 +396,44 @@ class SupereventVOEventSerializer(serializers.ModelSerializer):
read_only=True)
links = serializers.SerializerMethodField(read_only=True)
+ # Write only fields
+ user = serializers.HiddenField(write_only=True,
+ default=serializers.CurrentUserDefault())
+ superevent = serializers.HiddenField(write_only=True,
+ default=ParentObjectDefault(context_key='superevent'))
+ skymap_type = serializers.CharField(write_only=True, required=False)
+ skymap_filename = serializers.CharField(write_only=True, required=False)
+ skymap_image_filename = serializers.CharField(write_only=True,
+ required=False)
+ vetted = serializers.BooleanField(write_only=True, default=False)
+ internal = serializers.BooleanField(write_only=True, default=True)
+ open_alert = serializers.BooleanField(write_only=True, default=False)
+ hardware_inj = serializers.BooleanField(write_only=True, default=False)
+ CoincComment = serializers.BooleanField(write_only=True, default=False)
+ ProbHasNS = serializers.FloatField(write_only=True, min_value=0,
+ max_value=1, required=False)
+ ProbHasRemnant = serializers.FloatField(write_only=True, min_value=0,
+ max_value=1, required=False)
+
class Meta:
model = VOEvent
fields = ('voevent_type', 'file_version', 'ivorn', 'created',
- 'issuer', 'filename', 'N', 'links')
+ 'issuer', 'filename', 'N', 'links', 'skymap_type',
+ 'skymap_filename', 'skymap_image_filename', 'vetted', 'internal',
+ 'open_alert', 'hardware_inj', 'CoincComment', 'ProbHasNS',
+ 'ProbHasRemnant', 'superevent', 'user')
+
+ def __init__(self, *args, **kwargs):
+ super(SupereventVOEventSerializer, self).__init__(*args, **kwargs)
+ self.fields['file_version'].read_only = True
+ self.fields['filename'].read_only = True
+ self.fields['ivorn'].read_only = True
def get_links(self, obj):
file_link = None
if obj.filename:
- file_name = "{name},{version}".format(obj.filename,
- obj.file_version)
+ file_name = "{name},{version}".format(name=obj.filename,
+ version=obj.file_version)
file_link = gracedb_reverse('superevents:superevent-file-detail',
args=[obj.superevent.superevent_id, file_name],
request=self.context.get('request', None)),
@@ -406,8 +446,63 @@ class SupereventVOEventSerializer(serializers.ModelSerializer):
}
return link_dict
- # TODO:
- # VOEvent creation!!
+ def validate(self, data):
+ data = super(SupereventVOEventSerializer, self).validate(data)
+
+ # Get data
+ superevent = data.get('superevent')
+ voevent_type = data.get('voevent_type')
+ skymap_filename = data.get('skymap_filename', None)
+ skymap_type = data.get('skymap_type', None)
+ skymap_image_filename = data.get('skymap_image_filename', None)
+
+ # Checks to do:
+ # Preferred event must have gpstime
+ if not superevent.preferred_event.gpstime:
+ self.fail('no_gpstime')
+
+ # initial and update VOEvents must have a skymap, and
+ # preliminary VOEvents can have a skymap
+ if (voevent_type in ["IN", "UP"] or
+ (voevent_type == "PR" and skymap_filename != None)):
+
+ # Check skymap filename
+ if not skymap_filename:
+ self.fail('skymap_file_required')
+
+ # Check skymap type
+ if not skymap_type:
+ self.fail('skymap_type_required')
+
+ # Check if skymap fits file exists
+ full_skymap_path = os.path.join(superevent.datadir,
+ skymap_filename)
+ if not os.path.exists(full_skymap_path):
+ self.fail('skymap_not_found', filename=skymap_filename)
+
+ if skymap_image_filename:
+ full_skymap_image_path = os.path.join(superevent.datadir,
+ skymap_image_filename)
+ if not os.path.exists(full_skymap_image_path):
+ self.fail('skymap_image_not_found', filename=
+ skymap_image_filename)
+
+ return data
+
+ def create(self, validated_data):
+
+ from ..utils import create_voevent_for_superevent
+
+ # Pop some data
+ superevent = validated_data.pop('superevent')
+ issuer = validated_data.pop('user')
+
+ # Call create function - creates VOEvent object and also runs
+ # buildVOEvent to create the related file.
+ voevent = create_voevent_for_superevent(superevent, issuer,
+ **validated_data)
+
+ return voevent
class SupereventEMFootprintSerializer(serializers.ModelSerializer):
diff --git a/gracedb/superevents/buildVOEvent.py b/gracedb/superevents/buildVOEvent.py
new file mode 100644
index 000000000..101716535
--- /dev/null
+++ b/gracedb/superevents/buildVOEvent.py
@@ -0,0 +1,537 @@
+
+# Taken from VOEventLib example code, which is:
+# Copyright 2010 Roy D. Williams
+# then modified
+"""
+buildVOEvent: Creates a complex VOEvent with tables
+See the VOEvent specification for details
+http://www.ivoa.net/Documents/latest/VOEvent.html
+"""
+
+from VOEventLib.VOEvent import VOEvent, Who, Author, Param, How, What, Group
+from VOEventLib.VOEvent import Citations, EventIVORN
+from VOEventLib.Vutil import stringVOEvent
+
+from VOEventLib.VOEvent import AstroCoords, AstroCoordSystem
+from VOEventLib.VOEvent import ObservationLocation, ObservatoryLocation
+from VOEventLib.VOEvent import ObsDataLocation, WhereWhen
+from VOEventLib.VOEvent import Time, TimeInstant
+
+from core.urls import build_absolute_uri
+from core.time_utils import gpsToUtc
+from django.conf import settings
+from django.urls import reverse
+from django.utils import timezone
+from django.db.models import Min
+from events.models import CoincInspiralEvent, MultiBurstEvent, \
+ LalInferenceBurstEvent
+from .models import VOEvent as GraceDBVOEvent
+
+import os
+import logging
+logger = logging.getLogger(__name__)
+
+VOEVENT_TYPE_DICT = dict(GraceDBVOEvent.VOEVENT_TYPE_CHOICES)
+
+class VOEventBuilderException(Exception):
+ pass
+
+
+def get_voevent_type(short_name):
+ for t in GraceDBVOEvent.VOEVENT_TYPE_CHOICES:
+ if short_name in t:
+ return t[1]
+ return None
+
+
+def construct_voevent_file(superevent, voevent, request=None,
+ skymap_filename=None, skymap_type=None, skymap_image_filename=None,
+ internal=True, vetted=False, open_alert=False, hardware_inj=False,
+ CoincComment=False, ProbHasNS=None, ProbHasRemnant=None):
+
+ # Set preferred_event as event to be used in most of this
+ event = superevent.preferred_event
+
+ # Let's convert that voevent_type to something nicer looking
+ voevent_type = VOEVENT_TYPE_DICT[voevent.voevent_type]
+
+ # Now build the IVORN.
+ # XXX This will have the string '-Retraction' appended if it is a retraction,
+ # and the voevent_type will refer to the type of the *previous* voevent.
+ # This is highly objectionable.
+ type_string = voevent_type.capitalize()
+ if voevent_type == 'retraction':
+ try:
+ last_voevent = superevent.voevent_set.get(N=(voevent.N-1))
+ type_string = get_voevent_type(last_voevent.voevent_type).capitalize()
+ type_string += '-Retraction'
+ except:
+ # XXX Somehow failed to get the previous VOEvent. This is a bad situation.
+ # But we can't just error out, because sending out the retraction is pretty
+ # important.
+ type_string = 'Preliminary-Retraction'
+
+ voevent_id = "%s-%d-%s" % (superevent.superevent_id, voevent.N, type_string)
+ ivorn = settings.SKYALERT_IVORN_PATTERN % voevent_id
+
+ ############ VOEvent header ############################
+ v = VOEvent(version="2.0")
+ v.set_ivorn(ivorn)
+
+ if event.search and event.search.name == 'MDC':
+ v.set_role("test")
+ elif event.group.name == 'Test':
+ v.set_role("test")
+ else:
+ v.set_role("observation")
+ if voevent_type != 'retraction':
+ v.set_Description(settings.SKYALERT_DESCRIPTION)
+
+ ############ Who ############################
+ w = Who()
+ a = Author()
+ a.add_contactName("LIGO Scientific Collaboration and Virgo Collaboration")
+ #a.add_contactEmail("postmaster@ligo.org")
+ w.set_Author(a)
+ w.set_Date(timezone.now().strftime("%Y-%m-%dT%H:%M:%S"))
+ v.set_Who(w)
+
+ ############ How ############################
+
+ if voevent_type != 'retraction':
+ h = How()
+ h.add_Description("Candidate gravitational wave event identified by low-latency analysis")
+ instruments = event.instruments.split(',')
+ if 'H1' in instruments:
+ h.add_Description("H1: LIGO Hanford 4 km gravitational wave detector")
+ if 'L1' in instruments:
+ h.add_Description("L1: LIGO Livingston 4 km gravitational wave detector")
+ if 'V1' in instruments:
+ h.add_Description("V1: Virgo 3 km gravitational wave detector")
+ if CoincComment:
+ h.add_Description("A gravitational wave trigger identified a possible counterpart GRB")
+ v.set_How(h)
+
+ ############ What ############################
+ w = What()
+
+ # UCD = Unified Content Descriptors
+ # http://monet.uni-sw.gwdg.de/twiki/bin/view/VOEvent/UnifiedContentDescriptors
+ # OR -- (from VOTable document, [21] below)
+ # http://www.ivoa.net/twiki/bin/view/IVOA/IvoaUCD
+ # http://cds.u-strasbg.fr/doc/UCD.htx
+ #
+ # which somehow gets you to: http://www.ivoa.net/Documents/REC/UCD/UCDlist-20070402.html
+ # where you might find some actual information.
+
+ # Unit / Section 4.3 of [21] which relies on [25]
+ # [21] http://www.ivoa.net/Documents/latest/VOT.html
+ # [25] http://vizier.u-strasbg.fr/doc/catstd-3.2.htx
+ #
+ # basically, a string that makes sense to humans about what units a value is. eg. "m/s"
+
+ # Whether the alert is internal or not
+ w.add_Param(Param(name="internal", value=int(internal), dataType="int",
+ Description=['Indicates whether this event should be distributed to LSC/Virgo members only']))
+
+ # The serial number
+ w.add_Param(Param(name="Pkt_Ser_Num", value=voevent.N))
+
+ # The superevent ID
+ w.add_Param(Param(name="SupereventID",
+ dataType="string",
+ ucd="meta.id",
+ value=superevent.superevent_id,
+ Description=["Identifier in GraceDB"]))
+
+ # XXX if voevent_type == 'retraction' the AlertType will be the type of the
+ # last VOEvent sent out. This is highly objectionable.
+ alert_type = voevent_type
+
+ if voevent_type == 'retraction':
+ try:
+ last_voevent = event.voevent_set.order_by('-N')[1]
+ alert_type = get_voevent_type(last_voevent.voevent_type)
+ except:
+ # XXX We have failed to obtain the last voevent for some reason, so
+ # we don't know what the alert type should be. Let's just set it to
+ # preliminary, since we need to try not to error out of sending the
+ # retraction
+ alert_type = 'preliminary'
+
+ w.add_Param(Param(name="AlertType",
+ dataType="string",
+ ucd="meta.version",
+ unit="",
+ value = alert_type.capitalize(),
+ Description=["VOEvent alert type"]))
+
+ w.add_Param(Param(name="Retraction",
+ dataType="string",
+ ucd="meta.code",
+ unit="",
+ value= "true" if voevent_type == 'retraction' else "false",
+ Description=["Set to true if the event is retracted."]))
+
+ # Shib protected event page
+ # Whether the event is a hardware injection or not
+ w.add_Param(Param(name="HardwareInj",
+ dataType="int",
+ ucd="meta.number",
+ unit="",
+ value=int(hardware_inj),
+ Description=['Indicates that this event is a hardware injection if 1, no if 0']))
+
+ w.add_Param(Param(name="Vetted",
+ dataType="int",
+ ucd = "meta.number",
+ unit="",
+ value=int(vetted),
+ Description=['Indicates whether this candidate has undergone basic vetting by humans']))
+
+ w.add_Param(Param(name="OpenAlert",
+ dataType="int",
+ ucd="meta.number",
+ unit="",
+ value=int(open_alert),
+ Description=['Indicates that this event is an open alert if 1, no if 0']))
+
+ # TODO: fix for superevent
+ w.add_Param(Param(name="SupereventPage",
+ ucd="meta.ref.url",
+ value=build_absolute_uri(reverse("superevents:view",
+ args=[superevent.superevent_id]), request),
+ Description=["Web page for evolving status of this GW candidate"]))
+
+ if voevent_type != 'retraction':
+ # Instruments
+ w.add_Param(Param(name="Instruments",
+ dataType="string",
+ ucd="meta.code",
+ value=event.instruments,
+ Description=["List of instruments used in analysis to identify this event"]))
+
+ # False alarm rate
+ if event.far:
+ w.add_Param(Param(name="FAR",
+ dataType="float",
+ ucd="arith.rate;stat.falsealarm",
+ unit="Hz",
+ value=float(max(event.far, settings.VOEVENT_FAR_FLOOR)),
+ Description=["False alarm rate for GW candidates with this strength or greater"]))
+
+ # Group
+ w.add_Param(Param(name="Group",
+ dataType="string",
+ ucd="meta.code",
+ unit="",
+ value=event.group.name,
+ Description=["Data analysis working group"]))
+
+ # Pipeline
+ w.add_Param(Param(name="Pipeline",
+ dataType="string",
+ ucd="meta.code",
+ unit="",
+ value=event.pipeline.name,
+ Description=["Low-latency data analysis pipeline"]))
+
+ # Search
+ if event.search:
+ w.add_Param(Param(name="Search",
+ ucd="meta.code",
+ unit="",
+ dataType="string",
+ value=event.search.name,
+ Description=["Specific low-latency search"]))
+
+ # initial and update VOEvents must have a skymap.
+ # new feature (10/24/2016): preliminary VOEvents can have a skymap,
+ # but they don't have to.
+ if (voevent_type in ["initial", "update"] or
+ (voevent_type == "preliminary" and skymap_filename != None)):
+
+ fits_name = skymap_filename
+ # Let's try to get an image.
+ img_name = skymap_image_filename
+ if not img_name:
+ stem = '.'.join(fits_name.split('.')[:-1])
+ img_name = stem + '.png'
+ img_path = os.path.join(event.datadir, img_name)
+ if not os.path.exists(img_path):
+ img_name = None
+
+ # Skymaps. Create group and set particular fits and image file names
+ g = Group('GW_SKYMAP', skymap_type)
+
+ # shib, x509, and basic API urls for fits skymap file
+ # Temp function for reversing superevent file detail API resource
+ file_abs_reverse = lambda ns, file_name: build_absolute_uri(
+ reverse(ns + ":superevents:superevent-file-detail",
+ args=[superevent.superevent_id, file_name]), request)
+ shib_fits_skymap_url = file_abs_reverse('shib', fits_name)
+ x509_fits_skymap_url = file_abs_reverse('x509', fits_name)
+ basic_fits_skymap_url = file_abs_reverse('basic', fits_name)
+ if img_name:
+ shib_png_skymap_url = file_abs_reverse('shib', img_name)
+ x509_png_skymap_url = file_abs_reverse('x509', img_name)
+ basic_png_skymap_url = file_abs_reverse('basic', img_name)
+
+ # Add parameters to the skymap group
+ g.add_Param(Param(name="skymap_fits_shib",
+ dataType="string",
+ ucd="meta.ref.url",
+ unit="",
+ value=shib_fits_skymap_url,
+ Description=["Sky Map FITS Shibboleth protected"]))
+ g.add_Param(Param(name="skymap_fits_x509",
+ dataType="string",
+ ucd="meta.ref.url",
+ unit="",
+ value=x509_fits_skymap_url,
+ Description=["Sky Map FITS X509 protected"]))
+ g.add_Param(Param(name="skymap_fits_basic",
+ dataType="string",
+ ucd="meta.ref.url",
+ unit="",
+ value=basic_fits_skymap_url,
+ Description=["Sky Map FITS basic auth protected"]))
+
+ if img_name:
+ g.add_Param(Param(name="skymap_png_shib",
+ dataType="string",
+ ucd="meta.ref.url",
+ unit="",
+ value=shib_png_skymap_url,
+ Description=["Sky Map image Shibboleth protected"]))
+ g.add_Param(Param(name="skymap_png_x509",
+ dataType="string",
+ ucd="meta.ref.url",
+ unit="",
+ value=x509_png_skymap_url,
+ Description=["Sky Map image X509 protected"]))
+ g.add_Param(Param(name="skymap_png_basic",
+ dataType="string",
+ ucd="meta.ref.url",
+ unit="",
+ value=basic_png_skymap_url,
+ Description=["Sky Map image basic auth protected"]))
+
+ w.add_Group(g)
+
+ # Analysis specific attributes
+ if voevent_type != 'retraction':
+ if isinstance(event, CoincInspiralEvent) and voevent_type != 'retraction':
+ # get mchirp and mass
+ mchirp = float(event.mchirp)
+ mass = float(event.mass)
+ # calculate eta = (mchirp/total_mass)**(5/3)
+ eta = pow((mchirp/mass),5.0/3.0)
+
+ # EM-Bright mass classifier information for CBC event candidates
+ if ProbHasNS!=None:
+ w.add_Param(Param(name="ProbHasNS",
+ dataType="float",
+ ucd="stat.probability",
+ unit="",
+ value=ProbHasNS,
+ Description=["Probability that at least one object in the binary is less than 3 solar masses"]))
+
+ if ProbHasRemnant!=None:
+ w.add_Param(Param(name="ProbHasRemnant",
+ dataType="float",
+ ucd="stat.probability",
+ unit="",
+ value=ProbHasRemnant,
+ Description=["Probability that there is matter in the surroundings of the central object"]))
+
+ # build up MaxDistance. event.singleinspiral_set.all()?
+ # Each detector calculates an effective distance assuming the inspiral is
+ # optimally oriented. It is the maximum distance at which a source of the
+ # given parameters would've been seen by that particular detector. To get
+ # an effective 'maximum distance', we just find the minumum over detectors
+ max_distance = event.singleinspiral_set.all().aggregate(
+ max_dist=Min('eff_distance'))
+ max_distance = max_distance or float('inf')
+
+ elif isinstance(event, MultiBurstEvent):
+ w.add_Param(Param(name="CentralFreq",
+ dataType="float",
+ ucd="gw.frequency",
+ unit="Hz",
+ value=float(event.central_freq),
+ Description=["Central frequency of GW burst signal"]))
+ w.add_Param(Param(name="Duration",
+ dataType="float",
+ ucd="time.duration",
+ unit="s",
+ value=float(event.duration),
+ Description=["Measured duration of GW burst signal"]))
+
+ # XXX Calculate the fluence. Unfortunately, this requires parsing the trigger.txt
+ # file for hrss values. These should probably be pulled into the database.
+ # But there is no consensus on whether hrss or fluence is meaningful. So I will
+ # put off changing the schema for now.
+ try:
+ # Go find the data file.
+ log = event.eventlog_set.filter(comment__startswith="Original Data").all()[0]
+ filename = log.filename
+ filepath = os.path.join(event.datadir,filename)
+ if os.path.isfile(filepath):
+ datafile = open(filepath,"r")
+ else:
+ raise VOEventBuilderException("No file found.")
+ # Now parse the datafile.
+ # The line we want looks like:
+ # hrss: 1.752741e-23 2.101590e-23 6.418900e-23
+ for line in datafile:
+ if line.startswith('hrss:'):
+ hrss_values = [float(hrss) for hrss in line.split()[1:]]
+ max_hrss = max(hrss_values)
+ # From Min-A Cho: fluence = pi*(c**3)*(freq**2)*(hrss_max**2)*(10**3)/(4*G)
+ # Note that hrss here actually has units of s^(-1/2)
+ pi = 3.14152
+ c = 2.99792E10
+ G = 6.674E-8
+ fluence = pi * pow(c,3) * pow(event.central_freq,2)
+ fluence = fluence * pow(max_hrss,2)
+ fluence = fluence / (4.0*G)
+
+ w.add_Param(Param(name="Fluence",
+ dataType="float",
+ ucd="gw.fluence",
+ unit="erg/cm^2",
+ value=fluence,
+ Description=["Estimated fluence of GW burst signal"]))
+ except Exception as e:
+ logger.exception(e)
+
+ elif isinstance(event, LalInferenceBurstEvent):
+ w.add_Param(Param(name="frequency",
+ dataType="float",
+ ucd="gw.frequency",
+ unit="Hz",
+ value=float(event.frequency_mean),
+ Description=["Mean frequency of GW burst signal"]))
+
+ # Calculate the fluence.
+ # From Min-A Cho: fluence = pi*(c**3)*(freq**2)*(hrss_max**2)*(10**3)/(4*G)
+ # Note that hrss here actually has units of s^(-1/2)
+ # XXX obviously need to refactor here.
+ try:
+ pi = 3.14152
+ c = 2.99792E10
+ G = 6.674E-8
+ fluence = pi * pow(c,3) * pow(event.frequency,2)
+ fluence = fluence * pow(event.hrss,2)
+ fluence = fluence / (4.0*G)
+
+ w.add_Param(Param(name="Fluence",
+ dataType="float",
+ ucd="gw.fluence",
+ unit="erg/cm^2",
+ value=fluence,
+ Description=["Estimated fluence of GW burst signal"]))
+ except Exception as e:
+ logger.exception(e)
+
+ v.set_What(w)
+
+ ############ Wherewhen ############################
+# The old way of making the WhereWhen section led to a pointless position
+# location.
+# wwd = {'observatory': 'LIGO Virgo',
+# 'coord_system': 'UTC-FK5-GEO',
+# # XXX time format
+# 'time': str(gpsToUtc(event.gpstime).isoformat())[:-6], #'1918-11-11T11:11:11',
+# #'timeError': 1.0,
+# 'longitude': 0.0,
+# 'latitude': 0.0,
+# 'positionalError': 180.0,
+# }
+#
+# ww = makeWhereWhen(wwd)
+# if ww: v.set_WhereWhen(ww)
+
+ coord_system_id = 'UTC-FK5-GEO'
+ event_time = str(gpsToUtc(event.gpstime).isoformat())[:-6]
+ observatory_id = 'LIGO Virgo'
+ ac = AstroCoords(coord_system_id=coord_system_id)
+ acs = AstroCoordSystem(id=coord_system_id)
+ ac.set_Time(Time(TimeInstant = TimeInstant(event_time)))
+
+ onl = ObservationLocation(acs, ac)
+ oyl = ObservatoryLocation(id=observatory_id)
+ odl = ObsDataLocation(oyl, onl)
+ ww = WhereWhen()
+ ww.set_ObsDataLocation(odl)
+ v.set_WhereWhen(ww)
+
+ ############ Citation ############################
+ if event.voevent_set.count()>1:
+ c = Citations()
+ for ve in event.voevent_set.all():
+ # Oh, actually we need to exclude *this* voevent.
+ if ve.N == voevent.N:
+ continue
+ if voevent_type == 'initial':
+ ei = EventIVORN('supersedes', ve.ivorn)
+ c.set_Description('Initial localization is now available')
+ elif voevent_type == 'update':
+ ei = EventIVORN('supersedes', ve.ivorn)
+ c.set_Description('Updated localization is now available')
+ elif voevent_type == 'retraction':
+ ei = EventIVORN('retraction', ve.ivorn)
+ c.set_Description('Determined to not be a viable GW event candidate')
+ elif voevent_type == 'preliminary':
+ # For cases when an additional preliminary VOEvent is sent
+ # in order to add a preliminary skymap.
+ ei = EventIVORN('supersedes', ve.ivorn)
+ c.set_Description('Initial localization is now available (preliminary)')
+ c.add_EventIVORN(ei)
+
+ v.set_Citations(c)
+
+ ############ output the event ############################
+ xml = stringVOEvent(v)
+ #schemaURL = "http://www.ivoa.net/xml/VOEvent/VOEvent-v2.0.xsd")
+ return xml, ivorn
+
+
+def submitToSkyalert(superevent, validate_only=False):
+ ## Python stub code for validating and authoring VOEvents to Skyalert
+ import urllib
+ dict = {}
+
+ # the server that will handle the submit request
+ #url = "http://skyalert.org/submit/"
+ #url = "https://betelgeuse.ligo.caltech.edu:8000/submit/"
+ url = "http://betelgeuse.ligo.caltech.edu/submit/"
+
+ # choose 'dryrun' for validation and 'author' for authoring
+ dict['checker'] = 'dryrun'
+
+ # for command line, we want plain text output, not HTML
+ dict['plainResponse'] = 'on'
+
+ if not validate_only:
+ # uncomment these for authoring
+ dict['checker'] = 'author'
+
+ # Skyalert username and password
+ dict['username'] = 'system'
+ dict['password'] = 'OPV537'
+
+ # This is the short name for the stream, must match credentials and event!
+ dict['streamName'] = 'LIGO'
+
+ # Should alerts be run once the event is ingested?
+ dict['doRules'] = 'on'
+
+ dict['xmlText'] = buildVOEvent(superevent)
+ params = urllib.urlencode(dict)
+ f = urllib.urlopen(url, params)
+ result = f.read()
+ return result
+
+
diff --git a/gracedb/superevents/utils.py b/gracedb/superevents/utils.py
index 0b17c8e73..cc0f320d7 100644
--- a/gracedb/superevents/utils.py
+++ b/gracedb/superevents/utils.py
@@ -1,5 +1,8 @@
from django.shortcuts import get_object_or_404
+from .buildVOEvent import construct_voevent_file
+from .models import Superevent, Log, Labelling, EMObservation, EMFootprint, \
+ VOEvent, Signoff
from .shortcuts import is_superevent
from .models import Superevent, Log, Labelling, EMObservation, EMFootprint
from events.models import Event, EventLog, Tag
@@ -10,7 +13,8 @@ from alerts.superevent_utils import issue_alert_for_superevent_creation, \
issue_alert_for_superevent_log, \
issue_alert_for_superevent_label_creation, \
issue_alert_for_superevent_label_removal, \
- issue_alert_for_superevent_emobservation
+ issue_alert_for_superevent_emobservation, \
+ issue_alert_for_superevent_voevent
from alerts.event_utils import issue_alert_for_event_log
import os
@@ -453,3 +457,51 @@ def create_emobservation_for_superevent(superevent, submitter, ra_list,
issue_alert_for_superevent_emobservation(emo)
return emo
+
+
+def create_voevent_for_superevent(superevent, issuer, voevent_type,
+ skymap_type=None, skymap_filename=None, skymap_image_filename=None,
+ internal=True, vetted=False, open_alert=False, hardware_inj=False,
+ CoincComment=False, ProbHasNS=None, ProbHasRemnant=None,
+ add_log_message=True, issue_alert=True):
+
+ # Instantiate VOEvent object
+ voevent = VOEvent.objects.create(superevent=superevent, issuer=issuer,
+ voevent_type=voevent_type)
+
+ # Construct VOEvent file text
+ voevent_text, ivorn = construct_voevent_file(superevent, voevent,
+ skymap_type=skymap_type, skymap_filename=skymap_filename,
+ skymap_image_filename=skymap_image_filename, internal=internal,
+ vetted=vetted, open_alert=open_alert, hardware_inj=hardware_inj,
+ CoincComment=CoincComment, ProbHasNS=ProbHasNS,
+ ProbHasRemnant=ProbHasRemnant)
+
+ # Save versioned VOEvent file
+ voevent_display_type = dict(VOEvent.VOEVENT_TYPE_CHOICES) \
+ [voevent.voevent_type].capitalize()
+ voevent_filename = "{superevent}-{N}-{voevent_type}.xml".format(
+ superevent=superevent.superevent_id, N=voevent.N,
+ voevent_type=voevent_display_type)
+ version = create_versioned_file(voevent_filename, superevent.datadir,
+ voevent_text)
+
+ # Update VOEvent object
+ voevent.filename = voevent_filename
+ voevent.file_version = version
+ voevent.ivorn = ivorn
+ voevent.save(update_fields=['filename', 'file_version', 'ivorn'])
+
+ # Create a log entry to document the new VOEvent (tag it as em_follow)
+ if add_log_message:
+ comment = "New VOEvent"
+ em_follow = Tag.objects.get(name='em_follow')
+ voevent_log = create_log(issuer, comment, superevent,
+ filename=voevent.filename, file_version=voevent.file_version,
+ tags=[em_follow], issue_alert=False)
+
+ # Issue an alert
+ if issue_alert:
+ issue_alert_for_superevent_voevent(voevent)
+
+ return voevent
--
GitLab