Source code for taurex.binning.lightcurvebinner

import typing as t

import numpy as np
import numpy.typing as npt

from taurex import OutputSize
from taurex.types import ModelOutputType

from .binner import BinDownType, Binner




class LightcurveBinner(Binner):
    """A special class of binning used for lightcurves.

    This is essentially the same as
    :class:`~taurex.binning.nativebinner.NativeBinner`
    but for lightcurve forward models.


    """



    def bindown(
        self,
        wngrid: npt.NDArray[np.float64],
        spectrum: npt.NDArray[np.float64],
        grid_width: t.Optional[npt.NDArray[np.float64]] = None,
        error: t.Optional[npt.NDArray[np.float64]] = None,
    ) -> BinDownType:
        """Does nothing, only returns function arguments"""
        return wngrid, spectrum, error, grid_width




    def generate_spectrum_output(
        self,
        model_output: ModelOutputType,
        output_size: t.Optional[OutputSize] = OutputSize.heavy,
    ):
        """Generate spectrum output for lightcurves.

        Accepts only a lightcurve forward model. Stores the lightcurve
        as well as the spectrum.

        Parameters
        ----------
        model_output: obj:`tuple`
            Result from running a TauREx3 lightcurve forward model

        output_size: :class:`~taurex.taurexdefs.OutputSize`
            Size of the output.


        Returns
        -------
        :obj:`dict`:
            Dictionary of spectra containing both lightcurves
            and spectra.


        """

        output = {}

        wngrid, lightcurve, tau, extra = model_output
        native_grid, native, binned, extra = extra

        output["native_wngrid"] = native_grid
        output["native_wlgrid"] = 10_000 / native_grid
        output["binned_wngrid"] = wngrid
        output["binned_wlgrid"] = 10_000 / wngrid
        output["lightcurve"] = lightcurve
        output["native_spectrum"] = native
        output["binned_spectrum"] = binned
        if output_size > OutputSize.lighter:
            output["binned_tau"] = self.bindown(wngrid, tau)[1]
            if output_size > OutputSize.light:
                output["native_tau"] = tau

        return output