ArrayWeighting

class odl.space.weighting.ArrayWeighting(array, impl, exponent=2.0)

Bases: odl.space.weighting.Weighting

Weighting of a space by an array.

The exact definition of the weighted inner product, norm and distance functions depend on the concrete space.

The array may only have positive entries, otherwise it does not define an inner product or norm, respectively. This is not checked during initialization.

Attributes

array

Weighting array of this instance.

exponent

Exponent of this weighting.

impl

Implementation backend of this weighting.

repr_part

String usable in a space’s __repr__ method.

Methods

dist(self, x1, x2)	Calculate the distance between two elements.
equiv(self, other)	Return True if other is an equivalent weighting.
inner(self, x1, x2)	Return the inner product of two elements.
is_valid(self)	Return True if the array is a valid weight, i.e. positive.
norm(self, x)	Calculate the norm of an element.

__init__(self, array, impl, exponent=2.0)

Initialize a new instance.

Parameters

arrayarray-like

Weighting array of inner product, norm and distance. Native Tensor instances are stored as-is without copying.

implstring

Specifier for the implementation backend.

exponentpositive float, optional

Exponent of the norm. For values other than 2.0, the inner product is not defined.