jason-neal/spectrum_overload

# -*- coding: utf-8 -*-

"""Differential Class which takes the difference between two spectra."""
from typing import Any, Dict, Optional

from spectrum_overload.spectrum import Spectrum

# TODO: Add in s-profile from
# Ferluga 1997: Separating the spectra of binary stars-I. A simple method: Secondary reconstruction


class DifferentialSpectrum(object):
    """A differential spectrum."""

    def __init__(self, Spectrum1: Spectrum, Spectrum2: Spectrum) -> None:
        """Initialise class with both spectra."""
        if not (Spectrum1.calibrated and Spectrum2.calibrated):
            raise ValueError("Input spectra are not calibrated.")

        self.spec1 = Spectrum1
        self.spec2 = Spectrum2
        self.params = None  # type: Optional[Dict[str, Any]]

    def barycentric_correct(self):
        """Barycentric correct each spectra."""
        pass

    def rest_frame(self, frame):
        """Change rest frame to one of the spectra."""
        pass

    def diff(self):
        """Calculate difference between the two spectra."""
        # TODO: Access interpolations
        return self.spec1 - self.spec2

    def sort(self, method: str = "time"):
        """Sort spectra in specific order. e.g. time, reversed."""
        pass

    def swap(self):
        """Swap order of the two spectra."""
        self.spec1, self.spec2 = self.spec2, self.spec1

    def add_orbital_params(self, params: Dict[str, Any]):
        """A dictionary of orbital parameters to use for shifting frames."""
        self.params = params