ESBO-ETC/esbo_etc/classes/target/ATarget.py

from abc import abstractmethod
from ..IRadiant import IRadiant
from ..SpectralQty import SpectralQty
import astropy.units as u
import numpy as np
from ...lib.logger import logger
from typing import Tuple
from ..Entry import Entry


class ATarget(IRadiant):
    """
    Abstract super class for target models
    """

    @abstractmethod
    @u.quantity_input(wl_bins="length")
    def __init__(self, sfd: SpectralQty, wl_bins: u.Quantity, size: str = "Point"):
        """
        Initialize a new target

        Parameters
        ----------
        sfd : SpectralQty
            The spectral flux density of the target
        wl_bins : length-Quantity
            The bins to be used for evaluating spectral quantities.
        size : str
            The size of the target. Can be either point or extended.
        """
        self.__sfd = sfd
        self.__wl_bins = wl_bins
        self.__size = size

    def calcBackground(self) -> SpectralQty:
        """
        Calculate the spectral radiance of the target's background

        Returns
        -------
        background : SpectralQty
            The spectral radiance of the target's background
        """
        logger.info("Calculating noise for class '" + self.__class__.__name__ + "'.")
        background = SpectralQty(self.__wl_bins, np.repeat(0, len(self.__wl_bins)) << u.W / (u.m**2 * u.nm * u.sr))
        logger.debug(background)
        return background

    def calcSignal(self) -> Tuple[SpectralQty, str, float]:
        """
        Calculate the spectral flux density of the target's signal

        Returns
        -------
        signal : SpectralQty
            The spectral flux density of the target's signal
        size : str
            The size of the target.
        obstruction : float
            The obstruction factor as A_ob / A_ap.
        """
        logger.info("Calculating signal for class '" + self.__class__.__name__ + "'.")
        logger.debug(self.__sfd)
        return self.__sfd, self.__size, 0.0

    @staticmethod
    @abstractmethod
    def check_config(conf: Entry) -> bool:
        """
        Check the configuration for this class

        Parameters
        ----------
        conf : Entry
            The configuration entry to be checked.

        Returns
        -------
        mes : Union[None, str]
            The error message of the check. This will be None if the check was successful.
        """
        pass