py21cmfast.wrapper.outputs
==========================

.. py:module:: py21cmfast.wrapper.outputs

.. autoapi-nested-parse::

   Output class objects.

   The classes provided by this module exist to simplify access to large datasets created within C.
   Fundamentally, ownership of the data belongs to these classes, and the C functions merely accesses
   this and fills it. The various boxes and lightcones associated with each output are available as
   instance attributes. Along with the output data, each output object contains the various input
   parameter objects necessary to define it.

   .. warning:: These should not be instantiated or filled by the user, but always handled
                as output objects from the various functions contained here. Only the data
                within the objects should be accessed.

   ..
       !! processed by numpydoc !!


Attributes
----------

.. autoapisummary::

   py21cmfast.wrapper.outputs.logger


Classes
-------

.. toctree::
   :hidden:

   /autoapi/py21cmfast/wrapper/outputs/BrightnessTemp
   /autoapi/py21cmfast/wrapper/outputs/HaloBox
   /autoapi/py21cmfast/wrapper/outputs/HaloCatalog
   /autoapi/py21cmfast/wrapper/outputs/InitialConditions
   /autoapi/py21cmfast/wrapper/outputs/IonizedBox
   /autoapi/py21cmfast/wrapper/outputs/OutputStruct
   /autoapi/py21cmfast/wrapper/outputs/OutputStructZ
   /autoapi/py21cmfast/wrapper/outputs/PerturbedField
   /autoapi/py21cmfast/wrapper/outputs/PerturbedHaloCatalog
   /autoapi/py21cmfast/wrapper/outputs/TsBox
   /autoapi/py21cmfast/wrapper/outputs/XraySourceBox

.. autoapisummary::

   py21cmfast.wrapper.outputs.BrightnessTemp
   py21cmfast.wrapper.outputs.HaloBox
   py21cmfast.wrapper.outputs.HaloCatalog
   py21cmfast.wrapper.outputs.InitialConditions
   py21cmfast.wrapper.outputs.IonizedBox
   py21cmfast.wrapper.outputs.OutputStruct
   py21cmfast.wrapper.outputs.OutputStructZ
   py21cmfast.wrapper.outputs.PerturbedField
   py21cmfast.wrapper.outputs.PerturbedHaloCatalog
   py21cmfast.wrapper.outputs.TsBox
   py21cmfast.wrapper.outputs.XraySourceBox


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

.. py:data:: logger