From d0f2dbad841f20f1ed666e670befc028976e61fb Mon Sep 17 00:00:00 2001
From: Tanner Prestegard <tanner.prestegard@ligo.org>
Date: Wed, 20 Feb 2019 23:52:29 -0600
Subject: [PATCH] Update VOEvent Classification parameter descriptions

As requested here: https://git.ligo.org/emfollow/gwcelery/merge_requests/359
---
 gracedb/events/buildVOEvent.py      | 11 +++++++----
 gracedb/superevents/buildVOEvent.py | 11 +++++++----
 2 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/gracedb/events/buildVOEvent.py b/gracedb/events/buildVOEvent.py
index 6eb8c9433..b160262c1 100644
--- a/gracedb/events/buildVOEvent.py
+++ b/gracedb/events/buildVOEvent.py
@@ -276,7 +276,7 @@ def buildVOEvent(event, serial_number, voevent_type, request=None, skymap_filena
                 properties_group.add_Param(Param(name="HasNS",
                     dataType="float", ucd="stat.probability", value=ProbHasNS,
                     Description=["Probability that at least one object in the "
-                    "binary has a mass that is less than 3 solar masses"]))
+                    "binary has a mass that is less than 2.83 solar masses"]))
 
             if ProbHasRemnant is not None:
                 properties_group.add_Param(Param(name="HasRemnant",
@@ -289,19 +289,22 @@ def buildVOEvent(event, serial_number, voevent_type, request=None, skymap_filena
                 classification_group.add_Param(Param(name="BNS",
                     dataType="float", ucd="stat.probability",
                     value=BNS, Description=["Probability that the "
-                    "source is a binary neutron star merger"]))
+                    "source is a binary neutron star merger (both objects "
+                    "below 3 solar masses)"]))
 
             if NSBH is not None:
                 classification_group.add_Param(Param(name="NSBH",
                     dataType="float", ucd="stat.probability",
                     value=NSBH, Description=["Probability that the "
-                    "source is a neutron star - black hole merger"]))
+                    "source is a neutron star - black hole merger (heavier "
+                    "above 5, lighter below 3 solar masses)"]))
 
             if BBH is not None:
                 classification_group.add_Param(Param(name="BBH",
                     dataType="float", ucd="stat.probability",
                     value=BBH, Description=["Probability that the "
-                    "source is a binary black hole merger"]))
+                    "source is a binary black hole merger (both objects "
+                    "above 5 solar masses)"]))
 
             if Terrestrial is not None:
                 classification_group.add_Param(Param(name="Terrestrial",
diff --git a/gracedb/superevents/buildVOEvent.py b/gracedb/superevents/buildVOEvent.py
index 6c18384fd..dfce6dc66 100644
--- a/gracedb/superevents/buildVOEvent.py
+++ b/gracedb/superevents/buildVOEvent.py
@@ -266,7 +266,7 @@ def construct_voevent_file(superevent, voevent, request=None,
                 properties_group.add_Param(Param(name="HasNS",
                     dataType="float", ucd="stat.probability", value=ProbHasNS,
                     Description=["Probability that at least one object in the "
-                    "binary has a mass that is less than 3 solar masses"]))
+                    "binary has a mass that is less than 2.83 solar masses"]))
 
             if ProbHasRemnant is not None:
                 properties_group.add_Param(Param(name="HasRemnant",
@@ -279,19 +279,22 @@ def construct_voevent_file(superevent, voevent, request=None,
                 classification_group.add_Param(Param(name="BNS",
                     dataType="float", ucd="stat.probability",
                     value=BNS, Description=["Probability that the "
-                    "source is a binary neutron star merger"]))
+                    "source is a binary neutron star merger (both objects "
+                    "below 3 solar masses)"]))
 
             if NSBH is not None:
                 classification_group.add_Param(Param(name="NSBH",
                     dataType="float", ucd="stat.probability",
                     value=NSBH, Description=["Probability that the "
-                    "source is a neutron star - black hole merger"]))
+                    "source is a neutron star - black hole merger (heavier "
+                    "above 5, lighter below 3 solar masses)"]))
 
             if BBH is not None:
                 classification_group.add_Param(Param(name="BBH",
                     dataType="float", ucd="stat.probability",
                     value=BBH, Description=["Probability that the "
-                    "source is a binary black hole merger"]))
+                    "source is a binary black hole merger (both objects "
+                    "above 5 solar masses)"]))
 
             if Terrestrial is not None:
                 classification_group.add_Param(Param(name="Terrestrial",
-- 
GitLab