# Copyright (c) 2016 Weitian LI <liweitianux@live.com>
# MIT license

"""
Interface o the simulations of various supported foreground components.

Currently supported foregrounds:

- Galactic synchrotron
- Galactic free-free
- Galactic supernova remnants
"""

import os
import logging
from datetime import datetime, timezone
from collections import OrderedDict

import numpy as np
import astropy.units as au
from astropy.io import fits
import healpy as hp

from .galactic import (Synchrotron as GalacticSynchrotron,
                       FreeFree as GalacticFreeFree,
                       SuperNovaRemnants as GalacticSNR)
from .extragalactic import GalaxyClusters as EGGalaxyClusters
from .utils import write_fits_healpix


logger = logging.getLogger(__name__)


class Foregrounds:
    """Interface to the simulations of supported foreground components.

    All the enabled components are also combined to make the total foreground
    map, as controlled by the configurations.

    Parameters
    ----------
    configs : `ConfigManager`
        An `ConfigManager` instance containing both the default and user
        configurations.
        For more details, see the example configuration specification.

    Attributes
    ----------
    COMPONENTS_ALL : `OrderedDict`
        Ordered dictionary of all supported simulation components, with keys
        the IDs of the components, and values the corresponding component
        class.
    components_id : list[str]
        List of IDs of the enabled simulation components
    components : `OrderedDict`
        Ordered dictionary of the enabled simulation components, with keys
        the IDs of the components, and values the corresponding component
        instance/object.
    frequencies : 1D `~numpy.ndarray`
        List of frequencies where the foreground components are simulated.
    freq_unit : `~astropy.units.Unit`
        Unit of the frequency
    """
    # All supported foreground components
    COMPONENTS_ALL = OrderedDict([
        ("galactic/synchrotron",   GalacticSynchrotron),
        ("galactic/freefree",      GalacticFreeFree),
        ("galactic/snr",           GalacticSNR),
        ("extragalactic/clusters", EGGalaxyClusters),
    ])

    def __init__(self, configs):
        self.configs = configs
        self._set_configs()
        # Initialize enabled components
        self.components = OrderedDict()
        for comp in self.components_id:
            logger.info("Initialize component: {0}".format(comp))
            comp_cls = self.COMPONENTS_ALL[comp]
            self.components[comp] = comp_cls(configs)
        logger.info("Done initialize %d components!" % len(self.components))

    def _set_configs(self):
        """Load the configs and set the corresponding class attributes."""
        self.components_id = self.configs.getn("common/components")
        logger.info("All supported simulation components: {0}".format(
            ", ".join(list(self.COMPONENTS_ALL.keys()))))
        logger.info("Enabled components: {0}".format(
            ", ".join(self.components_id)))
        #
        self.frequencies = np.array(self.configs.frequencies, ndmin=1)
        self.freq_unit = au.Unit(self.configs.getn("frequency/unit"))
        logger.info("Simulation frequencies: "
                    "{min:.2f} - {max:.2f} {unit} (#{num:d})".format(
                        min=self.frequencies.min(),
                        max=self.frequencies.max(),
                        num=len(self.frequencies),
                        unit=self.freq_unit))
        #
        self.filename_pattern = self.configs.getn("output/filename_pattern")
        self.use_float = self.configs.getn("output/use_float")
        self.clobber = self.configs.getn("output/clobber")
        self.combine = self.configs.getn("output/combine")
        self.prefix = self.configs.getn("output/combine_prefix")
        self.output_dir = self.configs.get_path("output/output_dir")
        self.nside = self.configs.getn("common/nside")

    def _make_filepath(self, **kwargs):
        """Make the path of output file according to the filename pattern
        and output directory loaded from configurations.
        """
        data = {
            "prefix": self.prefix,
        }
        data.update(kwargs)
        filename = self.filename_pattern.format(**data)
        filetype = self.configs.getn("output/filetype")
        if filetype == "fits":
            filename += ".fits"
        else:
            raise NotImplementedError("unsupported filetype: %s" % filetype)
        filepath = os.path.join(self.output_dir, filename)
        return filepath

    def _make_header(self):
        """Make the header with detail information (e.g., parameters and
        history) for the simulated products.
        """
        header = fits.Header()
        header["COMP"] = ("Combined foreground",
                          "Emission component")
        header.add_comment("COMPONENTS: " + ", ".join(self.components_id))
        header["UNIT"] = ("Kelvin", "Map unit")
        header["CREATOR"] = (__name__, "File creator")
        # TODO:
        history = []
        comments = []
        for hist in history:
            header.add_history(hist)
        for cmt in comments:
            header.add_comment(cmt)
        self.header = header
        logger.info("Created FITS header")

    def _output(self, hpmap, frequency):
        """Write the simulated free-free map to disk with proper header
        keywords and history.
        """
        if not os.path.exists(self.output_dir):
            os.mkdir(self.output_dir)
            logger.info("Created output dir: {0}".format(self.output_dir))
        #
        filepath = self._make_filepath(frequency=frequency)
        if not hasattr(self, "header"):
            self._make_header()
        header = self.header.copy()
        header["FREQ"] = (frequency, "Frequency [ MHz ]")
        header["DATE"] = (
            datetime.now(timezone.utc).astimezone().isoformat(),
            "File creation date"
        )
        if self.use_float:
            hpmap = hpmap.astype(np.float32)
        write_fits_healpix(filepath, hpmap, header=header,
                           clobber=self.clobber)
        logger.info("Write combined foreground to file: {0}".format(filepath))

    def preprocess(self):
        """Perform the preparation procedures for the final simulations."""
        logger.info("Perform preprocessing for all enabled components ...")
        for comp_obj in self.components.values():
            comp_obj.preprocess()

    def simulate(self):
        """Simulate the enabled components, as well as combine all the
        simulated components to make up the total foregrounds.

        This is the *main interface* to the foreground simulations.

        NOTE
        ----
        For each requested frequency, all enabled components are simulated,
        which are combined to compose the total foreground and save to disk.
        In this way, less memory is required, since the number of components
        are generally much less than the number of frequency bins.
        """
        npix = hp.nside2npix(self.nside)
        nfreq = len(self.frequencies)
        for i, f in enumerate(self.frequencies):
            logger.info("[#{0}/{1}] ".format(i+1, nfreq) +
                        "Simulating components at {freq} {unit} ...".format(
                            freq=f, unit=self.freq_unit))
            hpmap_f = np.zeros(npix)
            for comp_obj in self.components.values():
                hpmap_f += comp_obj.simulate_frequency(f)
            #
            if self.combine:
                self._output(hpmap_f, f)

    def postprocess(self):
        """Perform the post-simulation operations before the end."""
        logger.info("Perform postprocessing for all enabled components ...")
        for comp_obj in self.components.values():
            comp_obj.postprocess()