simple_linear_operators.py 12 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
2
3
4
5
6
7
8
9
10
11
12
13
# 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/>.
#
Philipp Arras's avatar
Philipp Arras committed
14
# Copyright(C) 2013-2020 Max-Planck-Society
Martin Reinecke's avatar
Martin Reinecke committed
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
Martin Reinecke's avatar
Martin Reinecke committed
17

Philipp Arras's avatar
Philipp Arras committed
18
19
import numpy as np

Martin Reinecke's avatar
Martin Reinecke committed
20
21
from ..domain_tuple import DomainTuple
from ..domains.unstructured_domain import UnstructuredDomain
Martin Reinecke's avatar
Martin Reinecke committed
22
from ..field import Field
Philipp Arras's avatar
Philipp Arras committed
23
from ..multi_domain import MultiDomain
Martin Reinecke's avatar
Martin Reinecke committed
24
from ..multi_field import MultiField
25
from .endomorphic_operator import EndomorphicOperator
Philipp Arras's avatar
Philipp Arras committed
26
from .linear_operator import LinearOperator
Martin Reinecke's avatar
Martin Reinecke committed
27
28
29


class VdotOperator(LinearOperator):
Martin Reinecke's avatar
Martin Reinecke committed
30
31
32
33
    """Operator computing the scalar product of its input with a given Field.

    Parameters
    ----------
Philipp Arras's avatar
Philipp Arras committed
34
    field : Field or MultiField
Martin Reinecke's avatar
Martin Reinecke committed
35
36
        The field used to build the scalar product with the operator input
    """
Martin Reinecke's avatar
Martin Reinecke committed
37
38
    def __init__(self, field):
        self._field = field
Martin Reinecke's avatar
Martin Reinecke committed
39
        self._domain = field.domain
Martin Reinecke's avatar
Martin Reinecke committed
40
        self._target = DomainTuple.scalar_domain()
Martin Reinecke's avatar
Martin Reinecke committed
41
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
42
43

    def apply(self, x, mode):
Martin Reinecke's avatar
Martin Reinecke committed
44
        self._check_mode(mode)
Martin Reinecke's avatar
Martin Reinecke committed
45
        if mode == self.TIMES:
Martin Reinecke's avatar
Martin Reinecke committed
46
            return self._field.vdot(x)
Martin Reinecke's avatar
stage2    
Martin Reinecke committed
47
        return self._field*x.val[()]
Martin Reinecke's avatar
Martin Reinecke committed
48
49


Martin Reinecke's avatar
Martin Reinecke committed
50
class ConjugationOperator(EndomorphicOperator):
51
52
53
54
55
56
57
58
    """Operator computing the complex conjugate of its input.

    Parameters
    ----------
    domain: Domain, tuple of domains or DomainTuple
        domain of the input field

    """
Martin Reinecke's avatar
Martin Reinecke committed
59
    def __init__(self, domain):
Martin Reinecke's avatar
Martin Reinecke committed
60
        self._domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
61
        self._capability = self._all_ops
Martin Reinecke's avatar
Martin Reinecke committed
62
63
64
65
66
67

    def apply(self, x, mode):
        self._check_input(x, mode)
        return x.conjugate()


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
class WeightApplier(EndomorphicOperator):
    """Operator multiplying its input by a given power of dvol.

    Parameters
    ----------
    domain: Domain, tuple of domains or DomainTuple
        domain of the input field
    spaces: list or tuple of int
        indices of subdomains for which the weights shall be applied
    power: int
        the power of to be used for the volume factors

    """
    def __init__(self, domain, spaces, power):
        from .. import utilities
        self._domain = DomainTuple.make(domain)
        if spaces is None:
            self._spaces = None
        else:
            self._spaces = utilities.parse_spaces(spaces, len(self._domain))
        self._power = int(power)
        self._capability = self._all_ops

    def apply(self, x, mode):
        self._check_input(x, mode)
        power = self._power if (mode & 3) else -self._power
        return x.weight(power, spaces=self._spaces)


