Skip to content

Commit

Permalink
add wu-jung's suggestion for large docstring
Browse files Browse the repository at this point in the history
Co-authored-by: Wu-Jung Lee <[email protected]>
  • Loading branch information
ctuguinay and leewujung authored Apr 8, 2024
1 parent 04ad774 commit 955248e
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions echopype/mask/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,14 +269,17 @@ def apply_mask(
The code allows for these 3 cases of `source_ds` and `mask` dimensions:
1) No channel in both source ds and mask, but they have matching ping time and depth
dimensions.
2) Source ds and mask both have matching channel, ping time, and depth dimensions.
3) Source ds has channel dimension and mask doesn't, but they have matching ping
time and depth dimensions.
If a user only wants to apply masks to a subset of the channels in source ds,
they could put 1s/0s for all data in the channels that are not masked.
1) No channel in both `source_ds` and `mask`,
but they have matching `ping_time` and
`depth` (or `range_sample`) dimensions.
2) `source_ds` and `mask` both have matching `channel`,
`ping_time`, and `depth` (or `range_sample`) dimensions.
3) `source_ds` has the channel dimension and `mask` doesn't,
but they have matching
`ping_time` and `depth` (or `range_sample`) dimensions.
If a user only wants to apply masks to a subset of the channels in `source_ds`,
they could put 1s to allow all data entries in the other channels.
Parameters
----------
Expand Down

0 comments on commit 955248e

Please sign in to comment.