decaying_cosine

forest.benchmarking.analysis.decaying_cosine(x: numpy.ndarray, amplitude: float, decay_time: float, offset: float, baseline: float, frequency: float) → numpy.ndarray

Calculate exponentially decaying sinusoid at a series of points.

Parameters:

• x – The independent variable with respect to which decay is calculated.
• amplitude – The amplitude of the decaying sinusoid.
• decay_time – The inverse decay rate - e.g. T2 - of the decay curve.
• offset – The argument offset of the sinusoidal curve, o for sin(x - o)
• baseline – The baseline of the sinusoid, e.g. b for sin(x) + b
• frequency – The frequency of the sinusoid, e.g. f for sin(f x)

Returns:

The exponentially decaying sinusoid evaluated at the point(s) x