.. _labels:

=================
Labels in GraceDB
=================

Labels are applied to events and superevents in GraceDB to indicate the state of that object.
Some labels signify that an action is requested, while others signify that a follow-up process has completed and/or what the result of a follow-up process was.
Here is a table showing the currently available labels and their meanings.

+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| Label name              | Label description                                                                                                                      |
+=========================+========================================================================================================================================+
| 2022_LENSING_MDC        | Event is part of the O4 Lensing MDC.                                                                                                   |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| ADVNO                   | EM advocate says event is not okay.                                                                                                    |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| ADVOK                   | EM advocate says event is okay.                                                                                                        |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| ADVREQ                  | EM advocate signoff requested.                                                                                                         |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| COMBINEDSKYMAP_READY    | Combined skymap is available.                                                                                                          |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| cWB_r                   | cWB-AllSky search performed by the cWB-XP                                                                                              |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| cWB_s                   | cWB-AllSky search performed by the cWB-2G.subthr                                                                                       |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| DQOK                    | Data quality information is available and does not veto the event.                                                                     |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| DQR_REQUEST             | Superevent ready for DQR check.                                                                                                        |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| DQV                     | Data quality veto.                                                                                                                     |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EARLY_WARNING           | Event is from an early-warning low-latency pipeline.                                                                                   |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EMBRIGHT_READY          | EM Bright information is available.                                                                                                    |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EM_COINC                | Signifies that a coincidence was found between gravitational-wave candidates and External triggers.                                    |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EM_READY                | Indicates data products associated with a Superevent's preferred event are complete                                                    |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EM_SENT                 | Has been sent to MOU partners.                                                                                                         |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EM_Selected             | GraceID automatically chosen as the most promising candidate out of a set of entries thought to correspond to the same physical event. |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EM_SelectedConfident    | The event has all annotations necessary for an alert and passes the significant alert threshold.                                       |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EM_Superseded           | GraceID automatically passed over because another entry was thought to be more promising and to correspond to the same physical event. |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EM_Throttled            | GraceID is ignored by automatic processing because the corresponding pipeline submitted too many events too quickly.                   |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| EXT_SKYMAP_READY        | External skymap is available                                                                                                           |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| GCN_PRELIM_SENT         | A preliminary GCN has been sent.                                                                                                       |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| GRB_OFFLINE             | Indicates that offline triggered GRB searches found something coincident with this event.                                              |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| GRB_ONLINE              | Indicates that online triggered GRB searches found something coincident with this event.                                               |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| H1NO                    | H1 operator says event is not okay.                                                                                                    |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| H1OK                    | H1 operator says event is okay.                                                                                                        |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| H1OPS                   | H1 operator signoff requested.                                                                                                         |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| HIGH_PROFILE            | Superevent satisfies the condition to convene the full Level 2 RRT ASAP.                                                               |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| HWINJNO                 | There were problems with the hardware injection.                                                                                       |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| HWINJOK                 | A hardware injection was successfully performed.                                                                                       |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| HWINJREQ                | A hardware injection is scheduled.                                                                                                     |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| INJ                     | Injection occured near this time.                                                                                                      |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| L1NO                    | L1 operator says event is not okay.                                                                                                    |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| L1OPS                   | L1 operator signoff requested.                                                                                                         |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| LENSED_CANDIDATE        | Candidate event was uploaded as part of a lensed search.                                                                               |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| LLAMA_COMPLETE          | LLAMA has completed annotating the superevent.                                                                                         |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| LOW_SIGNIF_LOCKED       | The GraceID associated with this event has all annotations required for an alert, passes the low-significance public alert threshold,  |
|                         | and will only be automatically updated when preliminary alerts are sent.                                                               | 
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| LOW_SIGNIF_PRELIM_SENT  | A low-significance preliminary GCN has been sent.                                                                                      |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| LUMIN_GO                | Trigger satisfies basic automated checks and should be vetted by humans. Replaced by ADVREQ                                            |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| LUMIN_NO                | LUMIN No                                                                                                                               |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| NOT_GRB                 | Event is likely not an astrophysical gamma ray burst                                                                                   |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| PASTRO_READY            | p_astro is available.                                                                                                                  |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| PE_READY                | Parameter estimation results are available                                                                                             |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| RAVEN_ALERT             | A RAVEN coincidence event is publishable                                                                                               |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| SIGNIF_LOCKED           | The GraceID associated with this event has all annotations required for an alert, passes the significant public alert threshold,       |
|                         | and will only be automatically updated when preliminary alerts are sent.                                                               | 
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| SKYMAP_READY            | Skymap is available.                                                                                                                   |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| SOG_READY               | A coincidence should trigger a speed of gravity measurement.                                                                           |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| SNR_OPTIMIZED           | Indicates that the event was SNR-optimized as followup to another uploaded event.                                                      |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| SSM                     | Event is from a subsolar mass low-latency pipeline.                                                                                    |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| SWIFT_GO                | Send notification to SWIFT telescope.                                                                                                  |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| SWIFT_NO                | Do not send notification to SWIFT telescope.                                                                                           |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| V1NO                    | V1 operator says event is not okay.                                                                                                    |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| V1OK                    | V1 operator says event is okay.                                                                                                        |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| V1OPS                   | V1 operator signoff requested.                                                                                                         |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+

Protected labels
----------------
A few labels are "protected"; i.e., they are only applied by GraceDB itself as part of another process.
These labels **cannot** be applied manually by users and any requests to do so will be rejected by the server.

At present, the following labels are protected as a part of the signoff infrastructure and are only applied by GraceDB after an operator or advocate signoff:

- H1OK, L1OK, V1OK, ADVOK
- H1NO, L1NO, V1NO, ADVNO