astrobase.periodbase.spdm module¶
Contains the Stellingwerf (1978) phasedispersion minimization periodsearch algorithm implementation for periodbase.

astrobase.periodbase.spdm.
stellingwerf_pdm_theta
(times, mags, errs, frequency, binsize=0.05, minbin=9)[source]¶ This calculates the Stellingwerf PDM theta value at a test frequency.
Parameters:  times,mags,errs (np.array) – The input timeseries and associated errors.
 frequency (float) – The test frequency to calculate the theta statistic at.
 binsize (float) – The phase bin size to use.
 minbin (int) – The minimum number of items in a phase bin to consider in the calculation of the statistic.
Returns: theta_pdm – The value of the theta statistic at the specified frequency.
Return type: float

astrobase.periodbase.spdm.
stellingwerf_pdm
(times, mags, errs, magsarefluxes=False, startp=None, endp=None, stepsize=0.0001, autofreq=True, normalize=False, phasebinsize=0.05, mindetperbin=9, nbestpeaks=5, periodepsilon=0.1, sigclip=10.0, nworkers=None, verbose=True)[source]¶ This runs a parallelized Stellingwerf phasedispersion minimization (PDM) period search.
Parameters:  times,mags,errs (np.array) – The mag/flux timeseries with associated measurement errors to run the periodfinding on.
 magsarefluxes (bool) – If the input measurement values in mags and errs are in fluxes, set this to True.
 startp,endp (float or None) – The minimum and maximum periods to consider for the transit search.
 stepsize (float) – The stepsize in frequency to use when constructing a frequency grid for the period search.
 autofreq (bool) – If this is True, the value of stepsize will be ignored and the
astrobase.periodbase.get_frequency_grid()
function will be used to generate a frequency grid based on startp, and endp. If these are None as well, startp will be set to 0.1 and endp will be set to times.max()  times.min().  normalize (bool) – This sets if the input timeseries is normalized to 0.0 and rescaled such that its variance = 1.0. This is the recommended procedure by SchwarzenbergCzerny 1996.
 phasebinsize (float) – The bin size in phase to use when calculating the PDM theta statistic at a test frequency.
 mindetperbin (int) – The minimum number of elements in a phase bin to consider it valid when calculating the PDM theta statistic at a test frequency.
 nbestpeaks (int) – The number of ‘best’ peaks to return from the periodogram results, starting from the global maximum of the periodogram peak values.
 periodepsilon (float) – The fractional difference between successive values of ‘best’ periods when sorting by periodogram power to consider them as separate periods (as opposed to part of the same periodogram peak). This is used to avoid broad peaks in the periodogram and make sure the ‘best’ periods returned are all actually independent.
 sigclip (float or int or sequence of two floats/ints or None) –
If a single float or int, a symmetric sigmaclip will be performed using the number provided as the sigmamultiplier to cut out from the input timeseries.
If a list of two ints/floats is provided, the function will perform an ‘asymmetric’ sigmaclip. The first element in this list is the sigma value to use for fainter flux/mag values; the second element in this list is the sigma value to use for brighter flux/mag values. For example, sigclip=[10., 3.], will sigclip out greater than 10sigma dimmings and greater than 3sigma brightenings. Here the meaning of “dimming” and “brightening” is set by physics (not the magnitude system), which is why the magsarefluxes kwarg must be correctly set.
If sigclip is None, no sigmaclipping will be performed, and the timeseries (with nonfinite elems removed) will be passed through to the output.
 nworkers (int) – The number of parallel workers to use when calculating the periodogram.
 verbose (bool) – If this is True, will indicate progress and details about the frequency grid used for the period search.
Returns: This function returns a dict, referred to as an lspinfo dict in other astrobase functions that operate on periodogram results. This is a standardized format across all astrobase periodfinders, and is of the form below:
{'bestperiod': the best period value in the periodogram, 'bestlspval': the periodogram peak associated with the best period, 'nbestpeaks': the input value of nbestpeaks, 'nbestlspvals': nbestpeakssize list of best period peak values, 'nbestperiods': nbestpeakssize list of best periods, 'lspvals': the full array of periodogram powers, 'periods': the full array of periods considered, 'method':'pdm' > the name of the periodfinder method, 'kwargs':{ dict of all of the input kwargs for recordkeeping}}
Return type: dict

astrobase.periodbase.spdm.
analytic_false_alarm_probability
(lspinfo, times, conservative_nfreq_eff=True, peakvals=None, inplace=True)[source]¶ This returns the analytic false alarm probabilities for periodogram peak values.
FIXME: this doesn’t actually work. Fix later.
The calculation follows that on page 3 of Zechmeister & Kurster (2009):
FAP = 1 − [1 − Prob(z > z0)]**M
where:
M is the number of independent frequencies Prob(z > z0) is the probability of peak with value > z0 z0 is the peak value we're evaluating
For PDM, the Prob(z > z0) is described by the beta distribution, according to:
 SchwarzenbergCzerny (1997; https://ui.adsabs.harvard.edu/#abs/1997ApJ…489..941S)
 Zalian, Chadid, and Stellingwerf (2013; http://adsabs.harvard.edu/abs/2014MNRAS.440…68Z)
This is given by:
beta( (NB)/2, (B1)/2; ((NB)/(B1))*theta_pdm )
Where:
N = number of observations B = number of phase bins
This translates to a scipy.stats call to the beta distribution CDF:
x = ((NB)/(B1))*theta_pdm_best prob_exceeds_val = scipy.stats.beta.cdf(x, (NB)/2.0, (B1.0)/2.0)
Which we can then plug into the false alarm prob eqn above with the calculation of M.
Parameters:  lspinfo (dict) – The dict returned by the
stellingwerf_pdm()
function.  times (np.array) – The times for which the periodogram result in
lspinfo
was calculated.  conservative_nfreq_eff (bool) –
If True, will follow the prescription given in SchwarzenbergCzerny (2003):
http://adsabs.harvard.edu/abs/2003ASPC..292..383S
and estimate the effective number of independent frequences M_eff as:
min(N_obs, N_freq, DELTA_f/delta_f)
 peakvals (sequence or None) – The peak values for which to evaluate the falsealarm probability. If
None, will calculate this for each of the peak values in the
nbestpeaks
key of thelspinfo
dict.  inplace (bool) – If True, puts the results of the FAP calculation into the
lspinfo
dict as a list available aslspinfo['falsealarmprob']
.
Returns: The calculated false alarm probabilities for each of the peak values in
peakvals
.Return type: list