cuperiod.periodogram

cuperiod.periodogram(data, method='GLS', *, backend='auto', grid=None, settings=None, columns=None, domain=None)[source]

Compute one or more periodograms for a single light curve.

Parameters:

  • data (various) – The light curve (see to_input() for accepted forms).

  • method (str or sequence of str, default "GLS") – One method name, or several. Case-insensitive ("gls" == "GLS").

  • backend (str, default "auto") – "auto" (GPU when available, else CPU), "cpu", "gpu", or a concrete backend name.

  • grid (GridSpec, optional) – Custom trial grid; defaults to the method’s grid for this light curve.

  • settings (settings model or mapping, optional) – A single method’s settings, or a {method: settings} mapping.

  • columns (ColumnMap, optional) – Column overrides for table inputs.

  • domain (Domain, optional) – Brightness-domain override.

Returns:

Periodogram or MultiResult – A Periodogram if method is a single string, else a MultiResult keyed by method name.

Return type:

Periodogram | MultiResult

Examples

>>> pg = periodogram((t, mag, err), "GLS")
>>> pg.best_period()
>>> res = periodogram(df, ["GLS", "BLS"])