gaussian_energy.py 2.13 KB
Newer Older
Philipp Arras's avatar
Philipp Arras committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# Copyright(C) 2013-2018 Max-Planck-Society
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

Martin Reinecke's avatar
Martin Reinecke committed
19 20
from ..minimization.energy import Energy
from ..operators.sandwich_operator import SandwichOperator
Philipp Arras's avatar
Philipp Arras committed
21 22 23
from ..utilities import memo


Martin Reinecke's avatar
Martin Reinecke committed
24
# MR FIXME documentation incomplete
25
class GaussianEnergy(Energy):
26
    def __init__(self, inp, mean=None, covariance=None):
Philipp Arras's avatar
Philipp Arras committed
27
        """
Martin Reinecke's avatar
Martin Reinecke committed
28
        inp: Model object
Philipp Arras's avatar
Philipp Arras committed
29 30 31 32

        value = 0.5 * s.vdot(s), i.e. a log-Gauss distribution with unit
        covariance
        """
33 34 35 36
        super(GaussianEnergy, self).__init__(inp.position)
        self._inp = inp
        self._mean = mean
        self._cov = covariance
Philipp Arras's avatar
Philipp Arras committed
37 38

    def at(self, position):
39
        return self.__class__(self._inp.at(position), self._mean, self._cov)
Philipp Arras's avatar
Philipp Arras committed
40 41 42

    @property
    @memo
Martin Reinecke's avatar
Martin Reinecke committed
43 44 45 46 47 48 49 50 51
    def _residual(self):
        return self._inp.value if self._mean is None else \
            self._inp.value - self._mean

    @property
    @memo
    def _icovres(self):
        return self._residual if self._cov is None else \
            self._cov.inverse_times(self._residual)
Philipp Arras's avatar
Philipp Arras committed
52 53 54 55

    @property
    @memo
    def value(self):
Martin Reinecke's avatar
Martin Reinecke committed
56
        return .5 * self._residual.vdot(self._icovres).real
57

Philipp Arras's avatar
Philipp Arras committed
58 59 60
    @property
    @memo
    def gradient(self):
Martin Reinecke's avatar
Martin Reinecke committed
61
        return self._inp.jacobian.adjoint_times(self._icovres)
Philipp Arras's avatar
Philipp Arras committed
62 63 64

    @property
    @memo
Martin Reinecke's avatar
Martin Reinecke committed
65
    def metric(self):
Martin Reinecke's avatar
Martin Reinecke committed
66 67 68
        return SandwichOperator.make(
            self._inp.jacobian,
            None if self._cov is None else self._cov.inverse)