Injections (Mimic) API

Injections API (Mimic)

CHIME/FRB Mimic API.

__init__

Python

__init__(API)

CHIME/FRB Mimic Initialization.

get_active_injections

Python

get_active_injections()

Get parameters for all currently active injections.

Returns:

Name	Type	Description
active_injections	JSON	list

get_all_injection_programs

Python

get_all_injection_programs()

Get all unique injection programs.

Returns:

Type	Description
JSON	dict

get_simulated_event

Python

get_simulated_event(uuid=None)

Get the injected and detected parameters for a specific UUID.

Parameters:

Name	Type	Description	Default
uuid	Optional[str]	Universally unique identifier for the specific simulated event	None

Returns:

Type	Description
JSON	dict

Raises:

Type	Description
AttributeError	uuid is required

get_uuids

Python

get_uuids()

Get UUIDs for all simulated events.

Returns:

Type	Description
JSON	dict

register_detection

Python

register_detection(**kwargs)

Register a detection.

Parameters:

Name	Type	Description	Default
**kwargs		Refer to http://frb-vsop.chime:8001/swagger/#/Mimic	{}

Returns:

Type	Description
JSON	dict

register_injection

Python

register_injection(**kwargs)

Register an injection.

Parameters:

Name	Type	Description	Default
**kwargs		Refer to http://frb-vsop.chime:8001/swagger/#/Mimic	{}

Returns:

Name	Type	Description
uuid	JSON	python dict of the uuids of the registered injection