Commit d4b286d4 authored by Gregory Ashton's avatar Gregory Ashton
Browse files

Update documentation

parent 5ccd2e3e
...@@ -286,6 +286,16 @@ class GridSearch(BaseSearchClass): ...@@ -286,6 +286,16 @@ class GridSearch(BaseSearchClass):
return ax return ax
def get_max_twoF(self): 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] twoF = self.data[:, -1]
idx = np.argmax(twoF) idx = np.argmax(twoF)
v = self.data[idx, :] v = self.data[idx, :]
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment