Skip to content

Einstein Probe

Einstein Probe parsers cover WXT JSON notices from the gcn.notices.einstein_probe.wxt.alert GCN topic.

Classes

EinsteinProbeWXT

Bases: BaseModel

Parsed Einstein Probe WXT alert notice.

Candidate X-ray transient reported from the EP/WXT on board trigger.

Attributes:

Name Type Description
instrument Literal['WXT']

Reporting instrument. Always "WXT".
trigger_time datetime

UTC trigger time of the transient.
id tuple[str, ...]

Mission-provided event identifiers.
ra float

Right ascension of the candidate transient position (deg).
dec float

Declination of the candidate transient position (deg).
ra_dec_error float

Positional uncertainty radius for RA/Dec (deg).
image_energy_range tuple[float, float]

Energy range of the accumulated image (keV).
net_count_rate float

Net count rate derived from the accumulated image.
image_snr float

Signal-to-noise ratio in the image.
additional_info str

Mission-provided note about the notice or measurement.
Source code in gcn_parser/ep/wxt.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class EinsteinProbeWXT(BaseModel):
    """Parsed Einstein Probe WXT alert notice.

    Candidate X-ray transient reported from the EP/WXT on board trigger.

    Attributes:
        instrument: Reporting instrument. Always ``"WXT"``.
        trigger_time: UTC trigger time of the transient.
        id: Mission-provided event identifiers.
        ra: Right ascension of the candidate transient position (deg).
        dec: Declination of the candidate transient position (deg).
        ra_dec_error: Positional uncertainty radius for RA/Dec (deg).
        image_energy_range: Energy range of the accumulated image (keV).
        net_count_rate: Net count rate derived from the accumulated image.
        image_snr: Signal-to-noise ratio in the image.
        additional_info: Mission-provided note about the notice or measurement.

    """

    instrument: Literal["WXT"]
    trigger_time: datetime
    id: tuple[str, ...]
    ra: float
    dec: float
    ra_dec_error: float
    image_energy_range: tuple[float, float]
    net_count_rate: float
    image_snr: float
    additional_info: str

Functions

parse_einstein_probe_wxt(value)

Parse an Einstein Probe WXT alert notice from bytes.

Parameters:

Name Type Description Default
value bytes

Raw JSON bytes of the notice.

 required

Returns:

Type Description
EinsteinProbeWXT

Parsed Einstein Probe WXT alert notice model.

Raises:

Type Description
ParseError

If the JSON document cannot be parsed or model validation fails.
Source code in gcn_parser/ep/wxt.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def parse_einstein_probe_wxt(value: bytes) -> EinsteinProbeWXT:
    """Parse an Einstein Probe WXT alert notice from bytes.

    Args:
        value: Raw JSON bytes of the notice.

    Returns:
        Parsed Einstein Probe WXT alert notice model.

    Raises:
        ParseError: If the JSON document cannot be parsed or model validation
            fails.
    """
    return parse_json_notice(value, EinsteinProbeWXT, "parse_einstein_probe_wxt")

References