Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docstring update #328

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docstring update #328

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ec823e
update counting docstring for electron_count. Its best to use a np.nd…
Oct 3, 2024
4efaa97
Type should be ndarray (not ndimage). I also indicated the data will …
Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions python/stempy/image/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading