Skip to content

Commit

Permalink
Fix get_expected_spectra() docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
tymorrow committed Dec 18, 2023
1 parent fdeb67c commit d7d36d1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions riid/data/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ def get_expected_spectra(seeds: np.ndarray, expected_counts: np.ndarray) -> np.n
- m = # of seeds
- n = # of channels
and the final dimension is added in order to facilitate proper broadcasting
and the final dimension is added in order to facilitate proper broadcasting.
The dimension of the `expected_counts` must be 1, but the length `p` can be
any positive number.
The resulting expected spectra will be of shape `(m x p, n)`.
This representings the same number of channels `n`, but each expected count
value, of which there were `p`, will be me multiplied through each seed spectrum,
of which there were `m`.
This represents the same number of channels `n`, but each expected count
value, of which there are `p`, will be me multiplied through each seed spectrum,
of which there are `m`.
All expected spectra matrices for each seed are then concatenated together
(stacked), eliminating the 3rd dimension.
"""
Expand Down

0 comments on commit d7d36d1

Please sign in to comment.