pyrtid.regularization.PriorTerm#

class pyrtid.regularization.PriorTerm[source]#

Bases: ABC

Represent a prior term for the geostatistical regularization.

__init__()#

Methods definition

abstract get_gradient_dot_product(input: ndarray[Any, dtype[float64]]) → Union[float, ndarray[Any, dtype[float64]]][source]#

Return the dot product of the gradient of the prior and the given input vector.

Parameters

params (NDArrayFloat) – Values with which to compute the prior gradient dot product.

Returns

Prior gradient-input vector dot product.

Return type

NDArrayFloat

abstract get_values(params: ndarray[Any, dtype[float64]]) → Union[float, ndarray[Any, dtype[float64]]][source]#

Return the values of the prior term.

Parameters

params (NDArrayFloat) – Values of the parameters for which to compute the prior.

Returns

The prior term values.

Return type

NDArrayFloat