lm_space.py 4.28 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

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
Theo Steininger's avatar
Theo Steininger 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
29
    """NIFTy subclass for sets of spherical harmonic coefficients.

    Its harmonic partner spaces are :class:`HPSpace` and :class:`GLSpace`.
Martin Reinecke's avatar
Martin Reinecke committed
30
31
32
33

    Parameters
    ----------
    lmax : int
Martin Reinecke's avatar
Martin Reinecke committed
34
35
36
37
38
39
40
41
42
        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
43
44
    """

45
    def __init__(self, lmax, mmax=None):
Martin Reinecke's avatar
Martin Reinecke committed
46
        super(LMSpace, self).__init__()
47
48
49
50
51
52
53
54
55
        self._needed_for_hash += ["_lmax", "_mmax"]
        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
56

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

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

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

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

76
    def scalar_dvol(self):
77
        return 1.
csongor's avatar
csongor committed
78

79
    def get_k_length_array(self):
80
81
        lmax = self._lmax
        mmax = self._mmax
Martin Reinecke's avatar
Martin Reinecke committed
82
        ldist = np.empty((self.size,), dtype=np.float64)
Martin Reinecke's avatar
stage1    
Martin Reinecke committed
83
84
85
86
87
        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
88
89
90
        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
91
        return Field((self,), dobj.from_global_data(ldist))
92

93
    def get_unique_k_lengths(self):
Martin Reinecke's avatar
Martin Reinecke committed
94
95
        return np.arange(self.lmax+1, dtype=np.float64)

Martin Reinecke's avatar
Martin Reinecke committed
96
97
    @staticmethod
    def _kernel(x, sigma):
98
99
100
        # 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
101
102
103
        res = x+1.
        res *= x
        res *= -0.5*sigma*sigma
104
        exp(res, out=res)
Martin Reinecke's avatar
Martin Reinecke committed
105
106
        return res

107
    def get_fft_smoothing_kernel_function(self, sigma):
Martin Reinecke's avatar
Martin Reinecke committed
108
        return lambda x: self._kernel(x, sigma)
109

csongor's avatar
csongor committed
110
111
    @property
    def lmax(self):
Martin Reinecke's avatar
Martin Reinecke committed
112
        """ Returns the maximum :math:`l` value of any spherical harmonic
Martin Reinecke's avatar
Martin Reinecke committed
113
        coefficient :math:`a_{lm}` that is represented in this Space.
114
        """
csongor's avatar
csongor committed
115
116
117
118
        return self._lmax

    @property
    def mmax(self):
Martin Reinecke's avatar
Martin Reinecke committed
119
        """ Returns the maximum :math:`m` value of any spherical harmonic
Martin Reinecke's avatar
Martin Reinecke committed
120
        coefficient :math:`a_{lm}` that is represented in this Space.
121
        """
122
        return self._mmax
Martin Reinecke's avatar
Martin Reinecke committed
123
124
125
126
127
128
129
130

    def get_default_codomain(self):
        from .. import GLSpace
        return GLSpace(self.lmax+1, self.mmax*2+1)

    def check_codomain(self, codomain):
        from .. import GLSpace, HPSpace
        if not isinstance(codomain, (GLSpace, HPSpace)):
131
            raise TypeError("codomain must be a GLSpace or HPSpace.")