From 0ec129e99a6c41fe40dce99d6b4c4181fd81f408 Mon Sep 17 00:00:00 2001
From: David Keitel <david.keitel@ligo.org>
Date: Tue, 12 Dec 2017 11:06:39 +0000
Subject: [PATCH] ComputeFstat base class: explain t0Band, tauBand in docstring

---
 pyfstat/core.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/pyfstat/core.py b/pyfstat/core.py
index 9e0499e..441d506 100755
--- a/pyfstat/core.py
+++ b/pyfstat/core.py
@@ -355,6 +355,11 @@ class ComputeFstat(BaseSearchClass):
             allow for the Fstat to be computed over a transient range.
             ('none' instead of None explicitly calls the transient-window
             function, but with the full range, for debugging)
+        t0Band, tauBand: int
+            if >0, search t0 in (minStartTime,minStartTime+t0Band)
+                   and tau in (2*Tsft,2*Tsft+tauBand).
+            if =0, only compute CW Fstat with t0=minStartTime,
+                   tau=maxStartTime-minStartTime.
         detectors : str
             Two character reference to the data to use, specify None for no
             contraint. If multiple-separate by comma.
-- 
GitLab