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

Returns the sensitivity, image weighting parameters and weighted sensitivity, where applicable, given an integration time and weighting mode.

Query Parameters:

  • subarray_configuration (string) – Enumeration of the 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] (Required)

  • freq_centre_mhz (number) – Central frequency in MHz. Combined with the bandwidth_mhz, it must define a spectral window that is contained within the Low frequency range.

  • bandwidth_mhz (number) – Bandwidth for the continuum observation in MHz. Combined with the freq_centre_mhz, it must define a spectral window that is contained within the Low frequency range.

  • spectral_averaging_factor (number) – Factor by which the spectral resolution should be averaged to calculate the effective resolution which is used in the calculation. The number of channels is set by the continuum bandwidth and the maximum value of the spectral averaging factor is half that number.

  • elevation_limit (number) – Lowest elevation that the LOW observation will be performed at. The maximum value is nominally 90 degrees, but the enforced limit is actually the highest elevation that can be achieved given the source declination and the latitude of the telescope.

  • weighting_mode (string) – Enumeration of the weighting strategy used. (Required)

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

  • 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 Transformed 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. However, if the value is given as 1 and subband_freq_centres_mhz is also provided, then 1 ‘subbands’ will be returned in the response.

  • 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 results of the continuum sensitivity calculation, continuum weighting, spectral weighting and weighted sensitivity calculations.

  • 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 /zoom/calculate

Calculates an integration time in seconds given a target sensitivity (or vice-versa) for the zoom mode. The result contains a spectral line calculation and weighting parameters (line spectral mode) for the given zoom window.

Query Parameters:

  • subarray_configuration (string) – Enumeration of the 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] (Required)

  • freq_centres_mhz (array) – Array of the central frequency of each zoom windows in MHz. Combined with the total_bandwidths_khz, each must define a spectral window that is contained within the Low frequency range. (Required)

  • spectral_averaging_factor (number) – Factor by which the spectral resolution should be averaged to calculate the effective resolution which is used in the calculation. The maximum value is set to half the number of channels in a zoom window.

  • 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.). The only other validation prevents the spectral resolution from exceeding the bandwidth of the largest zoom window. (Required)

  • total_bandwidths_khz (array) – The total bandwidth of each of the zoom windows in kHz. Combined with the freq_centres_mhz, each must define a spectral window that is contained within the Low frequency range. The value must correspond to the bandwidth of one of seven LOW zoom windows, to within 0.1 kHz. (Required)

  • elevation_limit (number) – Lowest elevation that the LOW observation will be performed at. The maximum value is nominally 90 degrees, but the enforced limit is actually the highest elevation that can be achieved given the source declination and the latitude of the telescope.

  • weighting_mode (string) – Enumeration of the weighting strategy used. (Required)

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

Status Codes:

  • 200 OK – Successful response with the results of the zoom sensitivity calculation, weighting calculations. Weighted results using these responses are also returned.

  • 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) – Enumeration of the 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) – Lowest elevation that the LOW observation will be performed at. The maximum value is nominally 90 degrees, but the enforced limit is actually the highest elevation that can be achieved given the source declination and the latitude of the telescope.

  • freq_centre_mhz (number) – Central frequency in MHz. Combined with the bandwidth_mhz, it must define a spectral window that is contained within the Low frequency range.

  • bandwidth_mhz (number) – Bandwidth in MHz. This parameter is ignored if pulsar_mode is folded_pulse. Combined with the freq_centre_mhz, it must define a spectral window that is contained within the Low frequency range.

  • dm (number) – Dispersion Measure in pc/cm^3

  • intrinsic_pulse_width (number) – Intrinsic pulse width in milliseconds. If pulsar_mode is folded pulse, this must be less than the pulse period.

  • pulse_period (number) – Pulse period in milliseconds. This parameter is ignored if pulsar_mode is single_pulse.

  • pulsar_mode (string) – Sensitivity calculation type. Must be one of folded_pulse or single_pulse. (Required)

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.