TriggerAlgorithm¶

class gdt.core.trigger.TriggerAlgorithm(timescale: int, offset: int, channels: list | tuple, threshold: float)[source]¶

Bases: object

Class for holding information related to a trigger algorithm

Parameters:

timescale (int) – The duration in integer milliseconds of the window over which we count events contributing to a trigger
offset (int) – The time offset in integer milliseconds between the start time of the trigger window and the beginning of instrument data
channels (list|tuple) – The energy channel range given as (channel_start, channel_stop) for counts contributing to the trigger window
threshold (float) – The signficance above background for including a detector in the trigger

Attributes Summary

`channels`	The energy channel range contributing to the trigger
`offset`	The offset of the first trigger window relative to data start time in integer milliseconds
`threshold`	The significance level above background for including a detector in the trigger
`timescale`	The trigger window duration in integer milliseconds

Methods Summary

`offset_in_unit`(unit)	Method for retrieving the trigger offset with an astropy unit
`timescale_in_unit`(unit)	Method for retrieving the trigger timescale with an astropy unit

Attributes Documentation

channels¶

The energy channel range contributing to the trigger

offset¶

The offset of the first trigger window relative to data start time in integer milliseconds

threshold¶

The significance level above background for including a detector in the trigger

timescale¶

The trigger window duration in integer milliseconds

Methods Documentation

offset_in_unit(unit)[source]¶

Method for retrieving the trigger offset with an astropy unit

Parameters:: unit (astropy.units) – The desired unit for returning the trigger offset (e.g. astropy.units.second)
Returns:: (astropy.units)

timescale_in_unit(unit)[source]¶

Method for retrieving the trigger timescale with an astropy unit

Parameters:: unit (astropy.units) – The desired unit for returning the trigger timescale (e.g. astropy.units.second)
Returns:: (astropy.units)