utils.offset_background#

Back to Module page

Summary#

Finds the amount to shift the detectors’ data streams by. It returns an integer multiple of dt_shift

Signature#

def offset_background(dt, time_slide_jump, dt_shift)

Input variables#
Name	Type	Default	Description
`dt`			Time delays w.r.t reference trigger (s) (scalar or array)
`time_slide_jump`			The least count of time slides (s)
`dt_shift`			Time resolution (s)

Output variables#

Return annotation	Docstring type	Description
`None`		Amount to add to detector to bring the timeseries to zero lag wrt the reference detector (opposite convention to coherent_score_mz.py)

Docstring#

Finds the amount to shift the detectors' data streams by.
It returns an integer multiple of dt_shift
:param dt: Time delays w.r.t reference trigger (s) (scalar or array)
:param time_slide_jump: The least count of time slides (s)
:param dt_shift: Time resolution (s)
:return:
    Amount to add to detector to bring the timeseries to zero lag
    wrt the reference detector (opposite convention to coherent_score_mz.py)