field.py 21.9 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

csongor's avatar
csongor committed
19
import numpy as np
20
21
22

from . import dobj, utilities
from .compat import *
Martin Reinecke's avatar
Martin Reinecke committed
23
from .domain_tuple import DomainTuple
24

25

Martin Reinecke's avatar
Martin Reinecke committed
26
class Field(object):
Martin Reinecke's avatar
Martin Reinecke committed
27
28
    _scalar_dom = DomainTuple.scalar_domain()

Theo Steininger's avatar
Theo Steininger committed
29
30
    """ The discrete representation of a continuous field over multiple spaces.

Martin Reinecke's avatar
Martin Reinecke committed
31
    In NIFTy, Fields are used to store data arrays and carry all the needed
32
    metainformation (i.e. the domain) for operators to be able to work on them.
Theo Steininger's avatar
Theo Steininger committed
33

34
35
    Parameters
    ----------
36
37
    domain : DomainTuple
        the domain of the new Field
Theo Steininger's avatar
Theo Steininger committed
38

39
40
41
    val : data_object
        This object's global shape must match the domain shape
        After construction, the object will no longer be writeable!
Martin Reinecke's avatar
Martin Reinecke committed
42
43
44
45

    Notes
    -----
    If possible, do not invoke the constructor directly, but use one of the
46
    many convenience functions for Field construction!
47
    """
48

49
50
51
    def __init__(self, domain, val):
        if not isinstance(domain, DomainTuple):
            raise TypeError("domain must be of type DomainTuple")
Martin Reinecke's avatar
Martin Reinecke committed
52
        if type(val) is not dobj.data_object:
Martin Reinecke's avatar
Martin Reinecke committed
53
            if np.isscalar(val):
Martin Reinecke's avatar
Martin Reinecke committed
54
                val = dobj.full(domain.shape, val)
Martin Reinecke's avatar
Martin Reinecke committed
55
56
            else:
                raise TypeError("val must be of type dobj.data_object")
57
        if domain.shape != val.shape:
Martin Reinecke's avatar
Martin Reinecke committed
58
            raise ValueError("shape mismatch between val and domain")
59
60
        self._domain = domain
        self._val = val
61
        dobj.lock(self._val)
Martin Reinecke's avatar
Martin Reinecke committed
62

Martin Reinecke's avatar
Martin Reinecke committed
63
64
65
66
    @staticmethod
    def scalar(val):
        return Field(Field._scalar_dom, val)

67
68
69
70
71
72
73
    # prevent implicit conversion to bool
    def __nonzero__(self):
        raise TypeError("Field does not support implicit conversion to bool")

    def __bool__(self):
        raise TypeError("Field does not support implicit conversion to bool")

74
    @staticmethod
75
    def full(domain, val):
Martin Reinecke's avatar
Martin Reinecke committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
        """Creates a Field with a given domain, filled with a constant value.

        Parameters
        ----------
        domain : Domain, tuple of Domain, or DomainTuple
            domain of the new Field
        val : float/complex/int scalar
            fill value. Data type of the field is inferred from val.

        Returns
        -------
        Field
            the newly created field
        """
90
91
        if not np.isscalar(val):
            raise TypeError("val must be a scalar")
92
93
94
        if not (np.isreal(val) or np.iscomplex(val)):
            raise TypeError("need arithmetic scalar")
        domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
95
        return Field(domain, val)
96

97
    @staticmethod
98
    def from_global_data(domain, arr, sum_up=False):
Martin Reinecke's avatar
Martin Reinecke committed
99
100
101
102
103
104
105
106
107
        """Returns a Field constructed from `domain` and `arr`.

        Parameters
        ----------
        domain : DomainTuple, tuple of Domain, or Domain
            the domain of the new Field
        arr : numpy.ndarray
            The data content to be used for the new Field.
            Its shape must match the shape of `domain`.
108
109
110
111
112
        sum_up : bool, optional
            If True, the contents of `arr` are summed up over all MPI tasks
            (if any), and the sum is used as data content.
            If False, the contens of `arr` are used directly, and must be
            identical on all MPI tasks.
Martin Reinecke's avatar
Martin Reinecke committed
113
        """
114
115
        return Field(DomainTuple.make(domain),
                     dobj.from_global_data(arr, sum_up))
116

