sugar.py 17 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-2019 Max-Planck-Society
Theo Steininger's avatar
Theo Steininger committed
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
17

18
import sys
19
from time import time
20

21
import numpy as np
22
23
24

from . import dobj, utilities
from .domain_tuple import DomainTuple
Martin Reinecke's avatar
Martin Reinecke committed
25
from .domains.power_space import PowerSpace
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
26
from .field import Field
27
from .linearization import Linearization
28
from .logger import logger
29
from .minimization.energy import Energy
Martin Reinecke's avatar
Martin Reinecke committed
30
31
from .multi_domain import MultiDomain
from .multi_field import MultiField
Philipp Arras's avatar
Philipp Arras committed
32
from .operators.block_diagonal_operator import BlockDiagonalOperator
Martin Reinecke's avatar
Martin Reinecke committed
33
from .operators.diagonal_operator import DiagonalOperator
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
34
from .operators.distributors import PowerDistributor
35
36
from .operators.energy_operators import EnergyOperator
from .operators.operator import Operator
Lukas Platz's avatar
Lukas Platz committed
37
from .plot import Plot
38

Martin Reinecke's avatar
step 1    
Martin Reinecke committed
39
40
__all__ = ['PS_field', 'power_analyze', 'create_power_operator',
           'create_harmonic_smoothing_operator', 'from_random',
41
           'full', 'from_global_data', 'from_local_data',
Jakob Knollmueller's avatar
Jakob Knollmueller committed
42
           'makeDomain', 'sqrt', 'exp', 'log', 'tanh', 'sigmoid',
Lukas Platz's avatar
fixup    
Lukas Platz committed
43
           'sin', 'cos', 'tan', 'sinh', 'cosh', 'log10',
Martin Reinecke's avatar
Martin Reinecke committed
44
           'absolute', 'one_over', 'clip', 'sinc',
45
           'conjugate', 'get_signal_variance', 'makeOp', 'domain_union',
46
           'get_default_codomain', 'single_plot', 'exec_time']
47

48

49
def PS_field(pspace, func):
Martin Reinecke's avatar
Martin Reinecke committed
50
51
52
53
54
55
56
57
    """Convenience function sampling a power spectrum

    Parameters
    ----------
    pspace : PowerSpace
        space at whose `k_lengths` the power spectrum function is evaluated
    func : function taking and returning a numpy.ndarray(float)
        the power spectrum function
Martin Reinecke's avatar
Martin Reinecke committed
58

Martin Reinecke's avatar
Martin Reinecke committed
59
60
    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
61
62
    Field
        A field defined on (pspace,) containing the computed function values
Martin Reinecke's avatar
Martin Reinecke committed
63
    """
Martin Reinecke's avatar
Martin Reinecke committed
64
65
66
    if not isinstance(pspace, PowerSpace):
        raise TypeError
    data = dobj.from_global_data(func(pspace.k_lengths))
67
    return Field(DomainTuple.make(pspace), data)
Martin Reinecke's avatar
Martin Reinecke committed
68

Martin Reinecke's avatar
Martin Reinecke committed
69

70
71
72
73
def get_signal_variance(spec, space):
    """
    Computes how much a field with a given power spectrum will vary in space

74
    This is a small helper function that computes the expected variance
75
76
77
78
79
80
81
82
    of a harmonically transformed sample of this power spectrum.

    Parameters
    ---------
    spec: method
        a method that takes one k-value and returns the power spectrum at that
        location
    space: PowerSpace or any harmonic Domain
Martin Reinecke's avatar
Martin Reinecke committed
83
84
85
86
        If this function is given a harmonic domain, it creates the naturally
        binned PowerSpace to that domain.
        The field, for which the signal variance is then computed, is assumed
        to have this PowerSpace as naturally binned PowerSpace
87
88
89
90
    """
    if space.harmonic:
        space = PowerSpace(space)
    if not isinstance(space, PowerSpace):
Martin Reinecke's avatar
Martin Reinecke committed
91
92
        raise ValueError(
            "space must be either a harmonic space or Power space.")
93
94
95
96
97
    field = PS_field(space, spec)
    dist = PowerDistributor(space.harmonic_partner, space)
    k_field = dist(field)
    return k_field.weight(2).sum()

98

