snews_cs.cs_alert_schema

Module Contents

Classes

CoincidenceTierAlert

The Message scheme for the alert and observations
class snews_cs.cs_alert_schema.CoincidenceTierAlert(env_path=None)[source]

The Message scheme for the alert and observations

Parameters

env_path (str, optional) – The path containing the environment configuration file If None, uses the default file in ‘/auxiliary/test-config.env’

id_format(self, num_detectors)[source]
Returns formatted message ID

time format should always be same for all detectors. num_detectors: int

Number of detectors in the alert. If more than 2, it is an update to an earlier alert, and will be appended with -UPDATE_ string

Returns
:str

The formatted id as a string

get_cs_alert_schema(self, data)[source]

Create a message schema for alert. Internally called in hop_pub

Parameters

  • data (named tuple) – cs_utils data tuple with predefined field.

  • sent_time (str) – time as a string

Returns

message with the correct scheme

Return type

dict