Skip to content

Commit 8e2ae26

Browse files
committed
Changing the docstring to reflect the units of tissue conductivity
1 parent 4e5ac69 commit 8e2ae26

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

KCSD.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -372,8 +372,8 @@ def __init__(self, ele_pos, pots, **kwargs):
372372
basis function type ('gauss', 'step', 'gauss_lim')
373373
Defaults to 'gauss'
374374
sigma : float
375-
space conductance of the medium
376-
Defaults to 1.
375+
space conductance of the tissue in S/m
376+
Defaults to 1 S/m
377377
n_src_init : int
378378
requested number of sources
379379
Defaults to 300
@@ -540,8 +540,8 @@ def __init__(self, ele_pos, pots, **kwargs):
540540
basis function type ('gauss', 'step', 'gauss_lim')
541541
Defaults to 'gauss'
542542
sigma : float
543-
space conductance of the medium
544-
Defaults to 1.
543+
space conductance of the tissue in S/m
544+
Defaults to 1 S/m
545545
n_src_init : int
546546
requested number of sources
547547
Defaults to 1000
@@ -718,10 +718,10 @@ def __init__(self, ele_pos, pots, **kwargs):
718718
basis function type ('gauss', 'step', 'gauss_lim')
719719
Defaults to 'gauss'
720720
sigma : float
721-
space conductance of the medium
722-
Defaults to 1.
721+
space conductance of the tissue in S/m
722+
Defaults to 1 S/m
723723
sigma_S : float
724-
conductance of the saline (medium)
724+
conductance of the saline (medium) in S/m
725725
Default is 5 S/m (5 times more conductive)
726726
n_src_init : int
727727
requested number of sources
@@ -841,8 +841,8 @@ def __init__(self, ele_pos, pots, **kwargs):
841841
basis function type ('gauss', 'step', 'gauss_lim')
842842
Defaults to 'gauss'
843843
sigma : float
844-
space conductance of the medium
845-
Defaults to 1.
844+
space conductance of the tissue in S/m
845+
Defaults to 1 S/m
846846
n_src_init : int
847847
requested number of sources
848848
Defaults to 1000

0 commit comments

Comments
 (0)