ctapipe is not stable yet, so expect large and rapid changes to structure and functionality as we explore various design choices before the 1.0 release.

CameraDescription#

class ctapipe.instrument.CameraDescription(name, geometry: CameraGeometry, readout: CameraReadout)[source]#

Bases: object

Describes a Cherenkov camera and its associated CameraGeometry and CameraReadout

Parameters:
name: str

Camera name (e.g. NectarCam, LSTCam, …)

geometry: CameraGeometry

The pixel geometry of this camera

readout: CameraReadout

The readout properties for this camera

Attributes Summary

geometry

name

readout

Methods Summary

from_name(name)

Construct a CameraDescription from a camera name

get_known_camera_names()

Returns a list of camera names that are available currently on the system.

Attributes Documentation

geometry#
name#
readout#

Methods Documentation

classmethod from_name(name)[source]#

Construct a CameraDescription from a camera name

Parameters:
name: str

Camera name (e.g. NectarCam, LSTCam, …)

Returns:
CameraDescription

Notes

Warning: This method loads a pre-generated CameraDescription and is thus not guaranteed to be the same pixel ordering or even positions that correspond with event data! Therefore if you are analysing data, you should not rely on this method, but rather open the data with an EventSource and use the CameraDescription that is provided by source.subarray.tel[i].camera or by source.subarray.camera_types[type_name]. This will guarantee that the pixels in the event data correspond with the CameraDescription

classmethod get_known_camera_names()[source]#

Returns a list of camera names that are available currently on the system. Beware that the from_name method also tries to download camera descriptions from the data server, so this list might not be exhaustive.

Returns:
list(str)