nectarchain.data.container.waveforms_container.WaveformsContainer#

class WaveformsContainer(prefix=None, **fields)[source]#

Bases: ArrayDataContainer

A container that holds information about waveforms from a specific run.

Fields:

nsamples (int): The number of samples in the waveforms. subarray (SubarrayDescription): The subarray description instance. wfs_hg (np.ndarray): An array of high gain waveforms. wfs_lg (np.ndarray): An array of low gain waveforms.

Attributes:
run_numberField(default=None, type=uint16)

run number associated to the waveforms

neventsField(default=None, type=uint64)

number of events

npixelsField(default=None, type=uint16)

number of effective pixels

pixels_idField(default=None, dtype=uint16, ndim=1, type=ndarray)

pixel ids

broken_pixels_hgField(default=None, dtype=bool, ndim=2, type=ndarray)

high gain broken pixels

broken_pixels_lgField(default=None, dtype=bool, ndim=2, type=ndarray)

low gain broken pixels

cameraField(default=None, type=str)

camera name

ucts_timestampField(default=None, dtype=uint64, ndim=1, type=ndarray)

events ucts timestamp

ucts_busy_counterField(default=None, dtype=uint32, ndim=1, type=ndarray)

ucts busy counter

ucts_event_counterField(default=None, dtype=uint32, ndim=1, type=ndarray)

ucts event counter

event_typeField(default=None, dtype=uint8, ndim=1, type=ndarray)

trigger event type

event_idField(default=None, dtype=uint32, ndim=1, type=ndarray)

event ids

trig_pattern_allField(default=None, dtype=bool, ndim=3, type=ndarray)

trigger pattern

trig_patternField(default=None, dtype=bool, ndim=2, type=ndarray)

reduced trigger pattern

multiplicityField(default=None, dtype=uint16, ndim=1, type=ndarray)

events multiplicity

nsamplesField(default=None, type=uint8)

number of samples in the waveforms

wfs_hgField(default=None, dtype=uint16, ndim=3, type=ndarray)

high gain waveforms

wfs_lgField(default=None, dtype=uint16, ndim=3, type=ndarray)

low gain waveforms

metadict

dict of attached metadata

prefixstr

Prefix attached to column names when saved to a table or file

Methods

as_dict

Convert the Container into a dictionary

from_hdf5

Reads a container from an HDF5 file.

items

Generator over (key, value) pairs for the items

keys

Get the keys of the container

reset

Reset all values back to their default values

update

update more than one parameter at once (e.g. update(x=3,y=4) or update(**dict_of_values)).

validate

Check that all fields in the Container have the expected characteristics (as defined by the Field metadata).

values

Get the keys of the container

Attributes

nsamples

wfs_hg

wfs_lg

meta

prefix

broken_pixels_hg

broken_pixels_lg

camera

default_prefix

event_id

event_type

fields

multiplicity

nevents

npixels

pixels_id

run_number

trig_pattern

trig_pattern_all

ucts_busy_counter

ucts_event_counter

ucts_timestamp