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/senscalc/api/v<MAJOR_VERSION>/mid/ui/
- GET /continuum/calculate
Returns either integration time in seconds given a target sensitivity, or vice-versa
- Query Parameters:
integration_time_s (number) – The integration time of the observation in seconds. Should only be specified when calculating sensitivity and sensitivity_jy parameter is not specified
sensitivity_jy (number) – The sensitivity of the observation in Jy. Should only be specified when calculating integration time and integration_time_s parameter is not specified
rx_band (string) – Receiver band (Required)
subarray_configuration (string) – The enumerated option for the array configuration to use to perform the calculation. To define a custom configuration, set n_ska and n_meer and do not set this parameter.
n_ska (integer) – Number of 15-m antennas in the custom subarray. If set, n_meer must also be set and subarray_configuration should not be set.
n_meer (integer) – Number of 13.5-m antennas in the custom subarray. If set, n_ska must also be set and subarray_configuration should not be set.
freq_centre_hz (number) – Central frequency in Hz (Required)
bandwidth_hz (number) – Bandwidth (Hz) (Required)
spectral_averaging_factor (number) – Factor by which the intrinsic resolution should be averaged
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss] (Required)
pwv (number) – Precipitable water vapour in mm
elevation_limit (number) – Elevation limit in deg
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_jy must also be set.
subband_sensitivities_jy (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).
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_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
eta_meer (number) – Dish efficiency for 13.5-m antennas
eta_ska (number) – Dish efficiency for 15-m antennas
- Status Codes:
200 OK – Successful response with the results of the integration time or sensitivity calculation for continuum mode.
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 /line/calculate
Returns either integration time in seconds given a target sensitivity, or vice-versa. Zoom modes are only available for the AA*, AA4 and custom subarrays (defined by n_ska and n_meer). Otherwise a validation error will be returned.
- Query Parameters:
rx_band (string) – Receiver band (Required)
subarray_configuration (string) – The enumerated option for the array configuration to use to perform the calculation. To define a custom configuration, set n_ska and n_meer and do not set this parameter.
n_ska (integer) – Number of 15-m antennas in the custom subarray. If set, n_meer must also be set and subarray_configuration should not be set.
n_meer (integer) – Number of 13.5-m antennas in the custom subarray. If set, n_ska must also be set and subarray_configuration should not be set.
freq_centres_hz (array) – Array of zoom frequencies. This provides additional outputs for zoom observations (spectral_resolutions_hz must be set as well and have the same number of elements). Zoom modes are only available for the AA*, AA4 and custom subarrays (defined by n_ska and n_meer). Otherwise a validation error will be returned. (Required)
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss] (Required)
pwv (number) – Precipitable water vapour in mm
elevation_limit (number) – Elevation limit in deg
spectral_resolutions_hz (array) – Array of zoom spectral resolutions. This provides additional outputs for line observations (freq_centres_hz must be set as well and have the same number of elements). Zoom modes are only available for the AA*, AA4 and custom subarrays (defined by n_ska and n_meer). Otherwise a validation error will be returned.
total_bandwidths_hz (array) – Array of zoom total bandwidths.
sensitivities_jy (array) – Array of zoom sensitivities. This provides additional outputs for line observations (spectral_resolutions_hz and freq_centres_hz must be set as well and have the same number of elements). Should only be specified when calculating integration time and integration_time_s parameter is not specified
integration_time_s (number) – The integration time of the observation in seconds. Should only be specified when calculating sensitivity and sensitivities_jy parameter is not specified
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_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
eta_meer (number) – Dish efficiency for 13.5-m antennas
eta_ska (number) – Dish efficiency for 15-m antennas
- Status Codes:
200 OK – Successful response with the results of the integration time or sensitivity calculation for zoom mode.
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 /continuum/weighting
Compute the weighting correction factor to apply
- Query Parameters:
freq_centre_hz (number) – Central frequency in Hz (Required)
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss] (Required)
weighting_mode (string) – Weighting strategy used (Required)
robustness (number) – Robust parameter. Only required and considered if the weighting is set to robust.
subarray_configuration (string) – The enumerated option for the array configuration to use to perform the calculation. To define a custom configuration, set n_ska and n_meer and do not set this parameter.
taper (number) – Gaussian taper (specified as arcseconds in image plane). No taper applied if left empty.
subband_freq_centres_hz (array) – Central frequency of each sub-band 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 /line/weighting
Compute the weighting correction factor to apply
- Query Parameters:
freq_centres_hz (array) – Array of zoom frequencies. This provides additional outputs for zoom observations (spectral_resolutions_hz must be set as well and have the same number of elements). Zoom modes are only available for the AA*, AA4 and custom subarrays (defined by n_ska and n_meer). Otherwise a validation error will be returned. (Required)
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss] (Required)
weighting_mode (string) – Weighting strategy used (Required)
robustness (number) – Robust parameter. Only required and considered if the weighting is set to robust.
subarray_configuration (string) – The enumerated option for the array configuration to use to perform the calculation. To define a custom configuration, set n_ska and n_meer and do not set this parameter.
taper (number) – Gaussian taper (specified as arcseconds in image plane). No taper applied if left empty.
- 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