99
100
def _single_power_analyze(field, idx, binbounds):
    power_domain = PowerSpace(field.domain[idx], binbounds)
Martin Reinecke's avatar
Martin Reinecke committed
101
102
    pd = PowerDistributor(field.domain, power_domain, idx)
    return pd.adjoint_times(field.weight(1)).weight(-1)  # divides by bin size
103
104


Martin Reinecke's avatar
Martin Reinecke committed
105
106
# MR FIXME: this function is not well suited for analyzing more than one
# subdomain at once, because it allows only one set of binbounds.
107
108
def power_analyze(field, spaces=None, binbounds=None,
                  keep_phase_information=False):
109
    """Computes the power spectrum for a subspace of `field`.
110
111

    Creates a PowerSpace for the space addressed by `spaces` with the given
112
    binning and computes the power spectrum as a :class:`Field` over this
113
    PowerSpace. This can only be done if the subspace to  be analyzed is a
Martin Reinecke's avatar
Martin Reinecke committed
114
115
    harmonic space. The resulting field has the same units as the square of the
    initial field.
116
117
118

    Parameters
    ----------
Philipp Arras's avatar
Fixups    
Philipp Arras committed
119
    field : Field
120
        The field to be analyzed
Martin Reinecke's avatar
Martin Reinecke committed
121
122
123
    spaces : None or int or tuple of int, optional
        The indices of subdomains for which the power spectrum shall be
        computed.
Martin Reinecke's avatar
Martin Reinecke committed
124
        If None, all subdomains will be converted.
125
        (default : None).
Martin Reinecke's avatar
Martin Reinecke committed
126
    binbounds : None or array-like, optional
127
        Inner bounds of the bins (default : None).
Martin Reinecke's avatar
Martin Reinecke committed
128
129
        if binbounds is None : bins are inferred.
    keep_phase_information : bool, optional
130
        If False, return a real-valued result containing the power spectrum
131
        of `field`.
132
        If True, return a complex-valued result whose real component
133
134
135
        contains the power spectrum computed from the real part of `field`,
        and whose imaginary component contains the power
        spectrum computed from the imaginary part of `field`.
136
137
138
139
140
141
        The absolute value of this result should be identical to the output
        of power_analyze with keep_phase_information=False.
        (default : False).

    Returns
    -------
Philipp Arras's avatar
Fixups    
Philipp Arras committed
142
    Field
143
        The output object. Its domain is a PowerSpace and it contains
Martin Reinecke's avatar
Martin Reinecke committed
144
        the power spectrum of `field`.
145
146
147
148
    """

    for sp in field.domain:
        if not sp.harmonic and not isinstance(sp, PowerSpace):
Martin Reinecke's avatar
Martin Reinecke committed
149
150
            logger.warning("WARNING: Field has a space in `domain` which is "
                           "neither harmonic nor a PowerSpace.")
151

152
    spaces = utilities.parse_spaces(spaces, len(field.domain))
153
154
155
156

    if len(spaces) == 0:
        raise ValueError("No space for analysis specified.")

Martin Reinecke's avatar
Martin Reinecke committed
157
    field_real = not utilities.iscomplextype(field.dtype)
158
159
160
    if (not field_real) and keep_phase_information:
        raise ValueError("cannot keep phase from real-valued input Field")

161
162
163
    if keep_phase_information:
        parts = [field.real*field.real, field.imag*field.imag]
    else:
164
165
166
167
        if field_real:
            parts = [field**2]
        else:
            parts = [field.real*field.real + field.imag*field.imag]
168
169

    for space_index in spaces:
Martin Reinecke's avatar
Martin Reinecke committed
170
        parts = [_single_power_analyze(part, space_index, binbounds)
171
172
173
174
175
                 for part in parts]

    return parts[0] + 1j*parts[1] if keep_phase_information else parts[0]


Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
176
def _create_power_field(domain, power_spectrum):
Philipp Arras's avatar
Philipp Arras committed
177
    if not callable(power_spectrum):  # we have a Field defined on a PowerSpace
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
178
179
180
181
182
183
184
        if not isinstance(power_spectrum, Field):
            raise TypeError("Field object expected")
        if len(power_spectrum.domain) != 1:
            raise ValueError("exactly one domain required")
        if not isinstance(power_spectrum.domain[0], PowerSpace):
            raise TypeError("PowerSpace required")
        power_domain = power_spectrum.domain[0]
