ska_ost_senscalc.low.validation

This module provides semantic validation for inputs to the Sensitivity Calculator, including checking for required values, setting default values, and domain related checks.

Syntactic validation and basic validation, for example of min/max values of numbers, is done by Connexion and the OpenAPI spec.

ska_ost_senscalc.low.validation.validate_and_set_defaults_for_calculate(user_input: dict, spectral_mode: str) → ContinuumCalculatorAndWeightingInput | ZoomCalculatorAndWeightingInput

Parameters:

• user_input – the parameters from the HTTP request for the /api/low/continuum/calculate or /api/low/zoom/calculate request

• spectral_mode – the spectral mode of the calculation, either ‘continuum’ or ‘line’

Returns:

A data class instance of ContinuumCalculatorAndWeightingInput or ZoomCalculatorAndWeightingInput, with defaults set for missing values

Raises:

ValueError if the input data is not valid

ska_ost_senscalc.low.validation.validate_and_set_defaults_for_pss(user_input: dict) → dict

Parameters:

user_input – the parameters from the HTTP request for the /api/low/pss/calculate request

Returns:

A new copy of the input dict, with defaults set for missing values

Raises:

ValueError if the input data is not valid