cuperiod.GridSpec

class cuperiod.GridSpec(kind, values, uniform=False, meta=<factory>)[source]

Bases: object

A trial grid in either the frequency or period domain.

Parameters:

  • kind ({"frequency", "period"}) – Which quantity values holds.

  • values (numpy.ndarray) – Ascending grid samples (cycles/day for frequency, days for period).

  • uniform (bool, default False) – True if values is an arithmetic progression. Uniform frequency grids let the NUFFT GLS backend skip re-deriving (f0, df, nf).

  • meta (Mapping, optional) – Method-specific grid parameters (e.g. BLS duration fractions / segments).

property size: int

Number of grid samples.

property frequency: NDArray[float64]

The grid as frequencies (cycles/day), ascending.

property period: NDArray[float64]

The grid as periods (days), ascending.

uniform_frequency_params()[source]

Return (f0, df, nf) for a uniform frequency grid.

Raises:

ValueError – If this is not a frequency grid.

Return type:

tuple[float, float, int]