Skip to content

Commit

Permalink
Revert "update counting docstring for electron_count. Its best to use…
Browse files Browse the repository at this point in the history
… a np.ndarray." I meant to add this to a feature branch.

This reverts commit 6ec823e.
  • Loading branch information
Peter Ercius ncem-gauss jupyter committed Oct 3, 2024
1 parent 6ec823e commit 415f878
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions python/stempy/image/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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. For an empty dark
use np.zeros((Nx, Ny)).
:type darkreference: numpy.ndimage
:param darkreference: the dark reference to subtract, potentially generated
via stempy.image.calculate_average().
:type darkreference: stempy.image.ImageArray or stempy::Image<double>
:param number_of_samples: the number of samples to take when calculating
the thresholds.
:type number_of_samples: int
Expand Down

0 comments on commit 415f878

Please sign in to comment.