endomorphic_operator.py 2.25 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
# 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/>.
Theo Steininger's avatar
Theo Steininger committed
13
#
Martin Reinecke's avatar
Martin Reinecke committed
14
# Copyright(C) 2013-2018 Max-Planck-Society
Theo Steininger's avatar
Theo Steininger committed
15 16 17
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.
18

Martin Reinecke's avatar
Martin Reinecke committed
19
from __future__ import absolute_import, division, print_function
20 21 22

import numpy as np

Martin Reinecke's avatar
Martin Reinecke committed
23
from ..compat import *
Martin Reinecke's avatar
Martin Reinecke committed
24
from .linear_operator import LinearOperator
25 26 27


class EndomorphicOperator(LinearOperator):
Martin Reinecke's avatar
Martin Reinecke committed
28
    """ NIFTy class for endomorphic operators.
29

Martin Reinecke's avatar
Martin Reinecke committed
30
    The  NIFTy EndomorphicOperator class is a class derived from the
Theo Steininger's avatar
Theo Steininger committed
31 32
    LinearOperator. By definition, domain and target are the same in
    EndomorphicOperator.
33 34
    """

35 36
    @property
    def target(self):
Martin Reinecke's avatar
Martin Reinecke committed
37 38 39 40
        """DomainTuple : returns :attr:`domain`

        Returns `self.domain`, because this is also the target domain
        for endomorphic operators."""
Martin Reinecke's avatar
Martin Reinecke committed
41
        return self._domain
clienhar's avatar
clienhar committed
42

43
    def draw_sample(self, from_inverse=False, dtype=np.float64):
clienhar's avatar
clienhar committed
44 45 46 47 48
        """Generate a zero-mean sample

        Generates a sample from a Gaussian distribution with zero mean and
        covariance given by the operator.

49 50 51 52 53 54 55
        Parameters
        ----------
        from_inverse : bool (default : False)
            if True, the sample is drawn from the inverse of the operator
        dtype : numpy datatype (default : numpy.float64)
            the data type to be used for the sample

clienhar's avatar
clienhar committed
56 57 58 59 60 61
        Returns
        -------
        Field
            A sample from the Gaussian of given covariance.
        """
        raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
62 63 64 65 66

    def _check_input(self, x, mode):
        self._check_mode(mode)
        if self.domain is not x.domain:
            raise ValueError("The operator's and field's domains don't match.")