Merge pull request #1410 from flatironinstitute/fix-docs

Fix docstrings important for seeded initialization
flatironinstitute · Oct 12, 2024 · ce2cb17 · ce2cb17
2 parents 3d1f3ed + cf0dd62
commit ce2cb17
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/caiman/source_extraction/cnmf/cnmf.py b/caiman/source_extraction/cnmf/cnmf.py
@@ -109,8 +109,8 @@ def __init__(self, n_processes, k=5, gSig=[4, 4], gSiz=None, merge_thresh=0.8, p
             p: int
                 order of the autoregressive process used to estimate deconvolution
 
-            Ain: ndarray
-                if know, it is the initial estimate of spatial filters
+            Ain: np.ndarray
+                if known, it is the initial estimate of spatial filters. Array must be of type `bool` in 'F' order of shape: [n_pixels, n_components]
 
             ssub: int
                 downsampleing factor in space

diff --git a/caiman/source_extraction/cnmf/estimates.py b/caiman/source_extraction/cnmf/estimates.py
@@ -36,7 +36,8 @@ def __init__(self, A=None, b=None, C=None, f=None, R=None, dims=None):
 
         Args:
             A:  scipy.sparse.csc_matrix (dimensions: # of pixels x # components)
-                set of spatial footprints. Each footprint is represented in a column of A, flattened with order = 'F'
+                set of spatial footprints. Each footprint is represented in a column of A, flattened with order = 'F'. 
+                Must be a np.ndarray of type `bool` if used for manual seeded initialization.
 
             C:  np.ndarray (dimensions: # of components x # of timesteps)
                 set of temporal traces (each row of C corresponds to a trace)