EventData#

class shigawire.models.EventData[source]#

Bases: object

Metadata for a gravitational-wave candidate detected by a search pipeline.

Attributes Summary

`event_time`
`far`
`instruments`
`mass1`
`mass2`
`mchirp`
`mtotal`
`program`
`snr`

Attributes Documentation

event_time: float = FieldInfo(annotation=NoneType, required=True, description='Merger time in milliseconds from the UNIX epoch')#

far: float = FieldInfo(annotation=NoneType, required=True, description='False alarm rate')#

instruments: str = FieldInfo(annotation=NoneType, required=True, description='Comma-separated list of detectors that contributed data to the event')#

mass1: float = FieldInfo(annotation=NoneType, required=True, description='Primary mass')#

mass2: float = FieldInfo(annotation=NoneType, required=True, description='Secondary mass')#

mchirp: float = FieldInfo(annotation=NoneType, required=True, description='Chirp mass')#

mtotal: float = FieldInfo(annotation=NoneType, required=True, description='Total mass')#

program: str = FieldInfo(annotation=NoneType, required=True, description='Program that uploaded the event')#

snr: float = FieldInfo(annotation=NoneType, required=True, description='Signal to noise ratio')#