BlackHole
=========

.. toctree::
   :hidden:

   calc_isoredshifts </autoapi/luminet/black_hole/BlackHole.calc_isoredshifts>
   calc_isoradials </autoapi/luminet/black_hole/BlackHole.calc_isoradials>
   plot_isoradials </autoapi/luminet/black_hole/BlackHole.plot_isoradials>
   plot </autoapi/luminet/black_hole/BlackHole.plot>
   plot_isoredshifts </autoapi/luminet/black_hole/BlackHole.plot_isoredshifts>
   plot_isofluxlines </autoapi/luminet/black_hole/BlackHole.plot_isofluxlines>
   sample_photons </autoapi/luminet/black_hole/BlackHole.sample_photons>

.. py:class:: luminet.black_hole.BlackHole(mass=1.0, incl=1.4, acc=1.0, outer_edge=None, angular_resolution=200, radial_resolution=200)

   Black hole class for calculating and visualizing a Swarzschild black hole.



   .. py:attribute:: incl
      :value: 1.4


      Inclination angle of the observer

      :type: float


   .. py:attribute:: mass
      :value: 1.0


      Mass of the black hole

      :type: float


   .. py:attribute:: acc
      :value: 1.0


      Accretion rate of the black hole

      :type: float


   .. py:attribute:: max_flux

      Maximum flux of the black hole, as emitted by the isoriadial R ~ 9.55. See :cite:t:`Luminet_1979`

      :type: float


   .. py:attribute:: critical_b

      critical impact parameter for the photon sphere :math:`3 \sqrt{3} M`

      :type: float


   .. py:attribute:: angular_resolution
      :value: 200


      Angular resolution to use when calculating or plotting the black hole or related properties. Default is 200.

      :type: int


   .. py:attribute:: radial_resolution
      :value: 200


      Radial resolution to use when calculating or plotting the black hole or related properties. Default is 200.

      :type: int


   .. py:attribute:: isoradial_template

      partial function to create an isoradial with some radius and order.

      :type: callable


   .. py:attribute:: disk_outer_edge

      outer edge of the accretion disk. Default is :math:`30 M`.

      :type: float


   .. py:attribute:: disk_inner_edge
      :value: 6.0


      inner edge of the accretion disk i.e. :math:`6 M`.

      :type: float


   .. py:attribute:: disk_apparent_outer_edge

      isoradial that defines the outer edge of the accretion disk.

      :type: Isoradial


   .. py:attribute:: disk_apparent_inner_edge

      isoradial that defines the inner edge of the accretion disk.

      :type: Isoradial


   .. py:attribute:: disk_apparent_inner_edge_ghost

      isoradial that defines the inner edge of the ghost image.

      :type: Isoradial


   .. py:attribute:: disk_apparent_outer_edge_ghost

      isoradial that defines the outer edge of the ghost image.

      :type: Isoradial


   .. py:attribute:: isoradials
      :value: []


      list of calculated isoradials

      :type: List[Isoradial]


   .. py:attribute:: isoredshifts
      :value: []


      list of calculated isoredshifts

      :type: List[Isoredshift]


   .. py:attribute:: photons

      Individual :class:`~luminet.photon.Photon` objects sampled on the accretion disk.


   .. py:attribute:: ghost_photons

      Ghost images of :param:`~photons`.

Methods
-------

.. autoapisummary::

   luminet.black_hole.BlackHole.calc_isoredshifts
   luminet.black_hole.BlackHole.calc_isoradials
   luminet.black_hole.BlackHole.plot_isoradials
   luminet.black_hole.BlackHole.plot
   luminet.black_hole.BlackHole.plot_isoredshifts
   luminet.black_hole.BlackHole.plot_isofluxlines
   luminet.black_hole.BlackHole.sample_photons