185
        fp = power_spectrum
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
186
187
    else:
        power_domain = PowerSpace(domain)
188
        fp = PS_field(power_domain, power_spectrum)
189

Martin Reinecke's avatar
Martin Reinecke committed
190
    return PowerDistributor(domain, power_domain)(fp)
191

192

193
def create_power_operator(domain, power_spectrum, space=None):
194
    """Creates a diagonal operator with the given power spectrum.
195

Philipp Arras's avatar
Philipp Arras committed
196
    Constructs a diagonal operator that is defined on the specified domain.
197

198
199
    Parameters
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
200
    domain : Domain, tuple of Domain or DomainTuple
Philipp Arras's avatar
Philipp Arras committed
201
        Domain on which the power operator shall be defined.
Martin Reinecke's avatar
Martin Reinecke committed
202
203
    power_spectrum : callable or Field
        An object that contains the power spectrum as a function of k.
Martin Reinecke's avatar
Martin Reinecke committed
204
    space : int
Martin Reinecke's avatar
Martin Reinecke committed
205
        the domain index on which the power operator will work
Theo Steininger's avatar
Theo Steininger committed
206

207
208
    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
209
210
    DiagonalOperator
        An operator that implements the given power spectrum.
211
    """
Martin Reinecke's avatar
Martin Reinecke committed
212
    domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
213
    space = utilities.infer_space(domain, space)
Martin Reinecke's avatar
Martin Reinecke committed
214
215
    field = _create_power_field(domain[space], power_spectrum)
    return DiagonalOperator(field, domain, space)
216

217

218
def create_harmonic_smoothing_operator(domain, space, sigma):
Martin Reinecke's avatar
Martin Reinecke committed
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
    """Creates an operator which smoothes a subspace of a harmonic domain.

    Parameters
    ----------
    domain: DomainTuple
        The total domain and target of the operator
    space : int
        the index of the subspace on which the operator acts.
        This must be a harmonic space
    sigma : float
        The sigma of the Gaussian smoothing kernel

    Returns
    -------
    DiagonalOperator
        The requested smoothing operator
    """
236
237
238
    kfunc = domain[space].get_fft_smoothing_kernel_function(sigma)
    return DiagonalOperator(kfunc(domain[space].get_k_length_array()), domain,
                            space)
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
239
240
241


def full(domain, val):
Martin Reinecke's avatar
Martin Reinecke committed
242
243
244
245
246
247
248
249
250
251
252
    """Convenience function creating Fields/MultiFields with uniform values.

    Parameters
    ----------
    domain : Domainoid
        the intended domain of the output field
    val : scalar value
        the uniform value to be placed into all entries of the result

    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
253
254
    Field or MultiField
        The newly created uniform field
Martin Reinecke's avatar
Martin Reinecke committed
255
    """
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
256
257
258
259
260
261
    if isinstance(domain, (dict, MultiDomain)):
        return MultiField.full(domain, val)
    return Field.full(domain, val)


def from_random(random_type, domain, dtype=np.float64, **kwargs):
Martin Reinecke's avatar
Martin Reinecke committed
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
    """Convenience function creating Fields/MultiFields with random values.

    Parameters
    ----------
    random_type : 'pm1', 'normal', or 'uniform'
            The random distribution to use.
    domain : Domainoid
        the intended domain of the output field
    dtype : type
        data type of the output field (e.g. numpy.float64)
    **kwargs : additional parameters for the random distribution
        ('mean' and 'std' for 'normal', 'low' and 'high' for 'uniform')

    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
277
278
    Field or MultiField
        The newly created random field
Martin Reinecke's avatar
Martin Reinecke committed
279
    """
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
280
281
282
283
284
285
    if isinstance(domain, (dict, MultiDomain)):
        return MultiField.from_random(random_type, domain, dtype, **kwargs)
    return Field.from_random(random_type, domain, dtype, **kwargs)