Martin Reinecke's avatar
Martin Reinecke committed
97
class Realizer(EndomorphicOperator):
98
99
100
101
102
103
104
105
    """Operator returning the real component of its input.

    Parameters
    ----------
    domain: Domain, tuple of domains or DomainTuple
        domain of the input field

    """
Martin Reinecke's avatar
Martin Reinecke committed
106
    def __init__(self, domain):
Martin Reinecke's avatar
Martin Reinecke committed
107
        self._domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
108
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
109
110
111
112

    def apply(self, x, mode):
        self._check_input(x, mode)
        return x.real
Martin Reinecke's avatar
Martin Reinecke committed
113
114


Philipp Arras's avatar
Philipp Arras committed
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
class Imaginizer(EndomorphicOperator):
    """Operator returning the imaginary component of its input.

    Parameters
    ----------
    domain: Domain, tuple of domains or DomainTuple
        domain of the input field

    """
    def __init__(self, domain):
        self._domain = DomainTuple.make(domain)
        self._capability = self.TIMES | self.ADJOINT_TIMES

    def apply(self, x, mode):
        self._check_input(x, mode)
Philipp Arras's avatar
Philipp Arras committed
130
        if mode == self.TIMES:
Philipp Arras's avatar
Philipp Arras committed
131
132
            if not np.issubdtype(x.dtype, np.complexfloating):
                raise ValueError
Philipp Arras's avatar
Philipp Arras committed
133
            return x.imag
Philipp Arras's avatar
Philipp Arras committed
134
135
        if x.dtype not in (np.float64, np.float32):
            raise ValueError
Philipp Arras's avatar
Philipp Arras committed
136
        return 1j*x
Philipp Arras's avatar
Philipp Arras committed
137
138


139
class FieldAdapter(LinearOperator):
Martin Reinecke's avatar
Martin Reinecke committed
140
    """Operator for conversion between Fields and MultiFields.
Philipp Arras's avatar
Philipp Arras committed
141
142
143

    Parameters
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
144
145
146
147
148
149
150
151
    tgt : Domain, tuple of Domain, DomainTuple, dict or MultiDomain:
        If this is a Domain, tuple of Domain or DomainTuple, this will be the
        operator's target, and its domain will be a MultiDomain consisting of
        its domain with the supplied `name`
        If this is a dict or MultiDomain, everything except for `name` will
        be stripped out of it, and the result will be the operator's target.
        Its domain will then be the DomainTuple corresponding to the single
        entry in the operator's domain.
Philipp Arras's avatar
Philipp Arras committed
152
153

    name : String
Martin Reinecke's avatar
Martin Reinecke committed
154
        The relevant key of the MultiDomain.
Philipp Arras's avatar
Philipp Arras committed
155
156
    """

157
    def __init__(self, target, name):
Martin Reinecke's avatar
Martin Reinecke committed
158
        from ..sugar import makeDomain
159
        tmp = makeDomain(target)
Martin Reinecke's avatar
Martin Reinecke committed
160
161
162
163
164
165
        if isinstance(tmp, DomainTuple):
            self._target = tmp
            self._domain = MultiDomain.make({name: tmp})
        else:
            self._domain = tmp[name]
            self._target = MultiDomain.make({name: tmp[name]})
