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.

WaveformModel#

class ctapipe.image.toymodel.WaveformModel(reference_pulse, reference_pulse_sample_width, sample_width)[source]#

Bases: object

Methods Summary

from_camera_readout(readout[, gain_channel])

Create class from a ctapipe.instrument.CameraReadout.

get_waveform(charge, time, n_samples)

Obtain the waveform toy model.

Methods Documentation

classmethod from_camera_readout(readout, gain_channel='ALL')[source]#

Create class from a ctapipe.instrument.CameraReadout.

Parameters:
readoutctapipe.instrument.CameraReadout
gain_channelstr

The reference pulse gain channel to use. Choose between ‘HIGH’, ‘LOW’ and ‘ALL’.

Returns:
WaveformModel
get_waveform(charge, time, n_samples)[source]#

Obtain the waveform toy model.

Parameters:
chargendarray

Amount of charge in each pixel Shape: (n_pixels)

timendarray

The signal time in the waveform in nanoseconds Shape: (n_pixels)

n_samplesint

Number of samples in the waveform

Returns:
waveformndarray

Toy model waveform Shape (n_channels, n_pixels, n_samples)