Skip to content

Sources API

Sources API

CHIME/FRB Sources API.

Parameters

API : chime_frb_api.core.API class-type

Returns

object-type

__init__

Python
__init__(API)

Initialize Sources API.

get_expected_spectrum

Python
get_expected_spectrum(source_name)

Expected spectra for a CHIME/FRB Source.

Parameters:

Name Type Description Default
source_name str

Source name, e.g. CAS_A

required

Returns:

Name Type Description
spectrum JSON

dict Returns dict with the following format

get_source

Python
get_source(source_name)

Astrophysical Source from CHIME/FRB Master.

Parameters:

Name Type Description Default
source_name str

Source name, e.g. CAS_A

required

Returns:

Name Type Description
dict JSON

Source

get_source_type

Python
get_source_type(source_type=None)

Get CHIME/FRB sources based on type.

Parameters:

Name Type Description Default
source_type Optional[str]

One of ["FRB", "FRB_REPEATER", "PULSAR", "STEADY", "RRAT"]

None

Returns:

Name Type Description
dict JSON

Returns a dict of all valid sources