py21cmfast.wrapper.outputs

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.

Attributes

logger

Classes

BrightnessTemp	A class containing the brightness temperature box.
HaloBox	A class containing all gridded halo properties.
HaloCatalog	A class containing all fields related to halos.
InitialConditions	A class representing an InitialConditions C-struct.
IonizedBox	A class containing all ionized boxes.
OutputStruct	Base class for any class that wraps a C struct meant to be output from a C function.
OutputStructZ	The same as an OutputStruct, but containing a redshift.
PerturbedField	A class containing all perturbed field boxes.
PerturbedHaloCatalog	A class to hold a HaloCatalog whose coordinates are in real (Eulerian) space.
TsBox	A class containing all spin temperature boxes.
XraySourceBox	A class containing the filtered sfr grids.

Module Contents

py21cmfast.wrapper.outputs.logger