Isoredshift
===========

.. toctree::
   :hidden:

   set_angles </autoapi/luminet/isoredshift/Isoredshift.set_angles>
   set_impact_parameters </autoapi/luminet/isoredshift/Isoredshift.set_impact_parameters>
   plot </autoapi/luminet/isoredshift/Isoredshift.plot>

.. py:class:: luminet.isoredshift.Isoredshift(redshift, order=0, angles=None, impact_parameters=None, ir_radii=None)

   Leightwieght dataclass to store and visualize lines of equal redshift in the observer plane.

   This class is rarely initialized by the user. It is however often used by the :class:`~luminet.black_hole.BlackHole`
   class to handle isoredshifts.

   Isoredshift lines usually have two solutions, more or less in each hemisphere of the observer plane.
   A notable exception is closed isoredshifts, which will have only a single solution at the tip.


   .. py:attribute:: redshift

      redshift value

      :type: float


   .. py:attribute:: order
      :value: 0


      order of the image associated with this isoredshift

      :type: int


   .. py:attribute:: angles
      :value: None


      angles of the isoredshifts

      :type: np.ndarray


   .. py:attribute:: impact_parameters
      :value: None


      radii of the isoredshifts in the observer plane.

      :type: np.ndarray


   .. py:attribute:: ir_radii
      :value: None


      radii of the isoradials used to calculate the isoredshifts

      :type: np.ndarray

Methods
-------

.. autoapisummary::

   luminet.isoredshift.Isoredshift.set_angles
   luminet.isoredshift.Isoredshift.set_impact_parameters
   luminet.isoredshift.Isoredshift.plot