From 8e026c43e08d058e494efb79e19b1f26465a9809 Mon Sep 17 00:00:00 2001 From: lucy Date: Fri, 27 Jul 2018 16:52:16 -0400 Subject: [PATCH] documentaiton updates --- docs/auto_examples/auto_examples_jupyter.zip | Bin 51246 -> 51246 bytes docs/auto_examples/auto_examples_python.zip | Bin 33445 -> 33445 bytes supereeg/brain.py | 3 +++ supereeg/nifti.py | 7 ++++++- supereeg/simulate.py | 2 +- 5 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/auto_examples/auto_examples_jupyter.zip b/docs/auto_examples/auto_examples_jupyter.zip index 7fa044c6f6fc12aabda67b847ea760df0306d987..435d1b7cea42ff78271f82341f011596883fc776 100644 GIT binary patch delta 121 zcmZ2CfqC5oW}X0VW)=|!5Rhow$n(XKNuq5tlhbWB5PjdHl>K>p;$!}cKR&|w!4#c{+6M7bOR@iuoIk!1#PS01+oQ7?|W0RTdKDq8>m delta 121 zcmZ2CfqC5oW}X0VW)=|!5D047$n(XKDX3*LlhbWB5PjdHl>K>p;$!}cKR&|w!4#c{+6M7bOR@iuoIk!1#PS01+oQ7?|W0RZUNEo%S( diff --git a/docs/auto_examples/auto_examples_python.zip b/docs/auto_examples/auto_examples_python.zip index 0c1f3856986b4186a000530dd7f0ba8fe554463d..0773bd882beb7241cf48003ff374bb874a5cedce 100644 GIT binary patch delta 285 zcmZ45%CxkVi6_9DnMH&F1SHxv^3>ZfNwjV5wUJ^5(JSqbvw-L#7e!7GJ=Is12}E!4 zmjlaR2|5bq&ki*J^Up?X0rQ)qw=sg$S;zK)#ZM>XfWu% rG`NDO{06X+^$nIF-YW>D+Gq{pB{kZEsKpTKNh8=4wI;Ckq$XzovC>@Z delta 285 zcmZ45%CxkVi6_9DnMH&F1cF*N^3>Zf1+{GMwUJ^5(JSqbvw-L#7e!7GJ=Is12}E!4 zmjlaR2|5bq&ki*J^Up?X0rQ)qw=sg$S;zK)#ZM>XfWu% rG`NDO{06X+^$nIF-YW>D+Gq{pB{kZEsKpTKNh8=4wI;Ckq$Xzo%XVbU diff --git a/supereeg/brain.py b/supereeg/brain.py index d3b7325..14f4382 100644 --- a/supereeg/brain.py +++ b/supereeg/brain.py @@ -237,6 +237,9 @@ def __next__(self): return s def next(self): + """ + Return next sample from Brain object (wrapper for self.__next__) + """ return self.__next__() def update_filter_inds(self): diff --git a/supereeg/nifti.py b/supereeg/nifti.py index 0a75ae0..aa30493 100644 --- a/supereeg/nifti.py +++ b/supereeg/nifti.py @@ -213,10 +213,15 @@ def make_gif(self, gifpath, index=range(0, 10), name=None, **kwargs): def get_locs(self): + """ + Return locations of voxels + """ bo = Brain(self) return bo.get_locs() def save(self, filepath): - + """ + Save file to disk + """ self.to_filename(filepath) diff --git a/supereeg/simulate.py b/supereeg/simulate.py index 0efe431..02bb2da 100644 --- a/supereeg/simulate.py +++ b/supereeg/simulate.py @@ -137,7 +137,7 @@ def simulate_model_data(n_samples=1000, n_elecs=170, locs=None, sample_locs=None Noise added to simulation set_random_seed : bool or int - Default False. If True, set random seed to 123. If int, set random seed to value. + Default False (choose a random seed). If True, set random seed to 123. If int, set random seed to the specified value. Returns ----------