sugar.py 2.24 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
15
16
17
#
# Copyright(C) 2013-2017 Max-Planck-Society
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.
18
19
20

from nifty import PowerSpace,\
                  Field,\
21
                  DiagonalOperator
22
23
24
25

__all__ = ['create_power_operator']


26
27
def create_power_operator(domain, power_spectrum, dtype=None,
                          distribution_strategy='not'):
Theo Steininger's avatar
Theo Steininger committed
28
29
    """ Creates a diagonal operator with the given power spectrum.

30
    Constructs a diagonal operator that lives over the specified domain.
Theo Steininger's avatar
Theo Steininger committed
31

32
33
34
    Parameters
    ----------
    domain : DomainObject
35
        Domain over which the power operator shall live.
Theo Steininger's avatar
Theo Steininger committed
36
    power_spectrum : (array-like, method)
37
38
        An array-like object, or a method that implements the square root
        of a power spectrum as a function of k.
Theo Steininger's avatar
Theo Steininger committed
39
    dtype : type *optional*
40
        dtype that the field holding the power spectrum shall use
Theo Steininger's avatar
Theo Steininger committed
41
42
43
        (default : None).
        if dtype == None: the dtype of `power_spectrum` will be used.
    distribution_strategy : string *optional*
44
        Distributed strategy to be used by the underlying d2o objects.
Theo Steininger's avatar
Theo Steininger committed
45
46
        (default : 'not')

47
48
    Returns
    -------
Theo Steininger's avatar
Theo Steininger committed
49
50
    DiagonalOperator : An operator that implements the given power spectrum.

51
    """
52

53
54
    power_domain = PowerSpace(domain,
                              distribution_strategy=distribution_strategy)
55
    fp = Field(power_domain, val=power_spectrum, dtype=dtype,
56
               distribution_strategy=distribution_strategy)
57
    f = fp.power_synthesize(mean=1, std=0, real_signal=False)
58

59
    return DiagonalOperator(domain, diagonal=f, bare=True)