Parameters and field requests

class midas.ParameterVector(name, size)

A class used for specifying the parameters required to evaluate a diagnostic model, field model or prior distribution.

Param:

name The name of the parameter(s).

Parameters:

class midas.Parameters(*parameters)

A tuple subclass which creates an immutable collection of validated ParameterVector objects. The arguments should be a series of ParameterVector.

static __new__(cls, *parameters)

Parameters:: parameters (ParameterVector | tuple[str, int]) – A series of ParameterVector objects specifying the required parameters. Alternatively, a series of tuples containing the parameter name as a string followed by the parameter vector size as an integer.

class midas.FieldRequest(name, coordinates)

A class used to request the values of particular fields which are required to evaluate a diagnostic model or prior distribution.

Parameters:

name (str) – The name of the field from which values are being requested.
coordinates (dict[str, ndarray]) – The coordinates at which the field values are being requested as a dictionary mapping the coordinate names to 1D arrays of coordinate values.

class midas.Fields(*field_requests)

A tuple subclass which creates an immutable collection of validated FieldRequest objects. The arguments should be a series of FieldRequest.

static __new__(cls, *field_requests)

Parameters:: field_requests (FieldRequest) – A series of FieldRequest objects specifying the requested fields.