sugar.py 14.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
#
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

20
import numpy as np
21 22 23

from . import dobj, utilities
from .domain_tuple import DomainTuple
Martin Reinecke's avatar
Martin Reinecke committed
24
from .domains.power_space import PowerSpace
Martin Reinecke's avatar
cleanup  
Martin Reinecke committed
25
from .field import Field
26
from .logger import logger
Martin Reinecke's avatar
Martin Reinecke committed
27 28
from .multi_domain import MultiDomain
from .multi_field import MultiField
Philipp Arras's avatar
Philipp Arras committed
29
from .operators.block_diagonal_operator import BlockDiagonalOperator
Martin Reinecke's avatar
Martin Reinecke committed
30
from .operators.diagonal_operator import DiagonalOperator
Martin Reinecke's avatar
cleanup  
Martin Reinecke committed
31
from .operators.distributors import PowerDistributor
32

Martin Reinecke's avatar
step 1  
Martin Reinecke committed
33 34
__all__ = ['PS_field', 'power_analyze', 'create_power_operator',
           'create_harmonic_smoothing_operator', 'from_random',
35
           'full', 'from_global_data', 'from_local_data',
Jakob Knollmueller's avatar
Jakob Knollmueller committed
36 37
           'makeDomain', 'sqrt', 'exp', 'log', 'tanh', 'sigmoid',
           'sin', 'cos', 'tan', 'sinh', 'cosh',
Martin Reinecke's avatar
Martin Reinecke committed
38
           'absolute', 'one_over', 'clip', 'sinc',
39 40
           'conjugate', 'get_signal_variance', 'makeOp', 'domain_union',
           'get_default_codomain']
41

42

43
def PS_field(pspace, func):
Martin Reinecke's avatar
Martin Reinecke committed
44 45 46 47 48 49 50 51
    """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
52

Martin Reinecke's avatar
Martin Reinecke committed
53 54
    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
55 56
    Field
        A field defined on (pspace,) containing the computed function values
Martin Reinecke's avatar
Martin Reinecke committed
57
    """
Martin Reinecke's avatar
Martin Reinecke committed
58 59 60
    if not isinstance(pspace, PowerSpace):
        raise TypeError
    data = dobj.from_global_data(func(pspace.k_lengths))
61
    return Field(DomainTuple.make(pspace), data)
Martin Reinecke's avatar
Martin Reinecke committed
62

Martin Reinecke's avatar
Martin Reinecke committed
63

64 65 66 67 68 69 70 71 72 73 74 75 76
def get_signal_variance(spec, space):
    """
    Computes how much a field with a given power spectrum will vary in space

    This is a small helper function that computes how the expected variance
    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
77 78 79 80
        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
81 82 83 84
    """
    if space.harmonic:
        space = PowerSpace(space)
    if not isinstance(space, PowerSpace):
Martin Reinecke's avatar
Martin Reinecke committed
85 86
        raise ValueError(
            "space must be either a harmonic space or Power space.")
87 88 89 90 91
    field = PS_field(space, spec)
    dist = PowerDistributor(space.harmonic_partner, space)
    k_field = dist(field)
    return k_field.weight(2).sum()

92

93 94
def _single_power_analyze(field, idx, binbounds):
    power_domain = PowerSpace(field.domain[idx], binbounds)
Martin Reinecke's avatar
Martin Reinecke committed
95 96
    pd = PowerDistributor(field.domain, power_domain, idx)
    return pd.adjoint_times(field.weight(1)).weight(-1)  # divides by bin size
97 98


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

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

    Parameters
    ----------
    field : Field
        The field to be analyzed
Martin Reinecke's avatar
Martin Reinecke committed
115 116 117
    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
118
        If None, all subdomains will be converted.
119
        (default : None).
Martin Reinecke's avatar
Martin Reinecke committed
120
    binbounds : None or array-like, optional
121
        Inner bounds of the bins (default : None).
Martin Reinecke's avatar
Martin Reinecke committed
122 123
        if binbounds is None : bins are inferred.
    keep_phase_information : bool, optional
124 125 126 127 128 129 130 131 132 133 134 135
        If False, return a real-valued result containing the power spectrum
        of the input Field.
        If True, return a complex-valued result whose real component
        contains the power spectrum computed from the real part of the
        input Field, and whose imaginary component contains the power
        spectrum computed from the imaginary part of the input Field.
        The absolute value of this result should be identical to the output
        of power_analyze with keep_phase_information=False.
        (default : False).

    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
136
    Field
137
        The output object. Its domain is a PowerSpace and it contains
Martin Reinecke's avatar
Martin Reinecke committed
138
        the power spectrum of `field`.
