rgrgtransformation.py 5.65 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
# NIFTy
# Copyright (C) 2017  Theo Steininger
#
# Author: Theo Steininger
#
# 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/>.

Jait Dixit's avatar
Jait Dixit committed
19 20
import numpy as np
from transformation import Transformation
Theo Steininger's avatar
Theo Steininger committed
21
from rg_transforms import FFTW, NUMPYFFT
Jait Dixit's avatar
Jait Dixit committed
22 23 24 25
from nifty import RGSpace, nifty_configuration


class RGRGTransformation(Transformation):
Jait Dixit's avatar
Jait Dixit committed
26
    def __init__(self, domain, codomain=None, module=None):
27 28
        super(RGRGTransformation, self).__init__(domain, codomain,
                                                 module=module)
Jait Dixit's avatar
Jait Dixit committed
29 30

        if module is None:
Theo Steininger's avatar
Theo Steininger committed
31
            if nifty_configuration['fft_module'] == 'fftw':
Jait Dixit's avatar
Jait Dixit committed
32
                self._transform = FFTW(self.domain, self.codomain)
Theo Steininger's avatar
Theo Steininger committed
33 34
            elif nifty_configuration['fft_module'] == 'numpy':
                self._transform = NUMPYFFT(self.domain, self.codomain)
Jait Dixit's avatar
Jait Dixit committed
35
            else:
Jait Dixit's avatar
Jait Dixit committed
36 37
                raise ValueError('ERROR: unknow default FFT module:' +
                                 nifty_configuration['fft_module'])
Jait Dixit's avatar
Jait Dixit committed
38
        else:
Theo Steininger's avatar
Theo Steininger committed
39
            if module == 'fftw':
Jait Dixit's avatar
Jait Dixit committed
40
                self._transform = FFTW(self.domain, self.codomain)
Theo Steininger's avatar
Theo Steininger committed
41 42
            elif module == 'numpy':
                self._transform = NUMPYFFT(self.domain, self.codomain)
Jait Dixit's avatar
Jait Dixit committed
43 44
            else:
                raise ValueError('ERROR: unknow FFT module:' + module)
Jait Dixit's avatar
Jait Dixit committed
45

46 47
    @classmethod
    def get_codomain(cls, domain, dtype=None, zerocenter=None):
Jait Dixit's avatar
Jait Dixit committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
        """
            Generates a compatible codomain to which transformations are
            reasonable, i.e.\  either a shifted grid or a Fourier conjugate
            grid.

            Parameters
            ----------
            domain: RGSpace
                Space for which a codomain is to be generated
            cozerocenter : {bool, numpy.ndarray}, *optional*
                Whether or not the grid is zerocentered for each axis or not
                (default: None).

            Returns
            -------
            codomain : nifty.rg_space
                A compatible codomain.
        """
        if not isinstance(domain, RGSpace):
            raise TypeError('ERROR: domain needs to be a RGSpace')

        # parse the cozerocenter input
70
        if zerocenter is None:
71
            zerocenter = domain.zerocenter
Jait Dixit's avatar
Jait Dixit committed
72 73
        # if the input is something scalar, cast it to a boolean
        else:
74
            temp = np.empty_like(domain.zerocenter)
75
            temp[:] = zerocenter
76
            zerocenter = temp
Jait Dixit's avatar
Jait Dixit committed
77 78

        # calculate the initialization parameters
79 80
        distances = 1 / (np.array(domain.shape) *
                         np.array(domain.distances))
81
        if dtype is None:
82 83 84
            # create a definitely complex dtype from the dtype of domain
            one = domain.dtype.type(1)
            dtype = np.dtype(type(one + 1j))
Jait Dixit's avatar
Jait Dixit committed
85

86
        new_space = RGSpace(domain.shape,
87 88 89 90
                            zerocenter=zerocenter,
                            distances=distances,
                            harmonic=(not domain.harmonic),
                            dtype=dtype)
91
        cls.check_codomain(domain, new_space)
Jait Dixit's avatar
Jait Dixit committed
92 93
        return new_space

94 95
    @classmethod
    def check_codomain(cls, domain, codomain):
Jait Dixit's avatar
Jait Dixit committed
96
        if not isinstance(domain, RGSpace):
97
            raise TypeError('ERROR: domain is not a RGSpace')
Jait Dixit's avatar
Jait Dixit committed
98 99 100 101 102

        if codomain is None:
            return False

        if not isinstance(codomain, RGSpace):
103
            return False
Jait Dixit's avatar
Jait Dixit committed
104

105 106
        if not np.all(np.array(domain.shape) ==
                      np.array(codomain.shape)):
Jait Dixit's avatar
Jait Dixit committed
107 108 109 110 111
            return False

        if domain.harmonic == codomain.harmonic:
            return False

112 113
        if codomain.harmonic and not issubclass(codomain.dtype.type,
                                                np.complexfloating):
114
            cls.logger.warn("Codomain is harmonic but dtype is real.")
115

Jait Dixit's avatar
Jait Dixit committed
116 117
        # Check if the distances match, i.e. dist' = 1 / (num * dist)
        if not np.all(
118 119 120
            np.absolute(np.array(domain.shape) *
                        np.array(domain.distances) *
                        np.array(codomain.distances) - 1) <
121
                10**-7):
Jait Dixit's avatar
Jait Dixit committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
            return False

        return True

    def transform(self, val, axes=None, **kwargs):
        """
        RG -> RG transform method.

        Parameters
        ----------
        val : np.ndarray or distributed_data_object
            The value array which is to be transformed

        axes : None or tuple
            The axes along which the transformation should take place

        """
        if self._transform.codomain.harmonic:
140 141 142 143 144
            # correct for forward 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.
Jait Dixit's avatar
Jait Dixit committed
145
            val = self._transform.domain.weight(val, power=1, axes=axes)
Jait Dixit's avatar
Jait Dixit committed
146 147 148 149 150

        # Perform the transformation
        Tval = self._transform.transform(val, axes, **kwargs)

        if not self._transform.codomain.harmonic:
151 152
            # correct for inverse fft.
            # See discussion above.
Jait Dixit's avatar
Jait Dixit committed
153
            Tval = self._transform.codomain.weight(Tval, power=-1, axes=axes)
Jait Dixit's avatar
Jait Dixit committed
154 155

        return Tval