hp_space.py 3.95 KB
Newer Older
1
2
# NIFTy
# Copyright (C) 2017  Theo Steininger
csongor's avatar
csongor committed
3
#
4
# Author: Theo Steininger
csongor's avatar
csongor committed
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
13
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
csongor's avatar
csongor committed
15
16
#
# You should have received a copy of the GNU General Public License
17
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
csongor's avatar
csongor committed
18
19

import numpy as np
20

21
from nifty.spaces.space import Space
22

Theo Steininger's avatar
Theo Steininger committed
23

Theo Steininger's avatar
Theo Steininger committed
24
class HPSpace(Space):
csongor's avatar
csongor committed
25
26
27
28
29
30
31
32
33
34
    """
        ..        __
        ..      /  /
        ..     /  /___    ______
        ..    /   _   | /   _   |
        ..   /  / /  / /  /_/  /
        ..  /__/ /__/ /   ____/  space class
        ..           /__/

        NIFTY subclass for HEALPix discretizations of the two-sphere [#]_.
35
36
      
        Attributes
csongor's avatar
csongor committed
37
        ----------
38
39
40
41
42
43
44
45
46
47
48
        dim : np.int
            Total number of dimensionality, i.e. the number of pixels.
        harmonic : bool
            Specifies whether the space is a signal or harmonic space.
        nside : int
            The corresponding HEALPix pixelization. The total number of pixels 
            is 12*nside**2.
        total_volume : np.float
            The total volume of the space.
        shape : tuple of np.ints
            The shape of the space's data array.
csongor's avatar
csongor committed
49

Theo Steininger's avatar
Theo Steininger committed
50
51
52
53
54
        Raises
        ------
        ValueError
            If given `nside` < 1.

csongor's avatar
csongor committed
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
        See Also
        --------
        gl_space : A class for the Gauss-Legendre discretization of the
            sphere [#]_.
        lm_space : A class for spherical harmonic components.

        References
        ----------
        .. [#] K.M. Gorski et al., 2005, "HEALPix: A Framework for
               High-Resolution Discretization and Fast Analysis of Data
               Distributed on the Sphere", *ApJ* 622..759G.
        .. [#] M. Reinecke and D. Sverre Seljebotn, 2013, "Libsharp - spherical
               harmonic transforms revisited";
               `arXiv:1303.4945 <http://www.arxiv.org/abs/1303.4945>`_

    """

72
73
    # ---Overwritten properties and methods---

Martin Reinecke's avatar
Martin Reinecke committed
74
75
    def __init__(self, nside):
        super(HPSpace, self).__init__()
csongor's avatar
csongor committed
76

77
        self._nside = self._parse_nside(nside)
csongor's avatar
csongor committed
78

79
80
81
82
83
    # ---Mandatory properties and methods---

    @property
    def harmonic(self):
        return False
csongor's avatar
csongor committed
84
85
86

    @property
    def shape(self):
87
        return (np.int(12 * self.nside ** 2),)
csongor's avatar
csongor committed
88
89

    @property
Jait Dixit's avatar
Jait Dixit committed
90
    def dim(self):
91
        return np.int(12 * self.nside ** 2)
csongor's avatar
csongor committed
92

93
94
95
    @property
    def total_volume(self):
        return 4 * np.pi
96

97
    def copy(self):
Martin Reinecke's avatar
Martin Reinecke committed
98
        return self.__class__(nside=self.nside)
99

100
    def weight(self, x, power=1, axes=None, inplace=False):
101

Jait Dixit's avatar
Jait Dixit committed
102
        weight = ((4 * np.pi) / (12 * self.nside**2))**power
103
104
105
106
107
108
109
110

        if inplace:
            x *= weight
            result_x = x
        else:
            result_x = x * weight

        return result_x
111

112
    def get_distance_array(self, distribution_strategy):
Theo Steininger's avatar
Theo Steininger committed
113
        raise NotImplementedError
theos's avatar
theos committed
114

115
    def get_fft_smoothing_kernel_function(self, sigma):
Theo Steininger's avatar
Theo Steininger committed
116
        raise NotImplementedError
theos's avatar
theos committed
117

118
119
120
121
    # ---Added properties and methods---

    @property
    def nside(self):
Theo Steininger's avatar
Theo Steininger committed
122
123
        """ Returns the nside of the corresponding HEALPix pixelization.
        The total number of pixels is 12*nside**2
124
        """
125
126
127
128
        return self._nside

    def _parse_nside(self, nside):
        nside = int(nside)
129
130
        if nside < 1:
            raise ValueError("nside must be >=1.")
131
        return nside
132
133
134
135

    # ---Serialization---

    def _to_hdf5(self, hdf5_group):
Jait Dixit's avatar
Jait Dixit committed
136
        hdf5_group['nside'] = self.nside
137
138
139
        return None

    @classmethod
Theo Steininger's avatar
Theo Steininger committed
140
    def _from_hdf5(cls, hdf5_group, repository):
141
        result = cls(
Jait Dixit's avatar
Jait Dixit committed
142
143
            nside=hdf5_group['nside'][()],
            )
144
        return result