Sources API
Sources API¶
CHIME/FRB Sources API.
Parameters¶
API : chime_frb_api.core.API class-type
Returns¶
object-type
get_expected_spectrum
¶
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
¶
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
¶
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 |