def from_global_data(domain, arr, sum_up=False):
Martin Reinecke's avatar
Martin Reinecke committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
    """Convenience function creating Fields/MultiFields from Numpy arrays or
    dicts of Numpy arrays.

    Parameters
    ----------
    domain : Domainoid
        the intended domain of the output field
    arr : Numpy array if `domain` corresponds to a `DomainTuple`,
          dictionary of Numpy arrays if `domain` corresponds to a `MultiDomain`
    sum_up : bool
        Only meaningful if MPI is enabled
        If `True`, the contents of the arrays on all tasks are added together,
        otherwise it is assumed that the array on each task holds the correct
        field values.

    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
303
304
    Field or MultiField
        The newly created random field
Martin Reinecke's avatar
Martin Reinecke committed
305
    """
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
306
307
308
309
310
311
    if isinstance(domain, (dict, MultiDomain)):
        return MultiField.from_global_data(domain, arr, sum_up)
    return Field.from_global_data(domain, arr, sum_up)


def from_local_data(domain, arr):
Martin Reinecke's avatar
Martin Reinecke committed
312
313
314
315
316
317
318
319
320
321
322
323
    """Convenience function creating Fields/MultiFields from Numpy arrays or
    dicts of Numpy arrays.

    Parameters
    ----------
    domain : Domainoid
        the intended domain of the output field
    arr : Numpy array if `domain` corresponds to a `DomainTuple`,
          dictionary of Numpy arrays if `domain` corresponds to a `MultiDomain`

    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
324
325
    Field or MultiField
        The newly created field
Martin Reinecke's avatar
Martin Reinecke committed
326
    """
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
327
328
329
330
331
332
    if isinstance(domain, (dict, MultiDomain)):
        return MultiField.from_local_data(domain, arr)
    return Field.from_local_data(domain, arr)


def makeDomain(domain):
Martin Reinecke's avatar
Martin Reinecke committed
333
334
335
336
    """Convenience function creating DomainTuples/MultiDomains Domainoids.

    Parameters
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
337
    domain : Domainoid (can be DomainTuple, MultiDomain, dict, Domain or list of Domains)
Martin Reinecke's avatar
Martin Reinecke committed
338
339
340
341
        the description of the requested (multi-)domain

    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
342
343
    DomainTuple or MultiDomain
        The newly created domain object
Martin Reinecke's avatar
Martin Reinecke committed
344
    """
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
345
    if isinstance(domain, (MultiDomain, dict)):
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
346
347
        return MultiDomain.make(domain)
    return DomainTuple.make(domain)
348
349


350
def makeOp(input):
Martin Reinecke's avatar
Martin Reinecke committed
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
    """Converts a Field or MultiField to a diagonal operator.

    Parameters
    ----------
    input : None, Field or MultiField
        - if None, None is returned.
        - if Field, a DiagonalOperator with the coefficients given by this
            Field is returned.
        - if MultiField, a BlockDiagonalOperator with entries given by this
            MultiField is returned.

    Notes
    -----
    No volume factors are applied.
    """
Martin Reinecke's avatar
Martin Reinecke committed
366
367
    if input is None:
        return None
