Summary
The data-to-volts conversion formula is described inconsistently across two fields of ElectricalSeries in nwb.ecephys.yaml.
Current state
ElectricalSeries.data → unit attribute doc:
"To access the data in these units, multiply 'data' by 'conversion', followed by 'channel_conversion' (if present), and then add 'offset'."
Full formula: data * conversion * channel_conversion + offset
ElectricalSeries.channel_conversion doc:
"…data in Volts = data * data.conversion * channel_conversion"
Formula: data * data.conversion * channel_conversion — offset is missing.
Impact
A reader consulting only the channel_conversion doc would not know that offset is part of the pipeline and could implement the conversion incorrectly.
Proposed fix
Update the channel_conversion doc to include offset in both prose and the inline equation, e.g.:
"…data in Volts = data * data.conversion * channel_conversion + data.offset"
Both fields should use the same canonical formula notation.
Summary
The data-to-volts conversion formula is described inconsistently across two fields of
ElectricalSeriesinnwb.ecephys.yaml.Current state
ElectricalSeries.data→unitattribute doc:Full formula:
data * conversion * channel_conversion + offsetElectricalSeries.channel_conversiondoc:Formula:
data * data.conversion * channel_conversion— offset is missing.Impact
A reader consulting only the
channel_conversiondoc would not know thatoffsetis part of the pipeline and could implement the conversion incorrectly.Proposed fix
Update the
channel_conversiondoc to include offset in both prose and the inline equation, e.g.:Both fields should use the same canonical formula notation.