Containers (containers)#

Introduction#

The ctapipe.containers module contains the data model definition of all ctapipe Container classes, which provide the container definitions for all ctapipe data.

The base Container for an event is in ctapipe.containers.ArrayEventContainer.

Reference/API#

ctapipe.containers Module#

Container structures for data that should be read or written to disk

Classes#

ArrayEventContainer([prefix])

Top-level container for all event information

ConcentrationContainer([prefix])

Concentrations are ratios between light amount in certain areas of the image and the full image.

DL0CameraContainer([prefix])

Storage of data volume reduced dl0 data from a single telescope.

DL0Container([prefix])

Storage of a data volume reduced Event

DL1CameraCalibrationContainer([prefix])

Storage of DL1 calibration parameters for the current event

DL1CameraContainer([prefix])

Storage of output of camera calibration e.g the final calibrated image in intensity units and the pulse time.

DL1Container([prefix])

DL1 Calibrated Camera Images and associated data

DL2Container([prefix])

Reconstructed Shower information for a given reconstruction algorithm,

EventCalibrationContainer([prefix])

Container for calibration coefficients for the current event

EventCameraCalibrationContainer([prefix])

Container for the calibration coefficients for the current event and camera

EventIndexContainer([prefix])

Index columns to include in event lists.

EventType(value)

Enum of EventTypes as defined in [CTAOb]

FlatFieldContainer([prefix])

Container for flat-field parameters obtained from a set of [n_events] flat-field events

HillasParametersContainer([prefix])

Hillas Parameters in a spherical system centered on the pointing position (TelescopeFrame).

CoreParametersContainer([prefix])

Telescope-wise shower's direction in the Tilted/Ground Frame

ImageParametersContainer([prefix])

Collection of image parameters

LeakageContainer([prefix])

Fraction of signal in 1 or 2-pixel width border from the edge of the camera, measured in number of signal pixels or in intensity.

MonitoringCameraContainer([prefix])

Container for camera monitoring data

MonitoringContainer([prefix])

Root container for monitoring data (MON)

MorphologyContainer([prefix])

Parameters related to pixels surviving image cleaning

BaseHillasParametersContainer([prefix])

Base container for hillas parameters to allow the CameraHillasParametersContainer to be assigned to an ImageParametersContainer as well.

CameraHillasParametersContainer([prefix])

Hillas Parameters in the camera frame.

CameraTimingParametersContainer([prefix])

Slope and Intercept of a linear regression of the arrival times along the shower main axis in the camera frame.

ParticleClassificationContainer([prefix])

Standard output of gamma/hadron classification algorithms

PedestalContainer([prefix])

Container for pedestal parameters obtained from a set of [n_pedestal] pedestal events

PixelStatusContainer([prefix])

Container for pixel status information It contains masks obtained by several data analysis steps At r0/r1 level only the hardware_mask is initialized

R0CameraContainer([prefix])

Storage of raw data from a single telescope

R0Container([prefix])

Storage of a Merged Raw Data Event

R1CameraContainer([prefix])

Storage of r1 calibrated data from a single telescope

R1Container([prefix])

Storage of a r1 calibrated Data Event

ReconstructedContainer([prefix])

Reconstructed shower info from multiple algorithms

ReconstructedEnergyContainer([prefix])

Standard output of algorithms estimating energy

ReconstructedGeometryContainer([prefix])

Standard output of algorithms reconstructing shower geometry

DispContainer([prefix])

Standard output of disp reconstruction algorithms for origin reconstruction

SimulatedCameraContainer([prefix])

True images and parameters derived from them, analogous to the DL1CameraContainer but for simulated data.

SimulatedShowerContainer([prefix])

Attributes:

SimulatedShowerDistribution([prefix])

2D histogram of simulated number of showers simulated as function of energy and core distance.

SimulationConfigContainer([prefix])

Configuration parameters of the simulation

TelEventIndexContainer([prefix])

index columns to include in telescope-wise event lists

BaseTimingParametersContainer([prefix])

Base container for timing parameters to allow the CameraTimingParametersContainer to be assigned to an ImageParametersContainer as well.

TimingParametersContainer([prefix])

Slope and Intercept of a linear regression of the arrival times along the shower main axis in a spherical system centered on the pointing position (TelescopeFrame)

TriggerContainer([prefix])

Attributes:

WaveformCalibrationContainer([prefix])

Container for the pixel calibration coefficients

StatisticsContainer([prefix])

Store descriptive statistics

IntensityStatisticsContainer([prefix])

Attributes:

PeakTimeStatisticsContainer([prefix])

Attributes:

SchedulingBlockContainer([prefix])

Stores information about the scheduling block.

ObservationBlockContainer([prefix])

Stores information about the observation

ObservingMode(value)

How a scheduling block is observed.

ObservationBlockState(value)

Observation Block States.

Class Inheritance Diagram#

Inheritance diagram of ctapipe.containers.ArrayEventContainer, ctapipe.containers.ConcentrationContainer, ctapipe.containers.DL0CameraContainer, ctapipe.containers.DL0Container, ctapipe.containers.DL1CameraCalibrationContainer, ctapipe.containers.DL1CameraContainer, ctapipe.containers.DL1Container, ctapipe.containers.DL2Container, ctapipe.containers.EventCalibrationContainer, ctapipe.containers.EventCameraCalibrationContainer, ctapipe.containers.EventIndexContainer, ctapipe.containers.EventType, ctapipe.containers.FlatFieldContainer, ctapipe.containers.HillasParametersContainer, ctapipe.containers.CoreParametersContainer, ctapipe.containers.ImageParametersContainer, ctapipe.containers.LeakageContainer, ctapipe.containers.MonitoringCameraContainer, ctapipe.containers.MonitoringContainer, ctapipe.containers.MorphologyContainer, ctapipe.containers.BaseHillasParametersContainer, ctapipe.containers.CameraHillasParametersContainer, ctapipe.containers.CameraTimingParametersContainer, ctapipe.containers.ParticleClassificationContainer, ctapipe.containers.PedestalContainer, ctapipe.containers.PixelStatusContainer, ctapipe.containers.R0CameraContainer, ctapipe.containers.R0Container, ctapipe.containers.R1CameraContainer, ctapipe.containers.R1Container, ctapipe.containers.ReconstructedContainer, ctapipe.containers.ReconstructedEnergyContainer, ctapipe.containers.ReconstructedGeometryContainer, ctapipe.containers.DispContainer, ctapipe.containers.SimulatedCameraContainer, ctapipe.containers.SimulatedShowerContainer, ctapipe.containers.SimulatedShowerDistribution, ctapipe.containers.SimulationConfigContainer, ctapipe.containers.TelEventIndexContainer, ctapipe.containers.BaseTimingParametersContainer, ctapipe.containers.TimingParametersContainer, ctapipe.containers.TriggerContainer, ctapipe.containers.WaveformCalibrationContainer, ctapipe.containers.StatisticsContainer, ctapipe.containers.IntensityStatisticsContainer, ctapipe.containers.PeakTimeStatisticsContainer, ctapipe.containers.SchedulingBlockContainer, ctapipe.containers.ObservationBlockContainer, ctapipe.containers.ObservingMode, ctapipe.containers.ObservationBlockState