VOE API

VOE API

Bases: API

CHIME/FRB VOEvents API.

Access the endpoints under /v1/voe/ on FRB Master.

__init__

Python

__init__(API)

Initialise the VOE API.

detection

Python

detection(payload, debug=True, ip_address='')

Send a detection-type or subsequent-type VOEvent.

Parameters:

Name	Type	Description	Default
payload	dict	The dictionary to be inputted should have a top-level key called "VOEvent" that contains a dictionary of key-value pairs, some of which are required and others are optional.	required
debug	bool	If True, the debug URL is accessed so that a VOEvent will not be published to the VOEvent Network.	True
ip_address	str	If a non-empty string is supplied, trial the CHIME/FRB VOEvent Service by publishing a role="test" detection-type VOEvent to a Comet VOEvent broker running at the specified IP address.	''

Returns:

Name	Type	Description
status		dict Response from the endpoint as a dictionary indicating the status of the VOEvent translation and publication process.

fetch

Python

fetch(event_no=None)

Retrieve all VOEvent records stored for an event number from FRB Master.

This will contain the full VOEvent XML documents.

Parameters:

Name	Type	Description	Default
event_no	Optional[int]	The CHIME/FRB unique event number.	None

Returns:

Name	Type	Description
voe		dict Response from the endpoint as a dictionary indicating the database activity.

get_all

Python

get_all()

Retrieve all VOEvents from FRBMaster.

Returns:

Name	Type	Description
voe		dict Response from the endpoint as a dictionary indicating the database activity.

retraction

Python

retraction(payload, debug=True, ip_address='')

Send a retraction-type VOEvent.

Send a VOEvent that acts as a retraction for a previously issued VOEvent, in the event of a mis-identification of a new source, of a repeat burst from a known source, or perhaps a mis-fire of an update-type alert.

Parameters:

Name	Type	Description	Default
payload		dict The dictionary should have a top-level key called "VOEvent" that contains a dictionary of required key-value pairs.	required
debug		bool If True, the debug URL is accessed so that a VOEvent will not be published to the VOEvent Network.	True
ip_address		str If a non-empty string is supplied, trial the CHIME/FRB VOEvent Service by publishing a role="test" retraction-type VOEvent to a Comet VOEvent broker running at the specified IP address.	''

Returns:

Name	Type	Description
status		dict Response from the endpoint as a dictionary indicating the status of the VOEvent translation and publication process.

update

Python

update(payload, debug=True, ip_address='')

Send a update-type VOEvent.

Send an update-type VOEvent by providing a payload that follows the Event model defined in FRB Master models.

Parameters:

Name	Type	Description	Default
payload	dict	dict The dictionary should have a primary key called "VOEvent" that holds a dictionary of values, some of which are required and others which are optional. This is left flexible to allow input from various different offline analysis pipelines.	required
debug	bool	bool If True, the debug URL is accessed so that a VOEvent will not be sent.	True
ip_address	str	str If a non-empty string is supplied, trial the CHIME/FRB VOEvent Service by publishing a role="test" update-type VOEvent to a Comet VOEvent broker running at the specified IP address.	''

Returns:

Name	Type	Description
status		dict Response from the endpoint as a dictionary indicating the status of the VOEvent translation and publication process.