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/api_doc/
- 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.
duration (number) – The duration of the observation in hours
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss]
freq_centre (number) – Central frequency in MHz
elevation_limit (number) – Elevation limit in deg
bandwidth_mhz (number) – Bandwidth for the continuum observation in MHz
spectral_averaging_factor (number) – Factor by which the intrinsic resolution should be averaged
- Status Codes:
200 OK – Successful response with the results of the 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 /{spectral_mode}/weighting
Compute the weighting correction factor to apply for an SKA LOW continuum observation
- Parameters:
spectral_mode (string) – Calculator spectral mode
- 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 configuration (Required)
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss] (Required)
freq_centre (number) – Central frequency in MHz (Required)
- Status Codes:
200 OK – Result of an image weighting 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.
5XX – An error occurred making the calculation
- GET /zoom/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.
duration (number) – The duration of the observation in hours
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss]
freq_centre (number) – Central frequency in MHz
elevation_limit (number) – Elevation limit in deg
spectral_resolution_hz (number) – Spectral resolution/channel width of 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_bandwidth_khz (number) – The total bandwidth of the zoom window 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 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.
duration (number) – The duration of the observation in hours
pointing_centre (string) – Pointing centre in HH:MM:SS[.ss] DD:MM:SS[.ss]
freq_centre (number) – Central frequency in MHz
elevation_limit (number) – Elevation limit in deg
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 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.