Martin Reinecke's avatar
Martin Reinecke committed
117
118
    @staticmethod
    def from_local_data(domain, arr):
119
        return Field(DomainTuple.make(domain),
Martin Reinecke's avatar
Martin Reinecke committed
120
                     dobj.from_local_data(domain.shape, arr))
Martin Reinecke's avatar
Martin Reinecke committed
121

122
    def to_global_data(self):
Martin Reinecke's avatar
Martin Reinecke committed
123
124
125
126
127
128
129
        """Returns an array containing the full data of the field.

        Returns
        -------
        numpy.ndarray : array containing all field entries.
            Its shape is identical to `self.shape`.
        """
130
131
        return dobj.to_global_data(self._val)

132
133
134
135
136
137
138
139
140
141
    def to_global_data_rw(self):
        """Returns a modifiable array containing the full data of the field.

        Returns
        -------
        numpy.ndarray : array containing all field entries, which can be
            modified. Its shape is identical to `self.shape`.
        """
        return dobj.to_global_data_rw(self._val)

Martin Reinecke's avatar
Martin Reinecke committed
142
143
    @property
    def local_data(self):
Martin Reinecke's avatar
Martin Reinecke committed
144
145
146
147
148
        """numpy.ndarray : locally residing field data

        Returns a handle to the part of the array data residing on the local
        task (or to the entore array if MPI is not active).
        """
Martin Reinecke's avatar
Martin Reinecke committed
149
150
        return dobj.local_data(self._val)

Martin Reinecke's avatar
Martin Reinecke committed
151
    def cast_domain(self, new_domain):
Martin Reinecke's avatar
Martin Reinecke committed
152
153
154
155
156
157
158
159
160
161
162
163
164
        """Returns a field with the same data, but a different domain

        Parameters
        ----------
        new_domain : Domain, tuple of Domain, or DomainTuple
            The domain for the returned field. Must be shape-compatible to
            `self`.

        Returns
        -------
        Field
            Field living on `new_domain`, but with the same data as `self`.
        """
165
        return Field(DomainTuple.make(new_domain), self._val)
166

Martin Reinecke's avatar
Martin Reinecke committed
167
168
    @staticmethod
    def from_random(random_type, domain, dtype=np.float64, **kwargs):
169
170
171
172
        """ Draws a random field with the given parameters.

        Parameters
        ----------
Martin Reinecke's avatar
Martin Reinecke committed
173
174
        random_type : 'pm1', 'normal', or 'uniform'
            The random distribution to use.
Martin Reinecke's avatar
Martin Reinecke committed
175
        domain : DomainTuple
176
177
178
            The domain of the output random field
        dtype : type
            The datatype of the output random field
Theo Steininger's avatar
Theo Steininger committed
179

180
181
        Returns
        -------
Martin Reinecke's avatar
Martin Reinecke committed
182
        Field
Martin Reinecke's avatar
Martin Reinecke committed
183
            The newly created Field.
184
        """
Martin Reinecke's avatar
Martin Reinecke committed
185
        domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
186
187
188
        return Field(domain=domain,
                     val=dobj.from_random(random_type, dtype=dtype,
                                          shape=domain.shape, **kwargs))
189

Theo Steininger's avatar
Theo Steininger committed
190
191
    @property
    def val(self):
Martin Reinecke's avatar
Martin Reinecke committed
192
193
194
195
196
197
        """dobj.data_object : the data object storing the field's entries

        Notes
        -----
        This property is intended for low-level, internal use only. Do not use
        from outside of NIFTy's core; there should be better alternatives.
198
        """
Martin Reinecke's avatar
Martin Reinecke committed
199
        return self._val
csongor's avatar
csongor committed
200

Martin Reinecke's avatar
Martin Reinecke committed
201
202
    @property
    def dtype(self):
Martin Reinecke's avatar
Martin Reinecke committed
203
        """type : the data type of the field's entries"""
Martin Reinecke's avatar
Martin Reinecke committed
204
205
        return self._val.dtype

Martin Reinecke's avatar
Martin Reinecke committed
206
207
    @property
    def domain(self):
Martin Reinecke's avatar
Martin Reinecke committed
208
        """DomainTuple : the field's domain"""
Martin Reinecke's avatar
Martin Reinecke committed
209
210
        return self._domain

211
212
    @property
    def shape(self):