Martin Reinecke's avatar
Martin Reinecke committed
166
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
167
168
169

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
170
        if isinstance(x, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
171
            return x.values()[0]
Martin Reinecke's avatar
Martin Reinecke committed
172
173
174
175
        else:
            return MultiField(self._tgt(mode), (x,))

    def __repr__(self):
176
177
178
179
180
181
182
183
184
185
        s = 'FieldAdapter'
        dom = isinstance(self._domain, MultiDomain)
        tgt = isinstance(self._target, MultiDomain)
        if dom and tgt:
            s += ' {} <- {}'.format(self._target.keys(), self._domain.keys())
        elif dom:
            s += ' <- {}'.format(self._domain.keys())
        elif tgt:
            s += ' {} <-'.format(self._target.keys())
        return s
Martin Reinecke's avatar
Martin Reinecke committed
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201


class _SlowFieldAdapter(LinearOperator):
    """Operator for conversion between Fields and MultiFields.
    The operator is built so that the MultiDomain is always the target.
    Its domain is `tgt[name]`

    Parameters
    ----------
    dom : dict or MultiDomain:
        the operator's dom

    name : String
        The relevant key of the MultiDomain.
    """

202
    def __init__(self, domain, name):
Martin Reinecke's avatar
Martin Reinecke committed
203
        from ..sugar import makeDomain
204
        tmp = makeDomain(domain)
Martin Reinecke's avatar
Martin Reinecke committed
205
206
207
208
209
210
211
212
213
214
215
        if not isinstance(tmp, MultiDomain):
            raise TypeError("MultiDomain expected")
        self._name = str(name)
        self._domain = tmp
        self._target = tmp[name]
        self._capability = self.TIMES | self.ADJOINT_TIMES

    def apply(self, x, mode):
        self._check_input(x, mode)
        if isinstance(x, MultiField):
            return x[self._name]
Philipp Arras's avatar
Philipp Arras committed
216
        return MultiField.from_dict({self._name: x}, domain=self._tgt(mode))
Martin Reinecke's avatar
Martin Reinecke committed
217
218
219

    def __repr__(self):
        return '_SlowFieldAdapter'
Martin Reinecke's avatar
Martin Reinecke committed
220
221
222


def ducktape(left, right, name):
Martin Reinecke's avatar
Martin Reinecke committed
223
    """Convenience function creating an operator that converts between a
Martin Reinecke's avatar
Martin Reinecke committed
224
    DomainTuple and a MultiDomain.
Martin Reinecke's avatar
Martin Reinecke committed
225
226
227
228

    Parameters
    ----------
    left : None, Operator, or Domainoid
Martin Reinecke's avatar
Martin Reinecke committed
229
        Something describing the new operator's target domain.
Martin Reinecke's avatar
Martin Reinecke committed
230
231
232
        If `left` is an `Operator`, its domain is used as `left`.

    right : None, Operator, or Domainoid
Martin Reinecke's avatar
Martin Reinecke committed
233
        Something describing the new operator's input domain.
Martin Reinecke's avatar
Martin Reinecke committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
        If `right` is an `Operator`, its target is used as `right`.

    name : string
        The component of the `MultiDomain` that will be extracted/inserted

    Notes
    -----
    - one of the involved domains must be a `DomainTuple`, the other a
      `MultiDomain`.
    - `left` and `right` must not be both `None`, but one of them can (and
      probably should) be `None`. In this case, the missing information is
      inferred.

    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
249
250
251
    FieldAdapter or _SlowFieldAdapter
        an adapter operator converting between the two (possibly
        partially inferred) domains.
Martin Reinecke's avatar
Martin Reinecke committed
252
    """
Martin Reinecke's avatar
Martin Reinecke committed
253
254
    from ..sugar import makeDomain
    from .operator import Operator
255
256
257
258
259
260
261
262
    if isinstance(right, Operator):
        right = right.target
    elif right is not None:
        right = makeDomain(right)
    if isinstance(left, Operator):
        left = left.domain
    elif left is not None:
        left = makeDomain(left)
Martin Reinecke's avatar
Martin Reinecke committed
263
264
265
266
267
    if left is None:  # need to infer left from right
        if isinstance(right, MultiDomain):
            left = right[name]
        else:
            left = MultiDomain.make({name: right})
268
    elif right is None:  # need to infer right from left
Martin Reinecke's avatar
Martin Reinecke committed
269
270
271
272
273
274
        if isinstance(left, MultiDomain):
            right = left[name]
        else:
            right = MultiDomain.make({name: left})
    lmulti = isinstance(left, MultiDomain)
    rmulti = isinstance(right, MultiDomain)
Lukas Platz's avatar
Lukas Platz committed
275
    if lmulti + rmulti != 1:
Martin Reinecke's avatar
Martin Reinecke committed
276
277
278
279
280
281
282
283
        raise ValueError("need exactly one MultiDomain")
    if lmulti:
        if len(left) == 1:
            return FieldAdapter(left, name)
        else:
            return _SlowFieldAdapter(left, name).adjoint
    if rmulti:
        if len(right) == 1:
284
            return FieldAdapter(left, name)
Martin Reinecke's avatar
Martin Reinecke committed
285
286
287
        else:
            return _SlowFieldAdapter(right, name)
    raise ValueError("must not arrive here")
Martin Reinecke's avatar
Martin Reinecke committed
288
289
290
291
292
293
294
295
296
297


class GeometryRemover(LinearOperator):
    """Operator which transforms between a structured and an unstructured
    domain.

    Parameters
    ----------
    domain: Domain, tuple of Domain, or DomainTuple:
        the full input domain of the operator.
298
    space: int, optional
Martin Reinecke's avatar
Martin Reinecke committed
299
        The index of the subdomain on which the operator should act.
300
        If None, it acts on all spaces.
Martin Reinecke's avatar
Martin Reinecke committed
301
302
303
304
305
306
307
308

    Notes
    -----
    The operator will convert every sub-domain of its input domain to an
    UnstructuredDomain with the same shape. No weighting by volume factors
    is carried out.
    """

309
    def __init__(self, domain, space=None):
Martin Reinecke's avatar
Martin Reinecke committed
310
        self._domain = DomainTuple.make(domain)
311
312
313
314
315
316
        if space is not None:
            tgt = [dom for dom in self._domain]
            tgt[space] = UnstructuredDomain(self._domain[space].shape)
        else:
            tgt = [UnstructuredDomain(dom.shape) for dom in self._domain]
        self._target = DomainTuple.make(tgt)
Martin Reinecke's avatar
Martin Reinecke committed
317
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
318
319
320

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
321
        return x.cast_domain(self._tgt(mode))
Martin Reinecke's avatar
Martin Reinecke committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338


class NullOperator(LinearOperator):
    """Operator corresponding to a matrix of all zeros.

    Parameters
    ----------
    domain : DomainTuple or MultiDomain
        input domain
    target : DomainTuple or MultiDomain
        output domain
    """

    def __init__(self, domain, target):
        from ..sugar import makeDomain
        self._domain = makeDomain(domain)
        self._target = makeDomain(target)
Martin Reinecke's avatar
Martin Reinecke committed
339
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
340
341
342
343

    @staticmethod
    def _nullfield(dom):
        if isinstance(dom, DomainTuple):
Martin Reinecke's avatar
Martin Reinecke committed
344
            return Field(dom, 0)
Martin Reinecke's avatar
Martin Reinecke committed
345
346
347
348
349
        else:
            return MultiField.full(dom, 0)

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
350
        return self._nullfield(self._tgt(mode))
351
352


353
class PartialExtractor(LinearOperator):
354
355
356
357
358
359
360
    def __init__(self, domain, target):
        if not isinstance(domain, MultiDomain):
            raise TypeError("MultiDomain expected")
        if not isinstance(target, MultiDomain):
            raise TypeError("MultiDomain expected")
        self._domain = domain
        self._target = target
Martin Reinecke's avatar
Martin Reinecke committed
361
        for key in self._target.keys():
362
            if self._domain[key] is not self._target[key]:
Martin Reinecke's avatar
Martin Reinecke committed
363
                raise ValueError("domain mismatch")
364
        self._capability = self.TIMES | self.ADJOINT_TIMES
Philipp Arras's avatar
Philipp Arras committed
365
366
367
        self._compldomain = MultiDomain.make({kk: self._domain[kk]
                                              for kk in self._domain.keys()
                                              if kk not in self._target.keys()})
368
369
370
371

    def apply(self, x, mode):
        self._check_input(x, mode)
        if mode == self.TIMES:
Martin Reinecke's avatar
Martin Reinecke committed
372
            return x.extract(self._target)
Philipp Arras's avatar
Philipp Arras committed
373
374
375
        res0 = MultiField.from_dict({key: x[key] for key in x.domain.keys()})
        res1 = MultiField.full(self._compldomain, 0.)
        return res0.unite(res1)