diff --git a/docs/index.rst b/docs/index.rst index 57760105f..b250d1297 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,26 +21,35 @@ Features Current Capabilities -------------------- -Currently implemented functionality in this library comprises: +1. Data handling and simulation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * loading event lists from fits files of a few missions (RXTE/PCA, NuSTAR/FPM, XMM-Newton/EPIC, NICER/XTI) * constructing light curves from event data, various operations on light curves (e.g. addition, subtraction, joining, and truncation) +* simulating a light curve with a given power spectrum +* simulating a light curve from another light curve and a 1-d (time) or 2-d (time-energy) impulse response +* simulating an event list from a given light curve _and_ with a given energy spectrum * Good Time Interval operations -* power spectra in Leahy, rms normalization, absolute rms and no normalization -* averaged power spectra -* dynamical power spectra + +2. Fourier methods +~~~~~~~~~~~~~~~~~~ +* power spectra and cross spectra in Leahy, rms normalization, absolute rms and no normalization +* averaged power spectra and cross spectra +* dynamical power spectra and cross spectra * maximum likelihood fitting of periodograms/parametric models * (averaged) cross spectra * coherence, time lags -* cross correlation functions -* RMS spectra and lags (time vs energy, time vs frequency); *needs testing* +* Variability-Energy spectra, like covariance spectra and lags *needs testing* * covariance spectra; *needs testing* * bispectra; *needs testing* * (Bayesian) quasi-periodic oscillation searches -* simulating a light curve with a given power spectrum -* simulating a light curve from another light curve and a 1-d (time) or 2-d (time-energy) impulse response -* simulating an event list from a given light curve _and_ with a given energy spectrum +* Lomb-Scargle periodograms and cross spectra + +3. Other time series methods +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * pulsar searches with Epoch Folding, :math:`Z^2_n` test +* Gaussian Processes for QPO studies +* cross correlation functions Future Plans ------------