diagonal_operator.py 5.21 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
#
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 division
20
import numpy as np
21
from ..field import Field, sqrt
Martin Reinecke's avatar
Martin Reinecke committed
22
23
from ..domain_tuple import DomainTuple
from .endomorphic_operator import EndomorphicOperator
24
from .. import utilities
Martin Reinecke's avatar
Martin Reinecke committed
25
from .. import dobj
Martin Reinecke's avatar
Martin Reinecke committed
26

27
28

class DiagonalOperator(EndomorphicOperator):
Martin Reinecke's avatar
Martin Reinecke committed
29
    """ NIFTy class for diagonal operators.
Theo Steininger's avatar
Theo Steininger committed
30

Martin Reinecke's avatar
Martin Reinecke committed
31
    The NIFTy DiagonalOperator class is a subclass derived from the
Theo Steininger's avatar
Theo Steininger committed
32
33
    EndomorphicOperator. It multiplies an input field pixel-wise with its
    diagonal.
34

35
36
    Parameters
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
37
    diagonal : Field
38
39
        The diagonal entries of the operator
        (already containing volume factors).
Martin Reinecke's avatar
Martin Reinecke committed
40
    domain : tuple of DomainObjects
41
42
43
44
45
        The domain on which the Operator's input Field lives.
        If None, use the domain of "diagonal".
    spaces : tuple of int
        The elements of "domain" on which the operator acts.
        If None, it acts on all elements.
46

Martin Reinecke's avatar
Martin Reinecke committed
47
    NOTE: the fields given to __init__ and returned from .diagonal are
48
49
    considered to be non-bare, i.e. during operator application, no additional
    volume factors are applied!
50
51
    """

52
    def __init__(self, diagonal, domain=None, spaces=None):
53
        super(DiagonalOperator, self).__init__()
54

Martin Reinecke's avatar
Martin Reinecke committed
55
56
        if not isinstance(diagonal, Field):
            raise TypeError("Field object required")
57
58
59
60
61
62
63
64
65
        if domain is None:
            self._domain = diagonal.domain
        else:
            self._domain = DomainTuple.make(domain)
        if spaces is None:
            self._spaces = None
            if diagonal.domain != self._domain:
                raise ValueError("domain mismatch")
        else:
66
67
            self._spaces = utilities.parse_spaces(spaces, len(self._domain))
            if len(self._spaces) != len(diagonal.domain):
68
                raise ValueError("spaces and domain must have the same length")
Martin Reinecke's avatar
Martin Reinecke committed
69
            # if nspc==len(self.diagonal.domain),
Martin Reinecke's avatar
Martin Reinecke committed
70
71
            # we could do some optimization
            for i, j in enumerate(self._spaces):
72
73
                if diagonal.domain[i] != self._domain[j]:
                    raise ValueError("domain mismatch")
Martin Reinecke's avatar
Martin Reinecke committed
74
            if self._spaces == tuple(range(len(self._domain))):
Martin Reinecke's avatar
tweak    
Martin Reinecke committed
75
76
                self._spaces = None  # shortcut

Martin Reinecke's avatar
Martin Reinecke committed
77
        self._diagonal = diagonal.locked_copy()
Martin Reinecke's avatar
Martin Reinecke committed
78

Martin Reinecke's avatar
tweak    
Martin Reinecke committed
79
80
81
82
83
        if self._spaces is not None:
            active_axes = []
            for space_index in self._spaces:
                active_axes += self._domain.axes[space_index]

Martin Reinecke's avatar
Martin Reinecke committed
84
            if self._spaces[0] == 0:
Martin Reinecke's avatar
Martin Reinecke committed
85
                self._ldiag = self._diagonal.local_data
Martin Reinecke's avatar
Martin Reinecke committed
86
            else:
Martin Reinecke's avatar
Martin Reinecke committed
87
                self._ldiag = self._diagonal.to_global_data()
Martin Reinecke's avatar
Martin Reinecke committed
88
            locshape = dobj.local_shape(self._domain.shape, 0)
Martin Reinecke's avatar
tweak    
Martin Reinecke committed
89
            self._reshaper = [shp if i in active_axes else 1
Martin Reinecke's avatar
Martin Reinecke committed
90
91
92
93
                              for i, shp in enumerate(locshape)]
            self._ldiag = self._ldiag.reshape(self._reshaper)

        else:
Martin Reinecke's avatar
Martin Reinecke committed
94
            self._ldiag = self._diagonal.local_data
95

Martin Reinecke's avatar
Martin Reinecke committed
96
97
    def apply(self, x, mode):
        self._check_input(x, mode)
98

Martin Reinecke's avatar
Martin Reinecke committed
99
100
101
102
103
104
105
106
107
108
109
110
111
112
        if mode == self.TIMES:
            return Field(x.domain, val=x.val*self._ldiag)
        elif mode == self.ADJOINT_TIMES:
            if np.issubdtype(self._ldiag.dtype, np.floating):
                return Field(x.domain, val=x.val*self._ldiag)
            else:
                return Field(x.domain, val=x.val*self._ldiag.conj())
        elif mode == self.INVERSE_TIMES:
            return Field(x.domain, val=x.val/self._ldiag)
        else:
            if np.issubdtype(self._ldiag.dtype, np.floating):
                return Field(x.domain, val=x.val/self._ldiag)
            else:
                return Field(x.domain, val=x.val/self._ldiag.conj())
113

Martin Reinecke's avatar
Martin Reinecke committed
114
    @property
115
    def diagonal(self):
Martin Reinecke's avatar
Martin Reinecke committed
116
        """ Returns the diagonal of the Operator."""
Martin Reinecke's avatar
Martin Reinecke committed
117
        return self._diagonal
118

119
120
    @property
    def domain(self):
121
        return self._domain
122

123
    @property
Martin Reinecke's avatar
Martin Reinecke committed
124
    def capability(self):
Martin Reinecke's avatar
Martin Reinecke committed
125
126
127
128
129
130
131
132
133
134
        return self._all_ops

    @property
    def inverse(self):
        return DiagonalOperator(1./self._diagonal, self._domain, self._spaces)

    @property
    def adjoint(self):
        return DiagonalOperator(self._diagonal.conjugate(), self._domain,
                                self._spaces)
135

Martin Reinecke's avatar
Martin Reinecke committed
136
    def draw_sample(self):
137
138
139
140
141
142
143
144
        if self._spaces is not None:
            raise ValueError("Cannot draw (yet) from this operator")

        res = Field.from_random(random_type="normal",
                                domain=self._domain,
                                dtype=self._diagonal.dtype)
        res *= sqrt(self._diagonal)
        return res