MID REST API

These docs are generated from the OpenAPI specification for the application. There is an issue with the RTD plugin which means the response types are not rendered. To see the API response bodies for the status codes listed below see the Swagger UI: https://k8s.stfc.skao.int/integration-ska-ost-senscalc-ui/api_doc/

GET /calculate

Returns the integration time in seconds given a target sensitivity for a continuum observation

Query Parameters:

  • rx_band (string) – Receiver band (Required)

  • frequency (number) – Frequency (Hz) (Required)

  • ra_str (string) – Right ascension in ICRS frame (Required)

  • dec_str (string) – Declination in ICRS frame (Required)

  • array_configuration (string) – The enumerated option for the array configuration to use to perform the calculation.

  • eta_system (number) – System efficiency. If provided, will be used instead of calculating it from eta_pointing, eta_coherence, eta_digitisation, eta_bandpass and eta_correlation

  • eta_pointing (number) – Pointing efficiency

  • eta_coherence (number) – Coherence efficiency

  • eta_digitisation (number) – Digitisation efficiency

  • eta_correlation (number) – Correlation efficiency

  • eta_bandpass (number) – Bandpass efficiency

  • t_sys_ska (number) – System Temperature of the 15-m antennas (K)

  • t_rx_ska (number) – Receiver Temperature of the 15-m antennas (K)

  • t_spl_ska (number) – Spillover Temperature of the 15-m antennas (K)

  • t_sys_meer (number) – System Temperature of the 13.5-m antennas (K)

  • t_rx_meer (number) – Receiver Temperature of the 13.5-m antennas (K)

  • t_spl_meer (number) – Spillover Temperature of the 13.5-m antennas (K)

  • t_sky_ska (number) – Sky temperature for 15-m antennas (K)

  • t_sky_meer (number) – Sky temperature for 13.5-m antennas (K)

  • t_gal_ska (number) – Galactic temperature for 15-m antennas (K)

  • t_gal_meer (number) – Galactic temperature for 13.5-m antennas (K)

  • alpha (number) – Spectral index of Galactic emission

  • n_ska (integer) – Number of 15-m antennas (overrides array_configuration; n_meer should be provided too)

  • n_meer (integer) – Number of 13.5-m antennas (overrides array_configuration; n_ska should be provided too)

  • eta_meer (number) – Dish efficiency for 13.5-m antennas

  • eta_ska (number) – Dish efficiency for 15-m antennas

  • pwv (number) – Precipitable water vapour in mm

  • el (number) – Elevation above the horizon in degrees (default 45 deg.)

  • bandwidth (number) – Bandwidth (Hz) (Required)

  • resolution (number) – Frequency Resolution (Hz)

  • integration_time (number) – Integration time (s). This makes the output to include the computed sensitivity.

  • sensitivity (number) – Sensitivity (Jy). This makes the output to include the integration time.

  • n_subbands (integer) – If this parameter is provided, the ‘subbands’ field in the response body will contain a sensitivity result for each sub-band, which is calculated by dividing the bandwidth in N sub-bands. If the value is given as 1 then this is equal to the main sensitivity calculation so no ‘subbands’ are returned in the response. Note: if calculating integration time, subband_sensitivities must also be set.

  • subband_sensitivities (array) – Ordered array of the (thermal) sensitivity (Jy) for each sub-band, used when calculating integration time. (n_subbands must be set as well and have the same number of elements).

  • zoom_frequencies (array) – Array of zoom frequencies. This provides additional outputs for line observations (zoomResolutions must be set as well and have the same number of elements).

  • zoom_resolutions (array) – Array of zoom spectral resolutions. This provides additional outputs for line observations (zoomFreqs must be set as well and have the same number of elements).

  • zoom_sensitivities (array) – Array of zoom sensitivities. This provides additional outputs for line observations (zoomResolutions and zoomFreqs must be set as well and have the same number of elements).

Status Codes:

  • 200 OK – Successful response with the results of the computations.

  • 400 Bad Request – Request parameters failed validation, either against the OpenAPI spec or the domain specific validation,eg the spectral window not lying within the allowed range.

  • 5XX – An error occurred making the calculation

GET /weighting

Compute the weighting correction factor to apply

Query Parameters:

  • frequency (number) – Frequency (Hz)

  • zoom_frequencies (array) – Array of zoom frequencies (Hz)

  • dec_str (string) – Declination in ICRS frame. Allowed range -90:00:00.00 to 44:00:00.00. (Required)

  • weighting (string) – Weighting strategy used (uniform, robust, or natural). (Required)

  • robustness (number) – Robust parameter. It is only required and considered if the weighting is set to robust.

  • array_configuration (string) – The enumerated option for the array configuration to use to perform the calculation.

  • calculator_mode (string) – Mode of the Calculator (Required)

  • taper (number) – Gaussian taper (specified as arcseconds in image plane). No taper applied if left empty.

  • subband_frequencies_hz (array) – Sub-band frequencies in Hz. Providing sub-band frequencies enables the provision of additional weighting outputs..

Status Codes:

  • 200 OK – Successful response with the correction factor.

  • 400 Bad Request – Request parameters failed validation, either against the OpenAPI spec or the domain specific validation,eg the spectral window not lying within the allowed range.

  • 5XX – An error occurred making the calculation

GET /subarrays

Returns the array configurations available

Status Codes:

  • 200 OK – Successful response with the list of array configurations.