Skip to content

Commit 2259bed

Browse files
rlyCodyCBakerPhD
andauthored
Improve get_data_in_units docstring (#1880)
* Improve get_data_in_units docstring * Update base.py --------- Co-authored-by: Cody Baker <[email protected]>
1 parent 9af54a2 commit 2259bed

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/pynwb/base.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,14 +343,17 @@ def get_data_in_units(self):
343343
.. math::
344344
out = data * conversion + offset
345345
346-
If the field 'channel_conversion' is present, the conversion factor is applied to each channel separately:
346+
If the field 'channel_conversion' is present, the conversion factor for each channel is additionally applied
347+
to each channel:
347348
348349
.. math::
349-
out_{channel} = data * conversion_{channel} + offset
350+
out_{channel} = data * conversion * conversion_{channel} + offset
351+
352+
NOTE: This will read the entire dataset into memory.
350353
351354
Returns
352355
-------
353-
np.ndarray
356+
:class:`numpy.ndarray`
354357
355358
"""
356359
if "channel_conversion" in self.fields:

0 commit comments

Comments
 (0)