API documentation¶
-
FLICKER.
SingleFlicker
(time, flux, Time=8)[source]¶ Calculate Flicker value for a single lightcurve.
Parameters: - time ([array-like]) – time in unit of days
- flux ([array-like]) – flux in unit of ppt
- Time (Optional [float]) – timescale to calculate flicker value, in unit of days
Returns: flicker value
Return type: flicker ([float])
-
FLICKER.
Flicker
(time, flux, Time=8, Kp=0)[source]¶ Calculate Flicker value for a lightcurve.
Flicker() will return a single flicker value. Input can either be a 1d array/list or a list of multiple lists for the times and fluxes from differnt observing quarters. Flicker() will return the median flicker value from all the quarters.
Parameters: - time ([array-like]) – time in unit of days
- flux ([array-like]) – flux in unit of ppt
- Time (Optional[float]) – timescale to calculate flicker value, in units of hours
- Kp (Optional[float]) – Kepler magnitude for correction (optional)
Returns: flicker value
Return type: flicker ([float])