Martin Reinecke's avatar
Martin Reinecke committed
213
        """tuple of int : the concatenated shapes of all sub-domains"""
Martin Reinecke's avatar
Martin Reinecke committed
214
        return self._domain.shape
csongor's avatar
csongor committed
215

216
    @property
Martin Reinecke's avatar
Martin Reinecke committed
217
    def size(self):
Martin Reinecke's avatar
Martin Reinecke committed
218
        """int : total number of pixels in the field"""
Martin Reinecke's avatar
Martin Reinecke committed
219
        return self._domain.size
csongor's avatar
csongor committed
220

Theo Steininger's avatar
Theo Steininger committed
221
222
    @property
    def real(self):
Martin Reinecke's avatar
Martin Reinecke committed
223
        """Field : The real part of the field"""
Martin Reinecke's avatar
Martin Reinecke committed
224
225
226
        if utilities.iscomplextype(self.dtype):
            return Field(self._domain, self._val.real)
        return self
Theo Steininger's avatar
Theo Steininger committed
227
228
229

    @property
    def imag(self):
Martin Reinecke's avatar
Martin Reinecke committed
230
        """Field : The imaginary part of the field"""
Martin Reinecke's avatar
Martin Reinecke committed
231
        if not utilities.iscomplextype(self.dtype):
232
            raise ValueError(".imag called on a non-complex Field")
Martin Reinecke's avatar
Martin Reinecke committed
233
        return Field(self._domain, self._val.imag)
Theo Steininger's avatar
Theo Steininger committed
234

