Instrument (instrument)

Introduction

The ctapipe.instrument module contains classes and methods for describing the instrumental layout and configuration.

This module is under heavy restructuring and should not be considered ready for general use, except for the CameraGeometry object, which provides pixel positions, etc.

Hierarchy of InstrumentDescription Classes

  • SubarrayDescription (describes full subarray)

    • TelescopeDescription (describes a single telescope)

      • OpticsDescription (describes the optical support structure and mirror)

      • CameraDescription (describes the camera)

        • CameraGeometry (describes the geometrical aspects of the camera, e.g. only that which is needed by reconstruction methods)

        • CameraReadout (describes the aspects related to the waveform readout e.g. sampling rate and reference pulse shape.geometrical aspects of the camera, e.g.

        • [to come: classes to hold more detailed hardware-level info about a camera]

Other Instrumental Data

Atmosphere Profiles

With the instrument module you can also load standard atmosphere profiles, which are read from tables located in ctapipe_resources by default

The function get_atmosphere_profile_functions() returns two interpolation functions that convert between height and atmosphere thickness.

Reference/API

ctapipe.instrument Package

Functions

get_atmosphere_profile_functions([…])

Deprecated since version v0.16.0.

guess_telescope(n_pixels, focal_length[, …])

From n_pixels of the camera and the focal_length, guess which telescope we are dealing with.

Classes

CameraDescription(name, geometry, readout)

Describes a Cherenkov camera and its associated CameraGeometry and CameraReadout

CameraGeometry(name, pix_id, pix_x, pix_y, …)

CameraGeometry is a class that stores information about a Cherenkov Camera that us useful for imaging algorithms and displays.

CameraReadout(name, sampling_rate, …[, …])

Stores properties related to the readout of a Cherenkov Camera.

OpticsDescription(name, size_type, …)

Describes the optics of a Cherenkov Telescope mirror

PixelShape(value)

Supported Pixel Shapes Enum

SubarrayDescription(name[, tel_positions, …])

Collects the TelescopeDescription of all telescopes along with their positions on the ground.

TelescopeDescription(name, optics, camera)

Describes a Cherenkov Telescope and its associated OpticsDescription and CameraDescription

UnknownTelescopeID

Raised when an unknown telescope id is encountered

FocalLengthKind(value)

Enumeration for the different kinds of focal lengths.

ReflectorShape(value)

Enumeration of the different reflector shapes

SizeType(value)

Enumeration of different telescope sizes (LST, MST, SST)