# 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-2018 Max-Planck-Society
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

import nifty5 as ift
import numpy as np


def make_chess_mask(position_space):
    mask = np.ones(position_space.shape)
    for i in range(4):
        for j in range(4):
            if (i+j) % 2 == 0:
                mask[i*128//4:(i+1)*128//4, j*128//4:(j+1)*128//4] = 0
    return mask


def make_random_mask():
    mask = ift.from_random('pm1', position_space)
    mask = (mask+1)/2
    return mask.to_global_data()


def mask_to_nan(mask, field):
    masked_data = field.local_data.copy()
    masked_data[mask.local_data == 0] = np.nan
    return ift.from_local_data(field.domain, masked_data)


if __name__ == '__main__':
    np.random.seed(42)
    # FIXME description of the tutorial

    # Choose problem geometry and masking
    mode = 1
    if mode == 0:
        # One dimensional regular grid
        position_space = ift.RGSpace([1024])
        mask = np.ones(position_space.shape)
    elif mode == 1:
        # Two dimensional regular grid with chess mask
        position_space = ift.RGSpace([128, 128])
        mask = make_chess_mask(position_space)
    else:
        # Sphere with half of its locations randomly masked
        position_space = ift.HPSpace(128)
        mask = make_random_mask()

    harmonic_space = position_space.get_default_codomain()
    HT = ift.HarmonicTransformOperator(harmonic_space, target=position_space)

    # Set correlation structure with a power spectrum and build
    # prior correlation covariance
    def power_spectrum(k):
        return 100. / (20.+k**3)
    power_space = ift.PowerSpace(harmonic_space)
    PD = ift.PowerDistributor(harmonic_space, power_space)
    prior_correlation_structure = PD(ift.PS_field(power_space, power_spectrum))

    S = ift.DiagonalOperator(prior_correlation_structure)

    # Build instrument response consisting of a discretization, mask
    # and harmonic transformaion
    GR = ift.GeometryRemover(position_space)
    mask = ift.Field.from_global_data(position_space, mask)
    Mask = ift.DiagonalOperator(mask)
    R = GR * Mask * HT

    data_space = GR.target

    # Set the noise covariance
    noise = 5.
    N = ift.ScalingOperator(noise, data_space)

    # Create mock data
    MOCK_SIGNAL = S.draw_sample()
    MOCK_NOISE = N.draw_sample()
    data = R(MOCK_SIGNAL) + MOCK_NOISE

    # Build propagator D and information source j
    j = R.adjoint_times(N.inverse_times(data))
    D_inv = R.adjoint * N.inverse * R + S.inverse
    # Make it invertible
    IC = ift.GradientNormController(iteration_limit=500, tol_abs_gradnorm=1e-3)
    D = ift.InversionEnabler(D_inv, IC, approximation=S.inverse).inverse

    # WIENER FILTER
    m = D(j)

    # PLOTTING
    rg = isinstance(position_space, ift.RGSpace)
    if rg and len(position_space.shape) == 1:
        ift.add_plot([HT(MOCK_SIGNAL), GR.adjoint(data), HT(m)],
                 label=['Mock signal', 'Data', 'Reconstruction'],
                 alpha=[1, .3, 1],
                 name='getting_started_1.png')
    else:
        ift.add_plot(HT(MOCK_SIGNAL), title='Mock Signal', name='mock_signal.png')
        ift.add_plot(mask_to_nan(mask, (GR*Mask).adjoint(data)),
                 title='Data', name='data.png')
        ift.add_plot(HT(m), title='Reconstruction', name='reconstruction.png')
    ift.add_plot(mask_to_nan(mask, HT(m-MOCK_SIGNAL)), name='residuals.png')
    ift.plot()