From d4b286d438c81c58683bf82fa58534fcd9811052 Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Fri, 8 Dec 2017 15:37:28 +0100
Subject: [PATCH] Update documentation
---
pyfstat/grid_based_searches.py | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/pyfstat/grid_based_searches.py b/pyfstat/grid_based_searches.py
index 4a38cba..dadb855 100644
--- a/pyfstat/grid_based_searches.py
+++ b/pyfstat/grid_based_searches.py
@@ -286,6 +286,16 @@ class GridSearch(BaseSearchClass):
return ax
def get_max_twoF(self):
+ """ Get the maximum twoF over the grid
+
+ Returns
+ -------
+ d: dict
+ Dictionary containing, 'minStartTime', 'maxStartTime', 'F0', 'F1',
+ 'F2', 'Alpha', 'Delta' and 'twoF' of maximum
+
+ """
+
twoF = self.data[:, -1]
idx = np.argmax(twoF)
v = self.data[idx, :]
--
GitLab