fft_operator_support.py

# 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/>.
#
# 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.

from __future__ import division
import numpy as np
from .. import nifty_utilities as utilities
from ..low_level_library import hartley
from .. import dobj
from ..field import Field
from ..spaces.gl_space import GLSpace


class Transformation(object):
    def __init__(self, pdom, hdom, space):
        self.pdom = pdom
        self.hdom = hdom
        self.space = space


class RGRGTransformation(Transformation):
    def __init__(self, pdom, hdom, space):
        import pyfftw
        super(RGRGTransformation, self).__init__(pdom, hdom, space)
        pyfftw.interfaces.cache.enable()
        # correct for forward/inverse fft.
        # naively one would set power to 0.5 here in order to
        # apply effectively a factor of 1/sqrt(N) to the field.
        # BUT: the pixel volumes of the domain and codomain are different.
        # Hence, in order to produce the same scalar product, power==1.
        self.fct_p2h = pdom[space].scalar_dvol()
        self.fct_h2p = 1./(pdom[space].scalar_dvol()*hdom[space].dim)

    @property
    def unitary(self):
        return True

    def transform(self, x):
        """
        RG -> RG transform method.

        Parameters
        ----------
        x : Field
            The field to be transformed
        """
        axes = x.domain.axes[self.space]
        p2h = x.domain == self.pdom
        tdom = self.hdom if p2h else self.pdom
        if dobj.distaxis(x.val) in axes:
            tmpax = (dobj.distaxis(x.val),)
            tmp = dobj.redistribute(x.val, nodist=tmpax)
            ldat = dobj.local_data(tmp)
            tmp = dobj.from_local_data(tmp.shape,hartley(ldat,tmpax),distaxis=dobj.distaxis(tmp))
            tmp = dobj.redistribute(tmp, dist=tmpax[0])
            tmpax = tuple (i for i in axes if i not in tmpax)
            if len(tmpax) > 0:
                ldat = dobj.local_data(tmp)
                tmp = dobj.from_local_data(tmp.shape,hartley(ldat,tmpax),distaxis=dobj.distaxis(tmp))
            Tval = Field(tdom, tmp)
        else:
            ldat = dobj.local_data(x.val)
            tmp = dobj.from_local_data(x.val.shape,hartley(ldat,axes),distaxis=dobj.distaxis(x.val))
            Tval = Field(tdom,tmp)
        fct = self.fct_p2h if p2h else self.fct_h2p
        if fct != 1:
            Tval *= fct

        return Tval


class SphericalTransformation(Transformation):
    def __init__(self, pdom, hdom, space):
        super(SphericalTransformation, self).__init__(pdom, hdom, space)
        from pyHealpix import sharpjob_d

        self.lmax = self.hdom[self.space].lmax
        self.mmax = self.hdom[self.space].mmax
        self.sjob = sharpjob_d()
        self.sjob.set_triangular_alm_info(self.lmax, self.mmax)
        if isinstance(self.pdom[self.space], GLSpace):
            self.sjob.set_Gauss_geometry(self.pdom[self.space].nlat,
                                         self.pdom[self.space].nlon)
        else:
            self.sjob.set_Healpix_geometry(self.pdom[self.space].nside)

    @property
    def unitary(self):
        return False

    def _slice_p2h(self, inp):
        rr = self.sjob.map2alm(inp)
        assert len(rr) == ((self.mmax+1)*(self.mmax+2))//2 + \
                          (self.mmax+1)*(self.lmax-self.mmax)
        res = np.empty(2*len(rr)-self.lmax-1, dtype=rr[0].real.dtype)
        res[0:self.lmax+1] = rr[0:self.lmax+1].real
        res[self.lmax+1::2] = np.sqrt(2)*rr[self.lmax+1:].real
        res[self.lmax+2::2] = np.sqrt(2)*rr[self.lmax+1:].imag
        return res

    def _slice_h2p(self, inp):
        res = np.empty((len(inp)+self.lmax+1)//2, dtype=(inp[0]*1j).dtype)
        assert len(res) == ((self.mmax+1)*(self.mmax+2))//2 + \
                           (self.mmax+1)*(self.lmax-self.mmax)
        res[0:self.lmax+1] = inp[0:self.lmax+1]
        res[self.lmax+1:] = np.sqrt(0.5)*(inp[self.lmax+1::2] +
                                          1j*inp[self.lmax+2::2])
        return self.sjob.alm2map(res)

    def transform(self, x):
        axes = x.domain.axes[self.space]
        axis = axes[0]
        tval = x.val
        if dobj.distaxis(tval) == axis:
            tval = dobj.redistribute(tval, nodist=(axis,))
        distaxis = dobj.distaxis(tval)

        p2h = x.domain == self.pdom
        idat = dobj.local_data(tval)
        if p2h:
            odat = np.empty(dobj.local_shape(self.hdom.shape, distaxis=distaxis), dtype=x.dtype)

            for slice in utilities.get_slice_list(idat.shape, axes):
                odat[slice] = self._slice_p2h(idat[slice])
            odat = dobj.from_local_data(self.hdom.shape, odat, distaxis)
            if distaxis!= dobj.distaxis(x.val):
                odat = dobj.redistribute(odat, dist=dobj.distaxis(x.val))
            return Field(self.hdom, odat)
        else:
            odat = np.empty(dobj.local_shape(self.pdom.shape, distaxis=distaxis), dtype=x.dtype)
            for slice in utilities.get_slice_list(idat.shape, axes):
                odat[slice] = self._slice_h2p(idat[slice])
            odat = dobj.from_local_data(self.pdom.shape, odat, distaxis)
            if distaxis!= dobj.distaxis(x.val):
                odat = dobj.redistribute(odat, dist=dobj.distaxis(x.val))
            return Field(self.pdom, odat)