Type should be ndarray (not ndimage). I also indicated the data will …

…be cast to np.float32.
OpenChemistry · Oct 3, 2024 · 4efaa97 · 4efaa97
1 parent 6ec823e
commit 4efaa97
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/python/stempy/image/__init__.py b/python/stempy/image/__init__.py
@@ -202,8 +202,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. For an empty dark
-                              use np.zeros((Nx, Ny)).
-    :type darkreference: numpy.ndimage
+                              use np.zeros((Nx, Ny)). Dtype will be cast to
+                              np.float32.
+    :type darkreference: numpy.ndarray
     :param number_of_samples: the number of samples to take when calculating
                               the thresholds.
     :type number_of_samples: int