Skip to content

Commit 8e026c4

Browse files
committed
documentaiton updates
1 parent 86171ef commit 8e026c4

File tree

5 files changed

+10
-2
lines changed

5 files changed

+10
-2
lines changed
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

supereeg/brain.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,9 @@ def __next__(self):
237237
return s
238238

239239
def next(self):
240+
"""
241+
Return next sample from Brain object (wrapper for self.__next__)
242+
"""
240243
return self.__next__()
241244

242245
def update_filter_inds(self):

supereeg/nifti.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,10 +213,15 @@ def make_gif(self, gifpath, index=range(0, 10), name=None, **kwargs):
213213

214214

215215
def get_locs(self):
216+
"""
217+
Return locations of voxels
218+
"""
216219
bo = Brain(self)
217220
return bo.get_locs()
218221

219222

220223
def save(self, filepath):
221-
224+
"""
225+
Save file to disk
226+
"""
222227
self.to_filename(filepath)

supereeg/simulate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ def simulate_model_data(n_samples=1000, n_elecs=170, locs=None, sample_locs=None
137137
Noise added to simulation
138138
139139
set_random_seed : bool or int
140-
Default False. If True, set random seed to 123. If int, set random seed to value.
140+
Default False (choose a random seed). If True, set random seed to 123. If int, set random seed to the specified value.
141141
142142
Returns
143143
----------

0 commit comments

Comments
 (0)