ska_ost_senscalc.low.api

These functions map to the API paths, with the returned value being the API response

Connexion maps the function name to the operationId in the OpenAPI document path

ska_ost_senscalc.low.api.continuum_calculate(**kwargs) → Tuple[ContinuumSensitivityResponse | ErrorResponse, HTTPStatus][source]

Function which HTTP GET requests to /api/low/continuum/calculate are routed to.

Parameters:: kwargs – the HTTP parameters
Returns:: a tuple of the response body (which is either a ska_ost_senscalc.low.service.SensitivityResponse or an ErrorResponse) and HTTP status, which Connexion will wrap into a Response

ska_ost_senscalc.low.api.line_calculate(**kwargs) → Tuple[list[SingleLineSensitivityResponse] | ErrorResponse, HTTPStatus][source]

Function which HTTP GET requests to /api/low/line/calculate are routed to.

Parameters:: kwargs – the HTTP parameters
Returns:: a tuple of the response body (which is either a ska_ost_senscalc.low.service.SensitivityResponse or an ErrorResponse) and HTTP status, which Connexion will wrap into a Response

ska_ost_senscalc.low.api.pss_calculate(**kwargs) → Tuple[PSSSensitivityResponse | ErrorResponse, HTTPStatus][source]

Function which HTTP GET requests to /api/low/pss/calculate are routed to.

Parameters:: kwargs – the HTTP parameters
Returns:: a tuple of the response body (which is either a ska_ost_senscalc.low.service.SensitivityResponse or an ErrorResponse) and HTTP status, which Connexion will wrap into a Response

ska_ost_senscalc.low.api.subarrays()[source]

Function that GET requests to the /api/low/subarrays are routed to.

Returns a response containing a list of available subarrays