235
    def scalar_weight(self, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
        """Returns the uniform volume element for a sub-domain of `self`.

        Parameters
        ----------
        spaces : int, tuple of int or None
            indices of the sub-domains of the field's domain to be considered.
            If `None`, the entire domain is used.

        Returns
        -------
        float or None
            if the requested sub-domain has a uniform volume element, it is
            returned. Otherwise, `None` is returned.
        """
250
        if np.isscalar(spaces):
Martin Reinecke's avatar
Martin Reinecke committed
251
            return self._domain[spaces].scalar_dvol
252
253

        if spaces is None:
Martin Reinecke's avatar
Martin Reinecke committed
254
            spaces = range(len(self._domain))
Martin Reinecke's avatar
Martin Reinecke committed
255
        res = 1.
256
        for i in spaces:
Martin Reinecke's avatar
Martin Reinecke committed
257
            tmp = self._domain[i].scalar_dvol
258
259
260
261
262
            if tmp is None:
                return None
            res *= tmp
        return res

Martin Reinecke's avatar
Martin Reinecke committed
263
    def total_volume(self, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
264
265
266
267
268
269
270
271
272
273
274
275
276
        """Returns the total volume of a sub-domain of `self`.

        Parameters
        ----------
        spaces : int, tuple of int or None
            indices of the sub-domains of the field's domain to be considered.
            If `None`, the entire domain is used.

        Returns
        -------
        float
            the total volume of the requested sub-domain.
        """
Martin Reinecke's avatar
Martin Reinecke committed
277
        if np.isscalar(spaces):
Martin Reinecke's avatar
Martin Reinecke committed
278
            return self._domain[spaces].total_volume
Martin Reinecke's avatar
Martin Reinecke committed
279
280
281
282
283

        if spaces is None:
            spaces = range(len(self._domain))
        res = 1.
        for i in spaces:
Martin Reinecke's avatar
Martin Reinecke committed
284
            res *= self._domain[i].total_volume
Martin Reinecke's avatar
Martin Reinecke committed
285
286
        return res

287
    def weight(self, power=1, spaces=None):
Theo Steininger's avatar
Theo Steininger committed
288
        """ Weights the pixels of `self` with their invidual pixel-volume.
289
290
291
292

        Parameters
        ----------
        power : number
Theo Steininger's avatar
Theo Steininger committed
293
            The pixels get weighted with the volume-factor**power.
Theo Steininger's avatar
Theo Steininger committed
294

Martin Reinecke's avatar
Martin Reinecke committed
295
296
297
        spaces : None, int or tuple of int
            Determines on which sub-domain the operation takes place.
            If None, the entire domain is used.
Theo Steininger's avatar
Theo Steininger committed
298

299
300
        Returns
        -------
Martin Reinecke's avatar
Martin Reinecke committed
301
        Field
Theo Steininger's avatar
Theo Steininger committed
302
            The weighted field.
303
        """
304
        aout = self.local_data.copy()
csongor's avatar
csongor committed
305

Martin Reinecke's avatar
Martin Reinecke committed
306
        spaces = utilities.parse_spaces(spaces, len(self._domain))
csongor's avatar
csongor committed
307

308
309
        fct = 1.
        for ind in spaces:
Martin Reinecke's avatar
Martin Reinecke committed
310
            wgt = self._domain[ind].dvol
311
312
313
            if np.isscalar(wgt):
                fct *= wgt
            else:
Martin Reinecke's avatar
Martin Reinecke committed
314
                new_shape = np.ones(len(self.shape), dtype=np.int)
Martin Reinecke's avatar
Martin Reinecke committed
315
316
                new_shape[self._domain.axes[ind][0]:
                          self._domain.axes[ind][-1]+1] = wgt.shape
317
                wgt = wgt.reshape(new_shape)
Martin Reinecke's avatar
Martin Reinecke committed
318
319
                if dobj.distaxis(self._val) >= 0 and ind == 0:
                    # we need to distribute the weights along axis 0
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
320
                    wgt = dobj.local_data(dobj.from_global_data(wgt))
321
                aout *= wgt**power
322
        fct = fct**power
Martin Reinecke's avatar
Martin Reinecke committed
323
        if fct != 1.:
324
            aout *= fct
325

326
        return Field.from_local_data(self._domain, aout)
csongor's avatar
csongor committed
327

328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
    def outer(self, x):
        """ Computes the outer product of 'self' with x.

        Parameters
        ----------
        x : Field

        Returns
        ----------
        Field, lives on the product space of self.domain and x.domain
        """
        if not isinstance(x, Field):
            raise TypeError("The multiplier must be an instance of " +
                            "the NIFTy field class")
        from .operators.outer_product_operator import OuterProduct
        return OuterProduct(self, x.domain)(x)

Martin Reinecke's avatar
Martin Reinecke committed
345
    def vdot(self, x=None, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
346
        """ Computes the dot product of 'self' with x.
Theo Steininger's avatar
Theo Steininger committed
347

348
349
350
        Parameters
        ----------
        x : Field
351
            x must live on the same domain as `self`.
Theo Steininger's avatar
Theo Steininger committed
352

Martin Reinecke's avatar
Martin Reinecke committed
353
        spaces : None, int or tuple of int (default: None)
354
355
            The dot product is only carried out over the sub-domains in this
            tuple. If None, it is carried out over all sub-domains.
Theo Steininger's avatar
Theo Steininger committed
356

357
358
        Returns
        -------
Martin Reinecke's avatar
Martin Reinecke committed
359
        float, complex, either scalar (for full dot products)
360
                              or Field (for partial dot products)
361
        """
362
        if not isinstance(x, Field):
363
364
            raise TypeError("The dot-partner must be an instance of " +
                            "the NIFTy field class")
Theo Steininger's avatar
Theo Steininger committed
365

Martin Reinecke's avatar
Martin Reinecke committed
366
        if x._domain != self._domain:
367
            raise ValueError("Domain mismatch")
Theo Steininger's avatar
Theo Steininger committed
368

Martin Reinecke's avatar
Martin Reinecke committed
369
        ndom = len(self._domain)
370
371
372
        spaces = utilities.parse_spaces(spaces, ndom)

        if len(spaces) == ndom:
Martin Reinecke's avatar
Martin Reinecke committed
373
            return dobj.vdot(self._val, x._val)
374
375
        # If we arrive here, we have to do a partial dot product.
        # For the moment, do this the explicit, non-optimized way
Martin Reinecke's avatar
Martin Reinecke committed
376
        return (self.conjugate()*x).sum(spaces=spaces)
Theo Steininger's avatar
Theo Steininger committed
377

Martin Reinecke's avatar
Martin Reinecke committed
378
    def norm(self, ord=2):
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
379
        """ Computes the L2-norm of the field values.
csongor's avatar
csongor committed
380

Martin Reinecke's avatar
Martin Reinecke committed
381
382
383
384
        Parameters
        ----------
        ord : int, default=2
            accepted values: 1, 2, ..., np.inf
385
386
387
388

        Returns
        -------
        float
Martin Reinecke's avatar
Martin Reinecke committed
389
            The L2-norm of the field values.
390
        """
Martin Reinecke's avatar
Martin Reinecke committed
391
        return dobj.norm(self._val, ord)
392

Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
393
    def conjugate(self):
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
394
        """ Returns the complex conjugate of the field.
Theo Steininger's avatar
Theo Steininger committed
395

396
397
        Returns
        -------
Martin Reinecke's avatar
Martin Reinecke committed
398
399
        Field
            The complex conjugated field.
csongor's avatar
csongor committed
400
        """
Martin Reinecke's avatar
Martin Reinecke committed
401
        if utilities.iscomplextype(self._val.dtype):
Martin Reinecke's avatar
Martin Reinecke committed
402
403
            return Field(self._domain, self._val.conjugate())
        return self
csongor's avatar
csongor committed
404

Theo Steininger's avatar
Theo Steininger committed
405
    # ---General unary/contraction methods---
406

Theo Steininger's avatar
Theo Steininger committed
407
    def __pos__(self):
408
        return self
409

Theo Steininger's avatar
Theo Steininger committed
410
    def __neg__(self):
Martin Reinecke's avatar
Martin Reinecke committed
411
        return Field(self._domain, -self._val)
csongor's avatar
csongor committed
412

Theo Steininger's avatar
Theo Steininger committed
413
    def __abs__(self):
Martin Reinecke's avatar
Martin Reinecke committed
414
        return Field(self._domain, abs(self._val))
csongor's avatar
csongor committed
415

416
    def _contraction_helper(self, op, spaces):
Theo Steininger's avatar
Theo Steininger committed
417
        if spaces is None:
Martin Reinecke's avatar
Martin Reinecke committed
418
            return getattr(self._val, op)()
419

Martin Reinecke's avatar
Martin Reinecke committed
420
        spaces = utilities.parse_spaces(spaces, len(self._domain))
csongor's avatar
csongor committed
421

Martin Reinecke's avatar
Martin Reinecke committed
422
        axes_list = tuple(self._domain.axes[sp_index] for sp_index in spaces)
423

Martin Reinecke's avatar
Martin Reinecke committed
424
        if len(axes_list) > 0:
Theo Steininger's avatar
Theo Steininger committed
425
            axes_list = reduce(lambda x, y: x+y, axes_list)
csongor's avatar
csongor committed
426

Martin Reinecke's avatar
stage1    
Martin Reinecke committed
427
        # perform the contraction on the data
Martin Reinecke's avatar
Martin Reinecke committed
428
        data = getattr(self._val, op)(axis=axes_list)
csongor's avatar
csongor committed
429

Theo Steininger's avatar
Theo Steininger committed
430
431
432
        # check if the result is scalar or if a result_field must be constr.
        if np.isscalar(data):
            return data
csongor's avatar
csongor committed
433
        else:
Martin Reinecke's avatar
Martin Reinecke committed
434
            return_domain = tuple(dom
Martin Reinecke's avatar
Martin Reinecke committed
435
                                  for i, dom in enumerate(self._domain)
Theo Steininger's avatar
Theo Steininger committed
436
                                  if i not in spaces)
437

438
            return Field(DomainTuple.make(return_domain), data)
csongor's avatar
csongor committed
439

440
    def sum(self, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
        """Sums up over the sub-domains given by `spaces`.

        Parameters
        ----------
        spaces : None, int or tuple of int (default: None)
            The summation is only carried out over the sub-domains in this
            tuple. If None, it is carried out over all sub-domains.

        Returns
        -------
        Field or scalar
            The result of the summation. If it is carried out over the entire
            domain, this is a scalar, otherwise a Field.
        """
455
        return self._contraction_helper('sum', spaces)
csongor's avatar
csongor committed
456

457
    def integrate(self, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
        """Integrates over the sub-domains given by `spaces`.

        Integration is performed by summing over `self` multiplied by its
        volume factors.

        Parameters
        ----------
        spaces : None, int or tuple of int (default: None)
            The summation is only carried out over the sub-domains in this
            tuple. If None, it is carried out over all sub-domains.

        Returns
        -------
        Field or scalar
            The result of the integration. If it is carried out over the
            entire domain, this is a scalar, otherwise a Field.
        """
Martin Reinecke's avatar
Martin Reinecke committed
475
476
477
        swgt = self.scalar_weight(spaces)
        if swgt is not None:
            res = self.sum(spaces)
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
478
            res = res*swgt
Martin Reinecke's avatar
Martin Reinecke committed
479
            return res
480
481
482
        tmp = self.weight(1, spaces=spaces)
        return tmp.sum(spaces)

483
    def prod(self, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
484
485
486
487
488
489
490
491
492
493
494
495
496
497
        """Computes the product over the sub-domains given by `spaces`.

        Parameters
        ----------
        spaces : None, int or tuple of int (default: None)
            The operation is only carried out over the sub-domains in this
            tuple. If None, it is carried out over all sub-domains.

        Returns
        -------
        Field or scalar
            The result of the product. If it is carried out over the entire
            domain, this is a scalar, otherwise a Field.
        """
498
        return self._contraction_helper('prod', spaces)
csongor's avatar
csongor committed
499

500
501
    def all(self, spaces=None):
        return self._contraction_helper('all', spaces)
csongor's avatar
csongor committed
502

503
504
    def any(self, spaces=None):
        return self._contraction_helper('any', spaces)
csongor's avatar
csongor committed
505

506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
#     def min(self, spaces=None):
#         """Determines the minimum over the sub-domains given by `spaces`.
#
#         Parameters
#         ----------
#         spaces : None, int or tuple of int (default: None)
#             The operation is only carried out over the sub-domains in this
#             tuple. If None, it is carried out over all sub-domains.
#
#         Returns
#         -------
#         Field or scalar
#             The result of the operation. If it is carried out over the entire
#             domain, this is a scalar, otherwise a Field.
#         """
#         return self._contraction_helper('min', spaces)
#
#     def max(self, spaces=None):
#         """Determines the maximum over the sub-domains given by `spaces`.
#
#         Parameters
#         ----------
#         spaces : None, int or tuple of int (default: None)
#             The operation is only carried out over the sub-domains in this
#             tuple. If None, it is carried out over all sub-domains.
#
#         Returns
#         -------
#         Field or scalar
#             The result of the operation. If it is carried out over the entire
#             domain, this is a scalar, otherwise a Field.
#         """
#         return self._contraction_helper('max', spaces)
csongor's avatar
csongor committed
539

540
    def mean(self, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
        """Determines the mean over the sub-domains given by `spaces`.

        ``x.mean(spaces)`` is equivalent to
        ``x.integrate(spaces)/x.total_volume(spaces)``.

        Parameters
        ----------
        spaces : None, int or tuple of int (default: None)
            The operation is only carried out over the sub-domains in this
            tuple. If None, it is carried out over all sub-domains.

        Returns
        -------
        Field or scalar
            The result of the operation. If it is carried out over the entire
            domain, this is a scalar, otherwise a Field.
        """
558
559
        if self.scalar_weight(spaces) is not None:
            return self._contraction_helper('mean', spaces)
Martin Reinecke's avatar
Martin Reinecke committed
560
        # MR FIXME: not very efficient
561
562
        # MR FIXME: do we need "spaces" here?
        tmp = self.weight(1, spaces)
Martin Reinecke's avatar
Martin Reinecke committed
563
        return tmp.sum(spaces)*(1./tmp.total_volume(spaces))
csongor's avatar
csongor committed
564

565
    def var(self, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
566
567
568
569
570
571
572
573
574
575
576
577
578
579
        """Determines the variance over the sub-domains given by `spaces`.

        Parameters
        ----------
        spaces : None, int or tuple of int (default: None)
            The operation is only carried out over the sub-domains in this
            tuple. If None, it is carried out over all sub-domains.

        Returns
        -------
        Field or scalar
            The result of the operation. If it is carried out over the entire
            domain, this is a scalar, otherwise a Field.
        """
580
581
        if self.scalar_weight(spaces) is not None:
            return self._contraction_helper('var', spaces)
Martin Reinecke's avatar
Martin Reinecke committed
582
583
        # MR FIXME: not very efficient or accurate
        m1 = self.mean(spaces)
Martin Reinecke's avatar
Martin Reinecke committed
584
        if utilities.iscomplextype(self.dtype):
585
            sq = abs(self-m1)**2
Martin Reinecke's avatar
Martin Reinecke committed
586
        else:
587
588
            sq = (self-m1)**2
        return sq.mean(spaces)
csongor's avatar
csongor committed
589

590
    def std(self, spaces=None):
Martin Reinecke's avatar
Martin Reinecke committed
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
        """Determines the standard deviation over the sub-domains given by
        `spaces`.

        ``x.std(spaces)`` is equivalent to ``sqrt(x.var(spaces))``.

        Parameters
        ----------
        spaces : None, int or tuple of int (default: None)
            The operation is only carried out over the sub-domains in this
            tuple. If None, it is carried out over all sub-domains.

        Returns
        -------
        Field or scalar
            The result of the operation. If it is carried out over the entire
            domain, this is a scalar, otherwise a Field.
        """
608
        from .sugar import sqrt
609
610
611
        if self.scalar_weight(spaces) is not None:
            return self._contraction_helper('std', spaces)
        return sqrt(self.var(spaces))
csongor's avatar
csongor committed
612

Theo Steininger's avatar
Theo Steininger committed
613
    def __repr__(self):
Philipp Arras's avatar
Philipp Arras committed
614
        return "<nifty5.Field>"
Theo Steininger's avatar
Theo Steininger committed
615
616

    def __str__(self):
Philipp Arras's avatar
Philipp Arras committed
617
        return "nifty5.Field instance\n- domain      = " + \
618
               self._domain.__str__() + \
Martin Reinecke's avatar
Martin Reinecke committed
619
               "\n- val         = " + repr(self._val)
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
620

Martin Reinecke's avatar
more    
Martin Reinecke committed
621
    def extract(self, dom):
Martin Reinecke's avatar
Martin Reinecke committed
622
        if dom != self._domain:
Martin Reinecke's avatar
more    
Martin Reinecke committed
623
624
625
626
            raise ValueError("domain mismatch")
        return self

    def unite(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
627
628
629
630
        return self+other

    def flexible_addsub(self, other, neg):
        return self-other if neg else self+other
631

Martin Reinecke's avatar
Martin Reinecke committed
632
    def positive_tanh(self):
Martin Reinecke's avatar
Martin Reinecke committed
633
634
        return 0.5*(1.+self.tanh())

Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
635
636
637
    def clipped_exp(self):
        return Field(self._domain, dobj.clipped_exp(self._val))

Martin Reinecke's avatar
Martin Reinecke committed
638
639
640
641
    def _binary_op(self, other, op):
        # if other is a field, make sure that the domains match
        f = getattr(self._val, op)
        if isinstance(other, Field):
Martin Reinecke's avatar
Martin Reinecke committed
642
            if other._domain != self._domain:
Martin Reinecke's avatar
Martin Reinecke committed
643
644
645
646
647
                raise ValueError("domains are incompatible.")
            return Field(self._domain, f(other._val))
        if np.isscalar(other):
            return Field(self._domain, f(other))
        return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
648

Martin Reinecke's avatar
Martin Reinecke committed
649

Martin Reinecke's avatar
Martin Reinecke committed
650
651
652
for op in ["__add__", "__radd__",
           "__sub__", "__rsub__",
           "__mul__", "__rmul__",
653
654
655
656
           "__div__", "__rdiv__",
           "__truediv__", "__rtruediv__",
           "__floordiv__", "__rfloordiv__",
           "__pow__", "__rpow__",
657
658
659
           "__lt__", "__le__", "__gt__", "__ge__", "__eq__", "__ne__"]:
    def func(op):
        def func2(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
660
            return self._binary_op(other, op)
661
662
        return func2
    setattr(Field, op, func(op))
663
664
665
666
667
668
669
670
671

for op in ["__iadd__", "__isub__", "__imul__", "__idiv__",
           "__itruediv__", "__ifloordiv__", "__ipow__"]:
    def func(op):
        def func2(self, other):
            raise TypeError(
                "In-place operations are deliberately not supported")
        return func2
    setattr(Field, op, func(op))
Martin Reinecke's avatar
Martin Reinecke committed
672
673
674
675

for f in ["sqrt", "exp", "log", "tanh"]:
    def func(f):
        def func2(self):
Martin Reinecke's avatar
Martin Reinecke committed
676
            return Field(self._domain, getattr(dobj, f)(self.val))
Martin Reinecke's avatar
Martin Reinecke committed
677
678
        return func2
    setattr(Field, f, func(f))