py21cmfast.drivers.lightcone.LightCone
======================================

.. py:class:: py21cmfast.drivers.lightcone.LightCone

   
   A full Lightcone with all associated evolved data.

   :ivar lightcone_distances: The comoving distance to each cell in the lightcones.
   :vartype lightcone_distances: units.Quantity
   :ivar inputs: The input parameters corresponding to the lightcones.
   :vartype inputs: InputParameters
   :ivar lightcones: Lightcone arrays, each of shape `(N, N, Nz)`.
   :vartype lightcones: dict[str, np.ndarray]
   :ivar global_quantities: Arrays of length `node_redshifts` containing the mean field across redshift.
   :vartype global_quantities: dict[str, np.ndarray] | None
   :ivar photon_nonconservation_data: Data defining the conservation hack for photons.
   :vartype photon_nonconservation_data: dict
   :ivar _last_completed_node: Since the lightcone is filled up incrementally, this keeps track of the index
                               of the last completed node redshift that has been added to the lightcone.
   :vartype _last_completed_node: int
   :ivar _last_completed_lcidx: In conjunction with _last_completed_node, this keeps track of the index that
                                has been filled up *in the lightcone* (recalling that the lightcone has
                                multiple redshifts in between each node redshift). While in principle this
                                can be computed from _last_completed_node, it is much more efficient to keep
                                track of it manually.

   :vartype _last_completed_lcidx: int















   ..
       !! processed by numpydoc !!

   .. py:method:: __eq__(other)

      
      Determine if this is equal to another object.
















      ..
          !! processed by numpydoc !!


   .. py:method:: from_file(path, safe = True, remove_buffer = True)
      :classmethod:


      
      Create a new instance from a saved lightcone on disk.
















      ..
          !! processed by numpydoc !!


   .. py:method:: get_fields(inputs)
      :classmethod:


      
      Get a list of the names of the available fields in the simulation.
















      ..
          !! processed by numpydoc !!


   .. py:method:: make_checkpoint(path, lcidx, node_index)

      
      Write updated lightcone data to file.
















      ..
          !! processed by numpydoc !!


   .. py:method:: save(path, clobber=False, lowz_buffer_pixels = 0, highz_buffer_pixels = 0)

      
      Save the lightcone object to disk.
















      ..
          !! processed by numpydoc !!


   .. py:method:: trim(mind, maxd)

      
      Create a new lightcone box containing only the desired distances range.
















      ..
          !! processed by numpydoc !!


   .. py:property:: astro_options

      
      Flag Options shared by all datasets.
















      ..
          !! processed by numpydoc !!


   .. py:property:: astro_params

      
      Astro params shared by all datasets.
















      ..
          !! processed by numpydoc !!


   .. py:property:: cell_size
      :type: float


      
      Cell size [Mpc] of the lightcone voxels.
















      ..
          !! processed by numpydoc !!


   .. py:property:: cosmo_params

      
      Cosmo params shared by all datasets.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: global_quantities
      :type:  dict[str, numpy.ndarray] | None


   .. py:attribute:: inputs
      :type:  py21cmfast.wrapper.inputs.InputParameters


   .. py:property:: lightcone_coords
      :type: tuple[float, float, float]


      
      Co-ordinates [Mpc] of each slice along the redshift axis.
















      ..
          !! processed by numpydoc !!


   .. py:property:: lightcone_dimensions
      :type: tuple[float, float, float]


      
      Lightcone size over each dimension -- tuple of (x,y,z) in Mpc.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: lightcone_distances
      :type:  astropy.units.Quantity


   .. py:property:: lightcone_redshifts
      :type: numpy.ndarray


      
      Redshift of each cell along the redshift axis.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: lightcones
      :type:  dict[str, numpy.ndarray]


   .. py:property:: matter_options

      
      Matter flags shared by all datasets.
















      ..
          !! processed by numpydoc !!


   .. py:property:: n_slices
      :type: int


      
      Number of redshift slices in the lightcone.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: photon_nonconservation_data
      :type:  dict


   .. py:property:: random_seed

      
      Random seed shared by all datasets.
















      ..
          !! processed by numpydoc !!


   .. py:property:: shape
      :type: tuple[int, int, int]


      
      Shape of the lightcone as a 3-tuple.
















      ..
          !! processed by numpydoc !!


   .. py:property:: simulation_options

      
      Matter params shared by all datasets.
















      ..
          !! processed by numpydoc !!