update counting docstring for electron_count. Its best to use a np.nd…

…array.
ercius · Oct 3, 2024 · 6ec823e · 6ec823e
1 parent 3cfabf3
commit 6ec823e
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/python/stempy/image/__init__.py b/python/stempy/image/__init__.py
@@ -201,9 +201,9 @@ def electron_count(reader, darkreference=None, number_of_samples=40,
 
     :param reader: the file reader that has already opened the data.
     :type reader: stempy.io.reader
-    :param darkreference: the dark reference to subtract, potentially generated
-                          via stempy.image.calculate_average().
-    :type darkreference: stempy.image.ImageArray or stempy::Image<double>
+    :param darkreference: the dark reference to subtract. For an empty dark
+                              use np.zeros((Nx, Ny)).
+    :type darkreference: numpy.ndimage
     :param number_of_samples: the number of samples to take when calculating
                               the thresholds.
     :type number_of_samples: int