pytmosph3r.planetary_system.star.base
=====================================

.. py:module:: pytmosph3r.planetary_system.star.base




Module Contents
---------------

.. py:class:: BaseStar(radius: Union[float, astropy.units.Quantity[pytmosph3r.util.pt.length]] = 695700000.0, mass: Union[None, float, astropy.units.Quantity[pytmosph3r.util.pt.mass]] = None, **kwargs)

   Bases: :py:obj:`abc.ABC`, :py:obj:`pytmosph3r.log.Logger`


   This class represents the base properties of a star and the default methods implemented
   and required to be implemented.

   Subclasses should implement `_spectrum(self, wnedges: numpy.ndarray, wns: numpy.ndarray) -> Spectrum`

   :param radius: Stellar radius in`m`
   :type radius: float, optional
   :param mass: Stellar mass in `kg`
   :type mass: float, optional


   .. py:attribute:: radius
      :type:  float

      Star radius (in `m`).


   .. py:attribute:: mass
      :type:  Optional[float]
      :value: None


      Star mass (in `kg`).


   .. py:property:: mass_sol
      :type: Optional[float]


      Star mass (in `solar mass`).


   .. py:property:: radius_sol
      :type: float


      Star radius (in `solar radii`).


   .. py:method:: spectrum(wnedges: numpy.ndarray, wns: numpy.ndarray, distance: Optional[float] = None) -> exo_k.Spectrum

      Return the spectrum of the flux at the star surface by default, or at the distance given in meters (m).

      :param wnedges: Wavenumbers of the bin edges to be used.
      :param wns: Wavenumbers of the bin centers to be used.
      :param distance: If distance is None, take the flux at the surface, else take the flux seen at the
                       given distance.

      :returns: Flux from the star.



   .. py:method:: spectrum_like(spectrum: exo_k.Spectrum, distance: Optional[float] = None) -> exo_k.Spectrum

      Same as `BaseStar.spectrum()`, but extract the spectral grid from an existing `Spectrum`.