MID REST API

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) – Array configuration

  • 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 SKA antennas (K)

  • t_rx_ska (number) – Receiver Temperature of the SKA antennas (K)

  • t_spl_ska (number) – Spillover Temperature of the SKA antennas (K)

  • t_sys_meer (number) – System Temperature of the MeerKAT antennas (K)

  • t_rx_meer (number) – Receiver Temperature of the MeerKAT antennas (K)

  • t_spl_meer (number) – Spillover Temperature of the MeerKAT antennas (K)

  • t_sky_ska (number) – Sky temperature for SKA antennas (K)

  • t_sky_meer (number) – Sky temperature for MeerKAT antennas (K)

  • t_gal_ska (number) – Galactic temperature for SKA antennas (K)

  • t_gal_meer (number) – Galactic temperature for MeerKAT antennas (K)

  • alpha (number) – Spectral index of Galactic emission

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

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

  • eta_meer (number) – Dish efficiency for MeerKAT antennas

  • eta_ska (number) – Dish efficiency for SKA 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_chunks (integer) – Number of chunks. This provides additional outputs dividing the bandwidth in N chunks.

  • 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) – Array configuration (Required)

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

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

  • chunk_frequencies_hz (array) – Chunk frequencies in Hz. Providing chunk 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.