lm_space.py 4.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
20
from __future__ import division
import numpy as np
Martin Reinecke's avatar
Martin Reinecke committed
21
from .structured_domain import StructuredDomain
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
22
from ..field import Field, exp
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
23
from .. import dobj
theos's avatar
theos committed
24

csongor's avatar
csongor committed
25

Martin Reinecke's avatar
Martin Reinecke committed
26
class LMSpace(StructuredDomain):
Martin Reinecke's avatar
Martin Reinecke committed
27
28
    """NIFTy subclass for sets of spherical harmonic coefficients.

Martin Reinecke's avatar
Martin Reinecke committed
29
30
    Its harmonic partner spaces are :class:`~nifty4.domains.hp_space.HPSpace`
    and :class:`~nifty4.domains.gl_space.GLSpace`.
Martin Reinecke's avatar
Martin Reinecke committed
31
32
33
34

    Parameters
    ----------
    lmax : int
Martin Reinecke's avatar
Martin Reinecke committed
35
36
37
38
39
40
41
42
43
        The maximum :math:`l` value of any spherical harmonic coefficient
        :math:`a_{lm}` that is represented by this object.
        Must be :math:`\ge 0`.

    mmax : int, optional
        The maximum :math:`m` value of any spherical harmonic coefficient
        :math:`a_{lm}` that is represented by this object.
        If not supplied, it is set to `lmax`.
        Must be :math:`\ge 0` and :math:`\le` `lmax`.
csongor's avatar
csongor committed
44
45
    """

Martin Reinecke's avatar
Martin Reinecke committed
46
47
    _needed_for_hash = ["_lmax", "_mmax"]

48
    def __init__(self, lmax, mmax=None):
Martin Reinecke's avatar
Martin Reinecke committed
49
        super(LMSpace, self).__init__()
50
51
52
53
54
55
56
57
        self._lmax = np.int(lmax)
        if self._lmax < 0:
            raise ValueError("lmax must be >=0.")
        if mmax is None:
            mmax = self._lmax
        self._mmax = np.int(mmax)
        if self._mmax < 0 or self._mmax > self._lmax:
            raise ValueError("mmax must be >=0 and <=lmax.")
csongor's avatar
csongor committed
58

59
    def __repr__(self):
60
        return ("LMSpace(lmax=%r, mmax=%r)" % (self.lmax, self.mmax))
61

csongor's avatar
csongor committed
62
63
64
    @property
    def harmonic(self):
        return True
csongor's avatar
csongor committed
65
66

    @property
67
    def shape(self):
Martin Reinecke's avatar
Martin Reinecke committed
68
        return (self.size, )
csongor's avatar
csongor committed
69
70

    @property
Martin Reinecke's avatar
Martin Reinecke committed
71
    def size(self):
72
73
        l = self._lmax
        m = self._mmax
74
        # the LMSpace consists of the full triangle (including -m's!),
theos's avatar
theos committed
75
        # minus two little triangles if mmax < lmax
76
        return (l+1)**2 - (l-m)*(l-m+1)
csongor's avatar
csongor committed
77

Martin Reinecke's avatar
Martin Reinecke committed
78
    @property
79
    def scalar_dvol(self):
80
        return 1.
csongor's avatar
csongor committed
81

82
    def get_k_length_array(self):
83
84
        lmax = self._lmax
        mmax = self._mmax
Martin Reinecke's avatar
Martin Reinecke committed
85
        ldist = np.empty((self.size,), dtype=np.float64)
Martin Reinecke's avatar
stage1    
Martin Reinecke committed
86
87
88
89
90
        ldist[0:lmax+1] = np.arange(lmax+1, dtype=np.float64)
        tmp = np.empty((2*lmax+2), dtype=np.float64)
        tmp[0::2] = np.arange(lmax+1)
        tmp[1::2] = np.arange(lmax+1)
        idx = lmax+1
91
92
93
        for m in range(1, mmax+1):
            ldist[idx:idx+2*(lmax+1-m)] = tmp[2*m:]
            idx += 2*(lmax+1-m)
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
94
        return Field((self,), dobj.from_global_data(ldist))
95

96
    def get_unique_k_lengths(self):
Martin Reinecke's avatar
Martin Reinecke committed
97
98
        return np.arange(self.lmax+1, dtype=np.float64)

Martin Reinecke's avatar
Martin Reinecke committed
99
100
    @staticmethod
    def _kernel(x, sigma):
101
102
103
        # cf. "All-sky convolution for polarimetry experiments"
        # by Challinor et al.
        # http://arxiv.org/abs/astro-ph/0008228
Martin Reinecke's avatar
Martin Reinecke committed
104
105
106
        res = x+1.
        res *= x
        res *= -0.5*sigma*sigma
107
        exp(res, out=res)
Martin Reinecke's avatar
Martin Reinecke committed
108
109
        return res

110
    def get_fft_smoothing_kernel_function(self, sigma):
Martin Reinecke's avatar
Martin Reinecke committed
111
        return lambda x: self._kernel(x, sigma)
112

csongor's avatar
csongor committed
113
114
    @property
    def lmax(self):
Martin Reinecke's avatar
Martin Reinecke committed
115
116
117
118
        """int : maximum allowed :math:`l`

        The maximum :math:`l` value of any spherical harmonic
        coefficient :math:`a_{lm}` that is represented in this domain.
119
        """
csongor's avatar
csongor committed
120
121
122
123
        return self._lmax

    @property
    def mmax(self):
Martin Reinecke's avatar
Martin Reinecke committed
124
125
126
127
        """int : maximum allowed :math:`m`

        The maximum :math:`m` value of any spherical harmonic
        coefficient :math:`a_{lm}` that is represented in this domain.
128
        """
129
        return self._mmax
Martin Reinecke's avatar
Martin Reinecke committed
130
131

    def get_default_codomain(self):
Martin Reinecke's avatar
Martin Reinecke committed
132
133
134
135
136
137
138
        """Returns a :class:`~nifty4.domains.gl_space.GLSpace` object, which is
        capable of storing an accurate representation of data residing on
        `self`.

        Returns
        -------
        GLSpace
Martin Reinecke's avatar
Martin Reinecke committed
139
            The partner domain
Martin Reinecke's avatar
Martin Reinecke committed
140
        """
Martin Reinecke's avatar
Martin Reinecke committed
141
142
143
144
        from .. import GLSpace
        return GLSpace(self.lmax+1, self.mmax*2+1)

    def check_codomain(self, codomain):
Martin Reinecke's avatar
Martin Reinecke committed
145
146
147
148
149
150
151
152
        """Raises `TypeError` if `codomain` is not a matching partner domain
        for `self`.

        Notes
        -----
        This function only checks whether `codomain` is of type
        :class:`GLSpace` or :class:`HPSpace`.
        """
Martin Reinecke's avatar
Martin Reinecke committed
153
154
        from .. import GLSpace, HPSpace
        if not isinstance(codomain, (GLSpace, HPSpace)):
155
            raise TypeError("codomain must be a GLSpace or HPSpace.")