curepy.container.prior module

Container for Prior information

class curepy.container.prior.Prior(prior_shape: List[str] = None, prior_params: List[dict] = [{}], prior_correlation: ndarray | None = None)

Bases: object

combine_dist_functions(xs: ndarray)

Evaluate each individual prior distribution at the corresponding value.

Parameters:

xs – Sequence of parameter values, one per retrieval parameter.

Returns:

Callable that, when invoked, returns a list of log-prior values from each individual distribution.

return_Sa_inv() → ndarray | None

Compute the inverse of the prior covariance matrix.

Constructs the prior covariance from the "sigma" entries in prior_params and the (optionally formatted) correlation matrix, then returns its inverse. Returns None if no correlation matrix is available.

Returns:

Inverse of the prior covariance matrix, or None if the correlation matrix is undefined.