cofi.utils

Utility classes and functions (e.g. to generate regularization terms and more)

The class inheritance of regularization classes:

        graph TD;
BaseRegularization --> LpNormRegularization;
LpNormRegularization --> QuadraticReg;
QuadraticReg --> SPDEMaternReg;
BaseRegularization --> ModelCovariance;
ModelCovariance --> GaussianPrior;
    

Classes

cofi.utils.BaseLikelihood()	Base class for a likelihood function
cofi.utils.BaseRegularization()	Base class for a regularization term
cofi.utils.GaussianPrior(...)	CoFI's utility class to calculate the Gaussian prior, given the inverse of model covariance matrix and the mean model
cofi.utils.InversionPool(...[, callback, ...])	This class manages an ensemble of inversions and allows them to be run in parallel or sequentially.
cofi.utils.LpNormRegularization([p, ...])	CoFI's utility class to calculate Lp-norm regularization, given the p value (default to 2), an optional weighting matrix and an optional reference value
cofi.utils.ModelCovariance()	CoFI's utility abstract class to calculate model prior distribution
cofi.utils.QuadraticReg([weighting_matrix, ...])	CoFI's utility class to calculate weighted L2 norm regularization with an optional reference model
cofi.utils.ReducedLikelihood(data, forward_func)	Reduced likelihood for various data covariance cases.
cofi.utils.ReducedLikelihoodManager(...[, ...])	Manager for multiple ReducedLikelihood instances with shared Jacobian computation.
cofi.utils.SPDEMaternReg(model_shape, ell[, ...])	Sparse Matérn ν=1 regularization for 2D spatial fields via the SPDE approach.
cofi.utils.SquaredExponentialKernel(positions)	Squared exponential (Gaussian/RBF) correlation kernel.