Merge pull request #328 from ercius/docstring_update

Docstring update
OpenChemistry · Jan 9, 2025 · 4314dce · 4314dce
2 parents 3cfabf3 + 4efaa97
commit 4314dce
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/python/stempy/image/__init__.py b/python/stempy/image/__init__.py
@@ -201,9 +201,10 @@ 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)). 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