Add doc on dt

StingraySoftware · Nov 14, 2023 · f28c8ce · f28c8ce
1 parent f2ad54c
commit f28c8ce
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/stingray/crossspectrum.py b/stingray/crossspectrum.py
@@ -1899,11 +1899,12 @@ class DynamicalCrossspectrum(AveragedCrossspectrum):
     ----------
     data1 : :class:`stingray.Lightcurve` or :class:`stingray.EventList` object
         The time series or event list from the subject band, or channel, for which
-        the dynamical cross spectrum is to be calculated.
+        the dynamical cross spectrum is to be calculated. If :class:`stingray.EventList`, ``dt``
+        must be specified as well.
 
     data2 : :class:`stingray.Lightcurve` or :class:`stingray.EventList` object
         The time series or event list from the reference band, or channel, of the dynamical
-        cross spectrum.
+        cross spectrum. If :class:`stingray.EventList`, ``dt`` must be specified as well.
 
     segment_size : float, default 1
          Length of the segment of light curve, default value is 1 (in whatever
@@ -1922,6 +1923,11 @@ class DynamicalCrossspectrum(AveragedCrossspectrum):
         use this and only give GTIs to the input object before making
         the cross spectrum.
 
+    dt: float
+        Compulsory for input :class:`stingray.EventList` data. The time resolution of the
+        lightcurve that is  created internally from the input event lists. Drives the
+        Nyquist frequency.
+
     Attributes
     ----------
     segment_size: float

diff --git a/stingray/powerspectrum.py b/stingray/powerspectrum.py
@@ -900,7 +900,7 @@ class DynamicalPowerspectrum(DynamicalCrossspectrum):
     ----------
     lc : :class:`stingray.Lightcurve` or :class:`stingray.EventList` object
         The time series or event list of which the dynamical power spectrum is
-        to be calculated.
+        to be calculated. If :class:`stingray.EventList`, ``dt`` must be specified as well.
 
     segment_size : float, default 1
          Length of the segment of light curve, default value is 1 (in whatever
@@ -919,6 +919,11 @@ class DynamicalPowerspectrum(DynamicalCrossspectrum):
         use this and only give GTIs to the input object before making
         the power spectrum.
 
+    dt: float
+        Compulsory for input :class:`stingray.EventList` data. The time resolution of the
+        lightcurve that is created internally from the input event lists. Drives the
+        Nyquist frequency.
+
     Attributes
     ----------
     segment_size: float