139 140 141 142
    """

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

146
    spaces = utilities.parse_spaces(spaces, len(field.domain))
147 148 149 150

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

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

155 156 157
    if keep_phase_information:
        parts = [field.real*field.real, field.imag*field.imag]
    else:
158 159 160 161
        if field_real:
            parts = [field**2]
        else:
            parts = [field.real*field.real + field.imag*field.imag]
162 163

    for space_index in spaces:
Martin Reinecke's avatar
Martin Reinecke committed
164
        parts = [_single_power_analyze(part, space_index, binbounds)
165 166 167 168 169
                 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
170
def _create_power_field(domain, power_spectrum):
Philipp Arras's avatar
Philipp Arras committed
171
    if not callable(power_spectrum):  # we have a Field defined on a PowerSpace
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
172 173 174 175 176 177 178
        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]
179
        fp = power_spectrum
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
180 181
    else:
        power_domain = PowerSpace(domain)
182
        fp = PS_field(power_domain, power_spectrum)
183

Martin Reinecke's avatar
Martin Reinecke committed
184
    return PowerDistributor(domain, power_domain)(fp)
185

186

187
def create_power_operator(domain, power_spectrum, space=None):
188
    """Creates a diagonal operator with the given power spectrum.
189

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

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

201 202
    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
203 204
    DiagonalOperator
        An operator that implements the given power spectrum.
205
    """
Martin Reinecke's avatar
Martin Reinecke committed
206
    domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
207
    space = utilities.infer_space(domain, space)
Martin Reinecke's avatar
Martin Reinecke committed
208 209
    field = _create_power_field(domain[space], power_spectrum)
    return DiagonalOperator(field, domain, space)
210

211

212
def create_harmonic_smoothing_operator(domain, space, sigma):
Martin Reinecke's avatar
Martin Reinecke committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    """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
    """
230 231 232
    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
233 234 235


def full(domain, val):
Martin Reinecke's avatar
Martin Reinecke committed
236 237 238 239 240 241 242 243 244 245 246
    """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
247 248
    Field or MultiField
        The newly created uniform field
Martin Reinecke's avatar
Martin Reinecke committed
249
    """
Martin Reinecke's avatar
step 1  
Martin Reinecke committed
250 251 252 253 254 255
    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
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
    """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
271 272
    Field or MultiField
        The newly created random field
Martin Reinecke's avatar
Martin Reinecke committed
273
    """
Martin Reinecke's avatar
step 1  
Martin Reinecke committed
274 275 276 277 278 279
    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
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
    """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
297 298
    Field or MultiField
        The newly created random field
Martin Reinecke's avatar
Martin Reinecke committed
299
    """
Martin Reinecke's avatar
step 1  
Martin Reinecke committed
300 301 302 303 304 305
    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
306 307 308 309 310 311 312 313 314 315 316 317
    """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
318 319
    Field or MultiField
        The newly created field
Martin Reinecke's avatar
Martin Reinecke committed
320
    """
Martin Reinecke's avatar
step 1  
Martin Reinecke committed
321 322 323 324 325 326
    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
327 328 329 330
    """Convenience function creating DomainTuples/MultiDomains Domainoids.

    Parameters
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
331
    domain : Domainoid (can be DomainTuple, MultiDomain, dict, Domain or list of Domains)
Martin Reinecke's avatar
Martin Reinecke committed
332 333 334 335
        the description of the requested (multi-)domain

    Returns
    -------
Martin Reinecke's avatar
Martin Reinecke committed
336 337
    DomainTuple or MultiDomain
        The newly created domain object
Martin Reinecke's avatar
Martin Reinecke committed
338
    """
Martin Reinecke's avatar
fixes  
Martin Reinecke committed
339
    if isinstance(domain, (MultiDomain, dict)):
Martin Reinecke's avatar
step 1  
Martin Reinecke committed
340 341
        return MultiDomain.make(domain)
    return DomainTuple.make(domain)
342 343


344
def makeOp(input):
Martin Reinecke's avatar
Martin Reinecke committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
    """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
360 361
    if input is None:
        return None
Martin Reinecke's avatar
Martin Reinecke committed
362 363 364
    if isinstance(input, Field):
        return DiagonalOperator(input)
    if isinstance(input, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
365
        return BlockDiagonalOperator(
Martin Reinecke's avatar
Martin Reinecke committed
366
            input.domain, tuple(makeOp(val) for val in input.values()))
Martin Reinecke's avatar
Martin Reinecke committed
367 368
    raise NotImplementedError

Martin Reinecke's avatar
more  
Martin Reinecke committed
369 370

def domain_union(domains):
Martin Reinecke's avatar
Martin Reinecke committed
371 372 373 374 375 376 377 378
    """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
379
    if isinstance(domains[0], DomainTuple):
Martin Reinecke's avatar
Martin Reinecke committed
380
        if any(dom != domains[0] for dom in domains[1:]):
Martin Reinecke's avatar
more  
Martin Reinecke committed
381 382 383 384
            raise ValueError("domain mismatch")
        return domains[0]
    return MultiDomain.union(domains)

Martin Reinecke's avatar
more  
Martin Reinecke committed
385

386 387
# Arithmetic functions working on Fields

388

389 390
_current_module = sys.modules[__name__]

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

Martin Reinecke's avatar
Martin Reinecke committed
405 406 407 408 409

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


410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
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
    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)
    if not isinstance(domainoid[space], RGSpace):
        raise TypeError("can only codomain RGSpaces")
    ret = [dom for dom in domainoid]
    ret[space] = domainoid[space].get_default_codomain()
    return DomainTuple.make(ret)