From 8ea744a00961b613f560c7164748cc35c336ce84 Mon Sep 17 00:00:00 2001
From: Roberto DePietri <roberto.depietri@unipr.it>
Date: Mon, 7 Feb 2022 14:59:17 +0000
Subject: [PATCH] Removed MassGap source category
---
_static/MS181101ab-1-EarlyWarning.xml | 9 +++----
_static/MS181101ab-2-Preliminary.xml | 9 +++----
_static/MS181101ab-3-Initial.xml | 9 +++----
_static/MS181101ab-4-Update.xml | 9 +++----
_static/MS181101ab-6-Update.xml | 9 +++----
analysis/inference.rst | 14 +++++------
changes.rst | 5 ++++
content.rst | 34 ++++++++-------------------
tutorial/receiving.rst | 1 -
9 files changed, 37 insertions(+), 62 deletions(-)
diff --git a/_static/MS181101ab-1-EarlyWarning.xml b/_static/MS181101ab-1-EarlyWarning.xml
index e419e6a0..982028e4 100644
--- a/_static/MS181101ab-1-EarlyWarning.xml
+++ b/_static/MS181101ab-1-EarlyWarning.xml
@@ -56,18 +56,15 @@
<Description>Probability that the source is a binary neutron star merger (both objects lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="NSBH" ucd="stat.probability" value="0.01">
- <Description>Probability that the source is a neutron star-black hole merger (primary heavier than 5 solar masses, secondary lighter than 3 solar masses)</Description>
+ <Description>Probability that the source is a neutron star-black hole merger (secondary lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="BBH" ucd="stat.probability" value="0.03">
- <Description>Probability that the source is a binary black hole merger (both objects heavier than 5 solar masses)</Description>
- </Param>
- <Param dataType="float" name="MassGap" ucd="stat.probability" value="0.0">
- <Description>Probability that the source has at least one object between 3 and 5 solar masses</Description>
+ <Description>Probability that the source is a binary black hole merger (both objects heavier than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="Terrestrial" ucd="stat.probability" value="0.01">
<Description>Probability that the source is terrestrial (i.e., a background noise fluctuation or a glitch)</Description>
</Param>
- <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), MassGap, or terrestrial (noise)</Description>
+ <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), or terrestrial (noise)</Description>
</Group>
<Group name="Properties" type="Properties">
<Param dataType="float" name="HasNS" ucd="stat.probability" value="0.95">
diff --git a/_static/MS181101ab-2-Preliminary.xml b/_static/MS181101ab-2-Preliminary.xml
index a6bdd323..30d4c710 100644
--- a/_static/MS181101ab-2-Preliminary.xml
+++ b/_static/MS181101ab-2-Preliminary.xml
@@ -56,18 +56,15 @@
<Description>Probability that the source is a binary neutron star merger (both objects lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="NSBH" ucd="stat.probability" value="0.01">
- <Description>Probability that the source is a neutron star-black hole merger (primary heavier than 5 solar masses, secondary lighter than 3 solar masses)</Description>
+ <Description>Probability that the source is a neutron star-black hole merger (secondary lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="BBH" ucd="stat.probability" value="0.03">
- <Description>Probability that the source is a binary black hole merger (both objects heavier than 5 solar masses)</Description>
- </Param>
- <Param dataType="float" name="MassGap" ucd="stat.probability" value="0.0">
- <Description>Probability that the source has at least one object between 3 and 5 solar masses</Description>
+ <Description>Probability that the source is a binary black hole merger (both objects heavier than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="Terrestrial" ucd="stat.probability" value="0.01">
<Description>Probability that the source is terrestrial (i.e., a background noise fluctuation or a glitch)</Description>
</Param>
- <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), MassGap, or terrestrial (noise)</Description>
+ <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), or terrestrial (noise)</Description>
</Group>
<Group name="Properties" type="Properties">
<Param dataType="float" name="HasNS" ucd="stat.probability" value="0.95">
diff --git a/_static/MS181101ab-3-Initial.xml b/_static/MS181101ab-3-Initial.xml
index 1b19f5ca..efbf00a0 100644
--- a/_static/MS181101ab-3-Initial.xml
+++ b/_static/MS181101ab-3-Initial.xml
@@ -56,18 +56,15 @@
<Description>Probability that the source is a binary neutron star merger (both objects lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="NSBH" ucd="stat.probability" value="0.01">
- <Description>Probability that the source is a neutron star-black hole merger (primary heavier than 5 solar masses, secondary lighter than 3 solar masses)</Description>
+ <Description>Probability that the source is a neutron star-black hole merger (secondary lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="BBH" ucd="stat.probability" value="0.03">
- <Description>Probability that the source is a binary black hole merger (both objects heavier than 5 solar masses)</Description>
- </Param>
- <Param dataType="float" name="MassGap" ucd="stat.probability" value="0.0">
- <Description>Probability that the source has at least one object between 3 and 5 solar masses</Description>
+ <Description>Probability that the source is a binary black hole merger (both objects heavier than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="Terrestrial" ucd="stat.probability" value="0.01">
<Description>Probability that the source is terrestrial (i.e., a background noise fluctuation or a glitch)</Description>
</Param>
- <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), MassGap, or terrestrial (noise)</Description>
+ <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), or terrestrial (noise)</Description>
</Group>
<Group name="Properties" type="Properties">
<Param dataType="float" name="HasNS" ucd="stat.probability" value="0.95">
diff --git a/_static/MS181101ab-4-Update.xml b/_static/MS181101ab-4-Update.xml
index 53a0785d..170e2c87 100644
--- a/_static/MS181101ab-4-Update.xml
+++ b/_static/MS181101ab-4-Update.xml
@@ -56,18 +56,15 @@
<Description>Probability that the source is a binary neutron star merger (both objects lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="NSBH" ucd="stat.probability" value="0.01">
- <Description>Probability that the source is a neutron star-black hole merger (primary heavier than 5 solar masses, secondary lighter than 3 solar masses)</Description>
+ <Description>Probability that the source is a neutron star-black hole merger (secondary lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="BBH" ucd="stat.probability" value="0.03">
- <Description>Probability that the source is a binary black hole merger (both objects heavier than 5 solar masses)</Description>
- </Param>
- <Param dataType="float" name="MassGap" ucd="stat.probability" value="0.0">
- <Description>Probability that the source has at least one object between 3 and 5 solar masses</Description>
+ <Description>Probability that the source is a binary black hole merger (both objects heavier than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="Terrestrial" ucd="stat.probability" value="0.01">
<Description>Probability that the source is terrestrial (i.e., a background noise fluctuation or a glitch)</Description>
</Param>
- <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), MassGap, or terrestrial (noise)</Description>
+ <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), or terrestrial (noise)</Description>
</Group>
<Group name="Properties" type="Properties">
<Param dataType="float" name="HasNS" ucd="stat.probability" value="0.95">
diff --git a/_static/MS181101ab-6-Update.xml b/_static/MS181101ab-6-Update.xml
index 4a0f4efa..c102b3d1 100644
--- a/_static/MS181101ab-6-Update.xml
+++ b/_static/MS181101ab-6-Update.xml
@@ -77,18 +77,15 @@
<Description>Probability that the source is a binary neutron star merger (both objects lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="NSBH" ucd="stat.probability" value="0.01">
- <Description>Probability that the source is a neutron star-black hole merger (primary heavier than 5 solar masses, secondary lighter than 3 solar masses)</Description>
+ <Description>Probability that the source is a neutron star-black hole merger (secondary lighter than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="BBH" ucd="stat.probability" value="0.03">
- <Description>Probability that the source is a binary black hole merger (both objects heavier than 5 solar masses)</Description>
- </Param>
- <Param dataType="float" name="MassGap" ucd="stat.probability" value="0.0">
- <Description>Probability that the source has at least one object between 3 and 5 solar masses</Description>
+ <Description>Probability that the source is a binary black hole merger (both objects heavier than 3 solar masses)</Description>
</Param>
<Param dataType="float" name="Terrestrial" ucd="stat.probability" value="0.01">
<Description>Probability that the source is terrestrial (i.e., a background noise fluctuation or a glitch)</Description>
</Param>
- <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), MassGap, or terrestrial (noise)</Description>
+ <Description>Source classification: binary neutron star (BNS), neutron star-black hole (NSBH), binary black hole (BBH), or terrestrial (noise)</Description>
</Group>
<Group name="Properties" type="Properties">
<Param dataType="float" name="HasNS" ucd="stat.probability" value="0.95">
diff --git a/analysis/inference.rst b/analysis/inference.rst
index 8c02bb51..a1b4648b 100644
--- a/analysis/inference.rst
+++ b/analysis/inference.rst
@@ -10,13 +10,13 @@ be provided based on samples drawn from the posterior probability distribution.
Classification
--------------
-The classification consists of five numbers, summing to unity, that give the
-probability that the source is either a :term:`BNS`, :term:`NSBH`, :term:`BBH`
-merger, contains at least one :term:`MassGap <MassGap>` component, or is of
-:term:`Terrestrial` (i.e. a background fluctuation or a glitch) origin. See the
-:ref:`figure in the alert contents section <classification-diagram>` for the
-boundaries of the source classification categories in the :math:`(m_1, m_2)`
-plane.
+The classification consists of four numbers, summing to unity, that
+give the probability that the source is either a :term:`BNS`,
+:term:`NSBH`, :term:`BBH` merger, or is of :term:`Terrestrial` (i.e. a
+background fluctuation or a glitch) origin. See the :ref:`figure in
+the alert contents section <classification-diagram>` for the
+boundaries of the source classification categories in
+the :math:`(m_1,m_2)` plane.
This assumes that terrestrial and astrophysical events occur as independent
Poisson processes. A source-dependent weighting of matched-filter templates is
diff --git a/changes.rst b/changes.rst
index d9e184c6..19b4a586 100644
--- a/changes.rst
+++ b/changes.rst
@@ -14,11 +14,16 @@ Version 17 (unreleased)
* Add the reference to the source properties methods paper.
Provide details on the cases where the above method is used.
+* Removed MassGap category from source classification.
.. rubric:: Alert Contents
+* Removed MassGap category from source classification.
+
.. rubric:: Sample Code
+* Removed MassGap category from source classification.
+
.. rubric:: Additional Resources
Version 16 (2020-05-28)
diff --git a/content.rst b/content.rst
index 3d50442a..f26d2026 100644
--- a/content.rst
+++ b/content.rst
@@ -124,7 +124,7 @@ The table below is a representation of the contents of a LIGO/Virgo GCN Notice.
| Duration | | Duration of burst in s |
+-------------------+-----------------------------------------------------------+-------------------------------------------------------------------+
| BNS, NSBH, BBH, | Probability that the source is a :term:`BNS`, | N/A |
-| MassGap, Noise | :term:`NSBH`, :term:`BBH`, or :term:`MassGap` merger, or | |
+| Noise | :term:`NSBH`, :term:`BBH`, or | |
| | :term:`Terrestrial` (i.e, noise) respectively | |
+-------------------+-----------------------------------------------------------+ +
| HasNS, HasRemnant | Probability, under the assumption that the source is not | |
@@ -249,17 +249,16 @@ Inference
The inference section is present for :term:`CBC` events *only*. It has two
parts:
-**Classification**: Five numbers, summing to unity, giving probability that the
+**Classification**: Four numbers, summing to unity, giving probability that the
source belongs to the following five mutually exclusive categories:
* :term:`BNS` merger
* :term:`NSBH` merger
* :term:`BBH` merger
-* :term:`MassGap` merger
* :term:`Terrestrial` (i.e., a chance background fluctuation or a glitch)
The figure below shows the extent of the three astrophysical categories (BNS,
-NSBH, BBH, and MassGap) in terms of the component masses :math:`m_1` and
+NSBH, and BBH) in terms of the component masses :math:`m_1` and
:math:`m_2`.
.. note::
@@ -270,8 +269,7 @@ NSBH, BBH, and MassGap) in terms of the component masses :math:`m_1` and
In the mass diagram below, the upper diagonal region :math:`m_1 < m_2` is
lightly shaded in order to indicate that the definitions of four mass
- classes (BNS, NSBH, BBH, MassGap) are *symmetric* in :math:`m_1` and
- :math:`m_2`.
+ classes (BNS, NSBH, BBH) are *symmetric* in :math:`m_1` and :math:`m_2`.
.. _classification-diagram:
@@ -289,15 +287,15 @@ NSBH, BBH, and MassGap) in terms of the component masses :math:`m_1` and
min_mass = 1
ns_max_mass = 3
- bh_min_mass = 5
- max_mass = 11
+ bh_min_mass = 3
+ max_mass = 6
ax = plt.axes(aspect=1)
ax.set_xlim(min_mass, max_mass)
ax.set_ylim(min_mass, max_mass)
ax.spines['top'].set_visible(False)
ax.spines['right'].set_visible(False)
- ticks = [min_mass, ns_max_mass, bh_min_mass]
+ ticks = [min_mass, ns_max_mass]
ax.set_xticks(ticks)
ax.set_yticks(ticks)
@@ -311,8 +309,8 @@ NSBH, BBH, and MassGap) in terms of the component masses :math:`m_1` and
ax.xaxis.set_label_coords(1.0, -0.025)
ax.yaxis.set_label_coords(-0.025, 1.0)
- bns_color, nsbh_color, gap_color, bbh_color = seaborn.color_palette(
- 'pastel', 4)
+ bns_color, nsbh_color, bbh_color = seaborn.color_palette(
+ 'pastel', 3)
p = ax.add_patch(Rectangle((min_mass, min_mass),
ns_max_mass - min_mass, ns_max_mass - min_mass,
@@ -337,18 +335,6 @@ NSBH, BBH, and MassGap) in terms of the component masses :math:`m_1` and
color=nsbh_color, linewidth=0))
ax.text(*get_center(p.get_bbox()), 'NSBH', ha='center', va='center')
- ax.add_patch(Rectangle((min_mass, ns_max_mass),
- max_mass - min_mass, bh_min_mass - ns_max_mass,
- color=gap_color, linewidth=0))
- ax.add_patch(Rectangle((ns_max_mass, min_mass),
- bh_min_mass - ns_max_mass, max_mass - min_mass,
- color=gap_color, linewidth=0))
- p = ax.add_patch(Rectangle((ns_max_mass, ns_max_mass),
- bh_min_mass - ns_max_mass, bh_min_mass - ns_max_mass,
- color=gap_color, linewidth=0))
- ax.text(0.5 * (bh_min_mass + max_mass), 0.5 * (ns_max_mass + bh_min_mass),
- 'MassGap', ha='center', va='center')
-
ax.fill_between([min_mass, max_mass],
[min_mass, max_mass],
[max_mass, max_mass],
@@ -375,7 +361,7 @@ NSBH, BBH, and MassGap) in terms of the component masses :math:`m_1` and
**Properties**: Probabilities that the source has each of the following
properties, *assuming that it is not noise* (e.g., assuming that it is a BNS,
-NSBH, BBH, or MassGap merger):
+NSBH, or BBH merger):
* **HasNS**: The mass of one or more of the binary's two companion compact
objects is consistent with a neutron star. Equivalently, the mass of the
diff --git a/tutorial/receiving.rst b/tutorial/receiving.rst
index 7663852f..68713242 100644
--- a/tutorial/receiving.rst
+++ b/tutorial/receiving.rst
@@ -171,7 +171,6 @@ Upon running this, you should see:
BNS = 0.95
NSBH = 0.01
BBH = 0.03
- MassGap = 0.0
Terrestrial = 0.01
HasNS = 0.95
HasRemnant = 0.91
--
GitLab