Calibration API

Calibration API

CHIME/FRB Calibration API.

__init__

Python

__init__(API)

Initializes the Calibration API.

get_calibration

Python

get_calibration(utc_date=None, source_name=None)

Get all CHIME/FRB calibration products for given date.

Fetches all CHIME/FRB calibration data products for a specific utc_date, source_name or a combination of both filters. Atleast one is required.

Parameters:

Name	Type	Description	Default
utc_date	Optional[str]	UTC date in the format YYYYMMDD, e.g. 20190101	None

source_name: Name of the calibration source, e.g. CAS_A

Returns:

Name	Type	Description
calibration_data_product	JSON	JSON

get_calibration_in_timerange

Python

get_calibration_in_timerange(start_utc_date=None, stop_utc_date=None, source_name=None)

Get all CHIME/FRB calibration products for given time range.

Fetches all CHIME/FRB calibration data products for a specific time range within start_utc_date and stop_utc_date. You can further, filter the results based on source_name.

Parameters:

Name	Type	Description	Default
start_utc_date	Optional[str]	UTC date in the format YYYYMMDD, e.g. 20190101	None
stop_utc_date	Optional[str]	UTC date in the format YYYYMMDD, e.g. 20190101	None
source_name	Optional[str]	Name of the calibration source, e.g. CAS_A	None

Returns:

Name	Type	Description
calibration_data_product	JSON	JSON

get_calibration_product

Python

get_calibration_product(calprod_filepath=None)

Fetches the CHIME/FRB calibration spectrum.

Parameters:

Name	Type	Description	Default
calprod_filepath	Optional[str]	The path of the .npz file containing the 16K BF/Jy calibration spectrum and calibration diagnostic information on the CHIME/FRB Archiver.	None

Returns:

Name	Type	Description
calibration_product	JSON	JSON {"calibration_spectrum": [], "effective_bandwidth": 0, "beam_num": 0, "fwhm": 0, "fwhm_err": 0, "fwhm_fit_rsquared": 0}

get_nearest_calibration

Python

get_nearest_calibration(utc_date=None, ra=None, dec=None)

Get the nearest CHIME/FRB calibration products for given ra and dec.

Fetches all CHIME/FRB calibration data products for a given right ascension, declication and utc_date combination.

Parameters:

Name	Type	Description	Default
ra	Optional[float]	Right Ascension	None
dec	Optional[float]	Declication	None
utc_date	Optional[str]	UTC date in the format YYYYMMDD, e.g. 20190101	None

Returns:

Name	Type	Description
calibration_data_product	JSON	JSON