Add waveform conversion factor and offset to schema #491
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
Proposing the addition of conversion factors and offsets to waveform columns of a Units table.
For large amounts of recording data, even adding waveform snippets to the columns of a Units table can be a significant task. One step towards reducing unnecessary data inflation is to add attributes for scaling factors similar to the behavior of other TimeSeries-like objects that allow the data to be stored in some minimal base type, while the conversion factor then scales it into the specified scientific units.
I've added these attributes and attempted to propagate them through the IO, mirroring the patterns established by the waveform_rate attribute.
Sister PR: NeurodataWithoutBorders/pynwb#1422
PR checklist for schema changes
To-Do:
docs/format/source/conf.py
,core/nwb.namespace.yaml
, and/core/nwb.file.yaml
to the next version with the suffix "-alpha"
docs/format/source/format_release_notes.rst