Estimator

maelstrom.estimator.estimate_frequencies(x, y, fmin=None, fmax=None, max_peaks=3, oversample=4.0, optimize_freq=True)[source]

Attempts to pick out the best frequencies for use with phase modulation.

Parameters

  • x (float, optional) – Number of tuning steps for the sampler (default 3000)

  • y (float, optional) – Number of samples from which to populate the trace (default 3000)

  • fmin (bool, optional) – If set to True, the sampler will optimize the model before attempting to sample. If False (default), the sampler will initialise at the testpoints of your priors.

  • fmax (float, optional) – The target acceptance ratio of the NUTS sampler (default 0.9).

  • max_peaks (int) – Maximum number of frequencies to return (default 3)

  • oversample (float) – Oversample factor for the spectrum (default 4.)

  • optimize_freq (bool) – Whether to optimize the frequencies according to the Maelstrom model using Scipy.optimize (default True)

Returns

peaks – Array of frequencies of length max_peaks

Return type

numpy.ndarray