:py:mod:`pytmosph3r.observations.phasecurve`
============================================

.. py:module:: pytmosph3r.observations.phasecurve


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

.. py:class:: Phasecurve(n_phases: Optional[int] = None, start: Union[None, float, astropy.units.Quantity[pytmosph3r.util.pt.angle]] = None, end: Union[None, float, astropy.units.Quantity[pytmosph3r.util.pt.angle]] = None, phases: Union[None, numpy.ndarray, astropy.units.Quantity[pytmosph3r.util.pt.angle]] = None, wns=None, *args, **kwargs)


   Bases: :py:obj:`pytmosph3r.observations.emission.Emission`

   The Phasecurve module relies on the :class:`~pytmosph3r.emission.Emission` module: we iterate over
   :attr:`n_phases` observer longitudes and scale the flux using the projection of the surface onto that direction.
   You can use the same parameters as :class:`~pytmosph3r.emission.Emission` for this module.
   IMPORTANT NOTE: :attr:`top_flux_from_star` and :attr:`mu_from_obs` will add a considerable computing time since
   the emission flux has to be re-computed at EACH phase.

   :param n_phases: Number of phases for the phase curve. Defaults to 100.
   :type n_phases: int
   :param start: Phase at which to start the phasecurve, in SI (radians) or astropy units.
   :type start: float
   :param end: Phase at which to end the phasecurve, in SI (radians) or astropy units.
   :type end: float
   :param phases: List of phases (ignores :attr:`n_phases`, :attr:`start` and :attr:`end`). Assumed to be in
   :type phases: array
   :param SI:
   :param or astropy units.:
   :param kwargs: Parameters passed to the :class:`~pytmosph3r.emission.Emission` module.
   :type kwargs: dict

   :returns: A series of :attr:`n_phases` Emission fluxes.
   :rtype: (array)

   We provide two methods to select the phases, the first one (1) provide an array with the phases wanted.
   The second one (2) create the phases array from a number of phase and the bounds.

   :param n_phases:
                    (2)
   :type n_phases: Optional[int]
   :param start:
                 (2)
   :type start: None, float, Quantity[pt.angle]
   :param end:
               (2)
   :type end: None, float, Quantity[pt.angle]
   :param phases: Typed array (1)
   :type phases: Union[None, np.ndarray, Quantity[pt.angle]]
   :param wns ():
   :param \*args ():
   :param \*\*kwargs ():

   .. py:attribute:: n_phases
      :type: int

      Number of phases in the phase curve.

   .. py:method:: build(model)

      No need for an altitude-based grid (as done in transmission), so we just copy the input grid.



   .. py:method:: compute(model)

      Computation of a phase curve, along :attr:`n_phases` observer longitudes. This function is called by :func:`compute`.


   .. py:method:: outputs()