Martin Reinecke's avatar
Martin Reinecke committed
368
369
370
    if isinstance(input, Field):
        return DiagonalOperator(input)
    if isinstance(input, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
371
        return BlockDiagonalOperator(
Martin Reinecke's avatar
fix    
Martin Reinecke committed
372
            input.domain, {key: makeOp(val) for key, val in input.items()})
Martin Reinecke's avatar
Martin Reinecke committed
373
374
    raise NotImplementedError

Martin Reinecke's avatar
more    
Martin Reinecke committed
375
376

def domain_union(domains):
Martin Reinecke's avatar
Martin Reinecke committed
377
378
379
380
381
382
383
384
    """Computes the union of multiple DomainTuples/MultiDomains.

    Parameters
    ----------
    domains : list of DomainTuple or MultiDomain
        - if DomainTuple, all entries must be equal
        - if MultiDomain, there must not be any conflicting components
    """
Martin Reinecke's avatar
more    
Martin Reinecke committed
385
    if isinstance(domains[0], DomainTuple):
Martin Reinecke's avatar
Martin Reinecke committed
386
        if any(dom != domains[0] for dom in domains[1:]):
Martin Reinecke's avatar
more    
Martin Reinecke committed
387
388
389
390
            raise ValueError("domain mismatch")
        return domains[0]
    return MultiDomain.union(domains)

Martin Reinecke's avatar
more    
Martin Reinecke committed
391

392
393
# Arithmetic functions working on Fields

394

395
396
_current_module = sys.modules[__name__]

397
for f in ["sqrt", "exp", "log", "log10", "tanh", "sigmoid",
Jakob Knollmueller's avatar
Jakob Knollmueller committed
398
          "conjugate", 'sin', 'cos', 'tan', 'sinh', 'cosh',
399
          'absolute', 'one_over', 'sinc', 'log1p', 'expm1']:
400
    def func(f):
401
        def func2(x):
Martin Reinecke's avatar
Martin Reinecke committed
402
            from .linearization import Linearization
Martin Reinecke's avatar
Martin Reinecke committed
403
404
            from .operators.operator import Operator
            if isinstance(x, (Field, MultiField, Linearization, Operator)):
Martin Reinecke's avatar
Martin Reinecke committed
405
                return getattr(x, f)()
406
            else:
407
                return getattr(np, f)(x)
408
409
        return func2
    setattr(_current_module, f, func(f))
410

Martin Reinecke's avatar
Martin Reinecke committed
411
412
413
414
415

def clip(a, a_min=None, a_max=None):
    return a.clip(a_min, a_max)


416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
def get_default_codomain(domainoid, space=None):
    """For `RGSpace`, returns the harmonic partner domain.
    For `DomainTuple`, returns a copy of the object in which the domain
    indexed by `space` is substituted by its harmonic partner domain.
    In this case, if `space` is None, it is set to 0 if the `DomainTuple`
    contains exactly one domain.

    Parameters
    ----------
    domain: `RGSpace` or `DomainTuple`
        Domain for which to constuct the default harmonic partner
    space: int
        Optional index of the subdomain to be replaced by its default
        codomain. `domain[space]` must be of class `RGSpace`.
    """
    from .domains.rg_space import RGSpace
432
433
434
    from .domains.hp_space import HPSpace
    from .domains.gl_space import GLSpace
    from .domains.lm_space import LMSpace
435
436
437
438
439
440
    if isinstance(domainoid, RGSpace):
        return domainoid.get_default_codomain()
    if not isinstance(domainoid, DomainTuple):
        raise TypeError(
            'Works only on RGSpaces and DomainTuples containing those')
    space = utilities.infer_space(domainoid, space)
441
442
    if not isinstance(domainoid[space], (RGSpace, HPSpace, GLSpace, LMSpace)):
        raise TypeError("can only codomain structrued spaces")
443
444
445
    ret = [dom for dom in domainoid]
    ret[space] = domainoid[space].get_default_codomain()
    return DomainTuple.make(ret)
Lukas Platz's avatar
Lukas Platz committed
446
447
448
449
450
451
452
453
454
455
456


def single_plot(field, **kwargs):
    """Creates a single plot using `Plot`.
    Keyword arguments are passed to both `Plot.add` and `Plot.output`.
    """
    p = Plot()
    p.add(field, **kwargs)
    if 'title' in kwargs:
        del(kwargs['title'])
    p.output(**kwargs)
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505


def exec_time(obj, want_metric=True):
    """Times the execution time of an operator or an energy."""
    if isinstance(obj, Energy):
        t0 = time()
        obj.at(0.99*obj.position)
        print('Energy.at():', time() - t0)

        t0 = time()
        obj.value
        print('Energy.value:', time() - t0)
        t0 = time()
        obj.gradient
        print('Energy.gradient:', time() - t0)
        t0 = time()
        obj.metric
        print('Energy.metric:', time() - t0)

        t0 = time()
        obj.apply_metric(obj.position)
        print('Energy.apply_metric:', time() - t0)

        t0 = time()
        obj.metric(obj.position)
        print('Energy.metric(position):', time() - t0)
    elif isinstance(obj, Operator):
        want_metric = bool(want_metric)
        pos = from_random('normal', obj.domain)
        t0 = time()
        obj(pos)
        print('Operator call with field:', time() - t0)

        lin = Linearization.make_var(pos, want_metric=want_metric)
        t0 = time()
        res = obj(lin)
        print('Operator call with linearization:', time() - t0)

        if isinstance(obj, EnergyOperator):
            t0 = time()
            res.gradient
            print('Gradient evaluation:', time() - t0)

            if want_metric:
                t0 = time()
                res.metric(pos)
                print('Metric apply:', time() - t0)
    else:
        raise TypeError