shifted_cosine

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

Model for a cosine shifted vertically by the amount baseline.

Parameters:

• x – The independent variable;
• amplitude – The amplitude of the cosine.
• 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 sinusoidal response at the given phases(s).