Updates to VOEvent schema and contents

This merge requests include a number of fairly minor changes to the VOEvent schema and contents for events and superevents. See:

• #76 (closed)
• #77 (closed)
• #78 (closed)
• #95 (closed)
• #96 (closed)

changed milestone to %Update VOEvent schema/contents

added 6 commits

• dcd3e95f...146ab7ea - 2 commits from branch master
• 5f0dd714 - Clean up skymap URLs for VOEvents
• 9ddc3d45 - Change Retraction VOEvent field
• 49cf9d33 - Add Packet_Type param to VOEvents
• 9ef34d4d - Remove Vetted param from VOEvents

Compare with previous version

added 5 commits

• e4b2fa2e - 1 commit from branch master
• 3b59afe9 - Clean up skymap URLs for VOEvents
• 9e5d9549 - Change Retraction VOEvent field
• f615b2bf - Add Packet_Type param to VOEvents
• 89774789 - Remove Vetted param from VOEvents

Compare with previous version

added 7 commits

• 89774789...47b7fbad - 2 commits from branch master
• fa4569d8 - Clean up skymap URLs for VOEvents
• ce1e25c8 - Change Retraction VOEvent field
• d537d6ca - Add Packet_Type param to VOEvents
• bcc00ec1 - Remove Vetted param from VOEvents
• 2e453a2d - Rearrange/add p_astro and EM bright info in VOEvents

Compare with previous version

@leo-singer Please take a look at this VOEvent file and let me know if it incorporates the requested changes correctly: https://gracedb-dev2.ligo.org/api/superevents/TGW800106A/files/TGW800106A-4-Update.xml

Looks great, thank you! I suggest the following two finishing touches.

• The Packet_Type param's Description should be consistent with the value. So for example, if the value is 152, then the description should say "eg type=152 is an LVC_UPDATE notice".
• Remove the unit attribute from parameters for which it does not apply, such as flags and strings.

added 7 commits

• d311bfbc - Bugfix for superevent VOEvent Alert_Type
• 330fd177 - Clean up skymap URLs for VOEvents
• 890448ff - Change Retraction VOEvent field
• 66e32dcf - Add Packet_Type param to VOEvents
• 0d529764 - Remove Vetted param from VOEvents
• d03fcda2 - Rearrange/add p_astro and EM bright info in VOEvents
• eb2ad9b5 - Remove empty units specification from VOEvent file params

Compare with previous version

Looks great, thank you! I suggest the following two finishing touches.

• The Packet_Type param's Description should be consistent with the value. So for example, if the value is 152, then the description should say "eg type=152 is an LVC_UPDATE notice".
• Remove the unit attribute from parameters for which it does not apply, such as flags and strings.

Done, here's an example if you want to take a look: https://gracedb-dev2.ligo.org/api/superevents/TGW800106A/files/TGW800106A-21-Update.xml

@leo-singer One other thing to address is the question of differences in the filename, IVORN, and AlertType for Retractions, as we talked about on list a few weeks ago.

Right now, for retractions:

• The filename is like TGW800106A-22-Retraction.xml
• The IVORN is like ivo://gwnet/gcn_sender#TGW800106A-22-Update-Retraction (previous VOEvent was an Update)
• The AlertType is Update (again pulled from previous VOEvent)

One possible option is the following changes:

• IVORN -> ivo://gwnet/gcn_sender#TGW800106A-22-Retraction
• AlertType -> Retraction

But, looking back at Peter Shawhan's email (see below), I am not sure that this option would be OK. Let me know if this is still an issue that we need to address and if you have an idea of how to proceed.

Peter's email to the emfollow list (10/30/2018):

You can see an example of an O1-era retraction here: https://gracedb.ligo.org/events/G210910/files/G210910-2-Retraction.xml , including the Citations block.

If I remember correctly (from back in November/December 2015), the reason why the IVORNs have the form G210910-2-Preliminary-Retraction and not simply G210910-2-Retraction is because the GCN server has different notice types (LVC_PRELIMINARY, LVC_INITIAL, LVC_UPDATE) and needed to know what type was being retracted because it has to send the right flavor of GCN retraction Notice. Including that in the IVORN was the simplest solution. You should talk with Scott before changing that, to ensure that GCN would be able to get that information in another way, e.g. from the AlertType parameter inside the VOEvent. Scott's handler might only have access to the IVORN at the time it decides what GCN Notice type to assemble.

Note that a VOEvent, after the first for a trigger, that is not a retraction also has a Citations block to supersede ALL previous alerts, such as this: https://gracedb.ligo.org/events/G296853/files/G296853-5-Update.xml . I remember we decided it should work that way, rather than each VOEvent only superseding the immediately preceding VOEvent. (Otherwise, how would you interpret the retraction of a VOEvent which itself retracted another VOEvent? Would it retract the retraction?)

I guess my inclination would be to not change how IVORNs are constructed and managed unless there is an important reason to do so.

Looks great, thank you! I suggest the following two finishing touches.

• The Packet_Type param's Description should be consistent with the value. So for example, if the value is 152, then the description should say "eg type=152 is an LVC_UPDATE notice".

• Remove the unit attribute from parameters for which it does not apply, such as flags and strings. Done, here's an example if you want to take a look: https://gracedb-dev2.ligo.org/api/superevents/TGW800106A/files/TGW800106A-21-Update.xml

I get an HTTP 404 Not Found error.

Sorry, trying to do multiple development things on this server. The file should be available now.

added 10 commits

• eb2ad9b5...78133100 - 2 commits from branch master
• 84556635 - temp
• 99f3f35c - Bugfix for superevent VOEvent Alert_Type
• e91ec8bb - Clean up skymap URLs for VOEvents
• 8c4075ef - Change Retraction VOEvent field
• d32ac998 - Add Packet_Type param to VOEvents
• 635452d1 - Remove Vetted param from VOEvents
• 2f73337f - Rearrange/add p_astro and EM bright info in VOEvents
• b82ac8c4 - Remove empty units specification from VOEvent file params

Compare with previous version

mentioned in issue #78 (closed)

added 10 commits

• b82ac8c4...1a7c0d19 - 4 commits from branch master
• e052036b - Clean up skymap URLs for VOEvents
• e3e69385 - Change Retraction VOEvent field
• 4259b140 - Add Packet_Type param to VOEvents
• 9ec6d336 - Remove Vetted param from VOEvents
• 73b5e6c6 - Rearrange/add p_astro and EM bright info in VOEvents
• 1fbb65d6 - Remove empty units specification from VOEvent file params

Compare with previous version

I'm merging this now since I expect that people will want it deployed very soon. We can address other changes separately.

closed

reopened

unmarked as a Work In Progress

changed the description

merged