LOW 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>/low/ui/
- GET /subarrays
Returns the array configurations available
- Status Codes:
200 OK – Successful response with the list of array configurations.
- GET /continuum/calculate
Calculate the sensitivity of an SKA LOW observation in continuum for the input parameters.
- Query Parameters:
subarray_configuration (string) – SKA LOW subarray configurations allowed for a continuum calculation. To define a custom configuration, set num_stations and do not set this parameter.
num_stations (number) – The number of LOW antenna stations. If set, subarray_configuration should not be set.
integration_time_h (number) – The integration time of the observation in hours
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss]
elevation_limit (number) – Elevation limit in deg
freq_centre_mhz (number) – Central frequency in MHz
bandwidth_mhz (number) – Bandwidth for the continuum observation in MHz
spectral_averaging_factor (number) – Factor by which the intrinsic resolution should be averaged
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.
- Status Codes:
200 OK – Successful response with the results of the continuum sensitivity calculation.
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.
- GET /continuum/weighting
Compute the weighting correction factor to apply for an SKA LOW continuum observation
- Query Parameters:
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) – SKA LOW subarray configurations allowed for a continuum calculation. To define a custom configuration, set num_stations and do not set this parameter.
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss] (Required)
freq_centre_mhz (number) – Central frequency in MHz (Required)
subband_freq_centres_mhz (array) – Central frequency of each sub-band in MHz. Providing sub-band frequencies enables the provision of additional weighting outputs..
- Status Codes:
200 OK – Successful response with the continuum weighting and weighting for subbands, if applicable
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 for an SKA LOW line observation
- Query Parameters:
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) – SKA LOW subarray configurations allowed for a zoom calculation. To define a custom configuration, set num_stations and do not set this parameter.
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss] (Required)
freq_centres_mhz (array) – Array of central frequency of zoom windows in MHz
- Status Codes:
200 OK – Successful response with the weighting for each zoom window
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
Calculate the sensitivity of an SKA LOW observation in zoom mode for the input parameters.
- Query Parameters:
subarray_configuration (string) – SKA LOW subarray configurations allowed for a zoom calculation. To define a custom configuration, set num_stations and do not set this parameter.
num_stations (number) – The number of LOW antenna stations. If set, subarray_configuration should not be set.
integration_time_h (number) – The integration time of the observation in hours
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss]
elevation_limit (number) – Elevation limit in deg
freq_centres_mhz (array) – Array of central frequency of zoom windows in MHz
spectral_resolutions_hz (array) – Spectral resolution/channel width of each of the the zoom window. The channel width of the narrowest zoom window is given by (781250 * 32/27)/(4096 * 16) = 14.129 Hz (rounded to 3 d.p.).
total_bandwidths_khz (array) – The total bandwidth of each of the zoom windows in kHz. Smallest allowed value is the channel width given above multiplied by 1728 channels (~24.4 kHz). Maximum allowed value is 3125 kHz.
- Status Codes:
200 OK – Successful response with the results of the line sensitivity calculation.
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.
- GET /pss/calculate
Calculate the sensitivity of an SKA LOW observation in PSS mode for the input parameters.
- Query Parameters:
subarray_configuration (string) – SKA LOW subarray configurations allowed for a PSS calculation. To define a custom configuration, set num_stations and do not set this parameter.
num_stations (number) – The number of LOW antenna stations. If set, subarray_configuration should not be set.
integration_time_h (number) – The integration time of the observation in hours
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss]
elevation_limit (number) – Elevation limit in deg
freq_centre_mhz (number) – Central frequency in MHz
dm (number) – Dispersion Measure in pc/cm^3
intrinsic_pulse_width (number) – Intrinsic pulse width in milliseconds
pulse_period (number) – Pulse period in milliseconds
- Status Codes:
200 OK – Successful response with the results of the PSS sensitivity calculation.
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.