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
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,
EventIndexContainer([prefix])	Index columns to include in event lists.
EventType(value)	R1/DL0 EventType
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.
CameraCalibrationContainer([prefix])	Storage of camera calibration coefficients for a given time.
CameraMonitoringContainer([prefix])	Container for camera monitoring data
TelescopeMonitoringContainer([prefix])	Root container for telescope monitoring data (MON)
MonitoringContainer([prefix])	Root container for monitoring data (MON)
MorphologyContainer([prefix])	Parameters related to pixels surviving image cleaning
MuonRingContainer([prefix])	Container for the result of a ring fit in telescope frame
MuonEfficiencyContainer([prefix])
MuonParametersContainer([prefix])
MuonTelescopeContainer([prefix])	Container for muon analysis
MuonContainer([prefix])	Root container for muon parameters
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
PixelStatisticsContainer([prefix])	Container for pixel statistics from flat-field and sky pedestal events
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])
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])
TelescopePointingContainer([prefix])	Container holding pointing information for a single telescope after all necessary correction and calibration steps.
ArrayPointingContainer([prefix])	Container holding pointing information for the combined array after all necessary correction and calibration steps.
StatisticsContainer([prefix])	Store descriptive statistics of a pixel-wise quantity for each channel
ChunkStatisticsContainer([prefix])	Store descriptive statistics of a chunk of images
ImageStatisticsContainer([prefix])	Store descriptive image statistics
IntensityStatisticsContainer([prefix])
PeakTimeStatisticsContainer([prefix])
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