Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add waveform conversion factor and offset to schema #491

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

CodyCBakerPhD
Copy link
Contributor

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:

  • Update the version string in docs/format/source/conf.py, core/nwb.namespace.yaml, and /core/nwb.file.yaml
    to the next version with the suffix "-alpha"
  • Add a new section in the release notes for the new version with the date "Upcoming"
  • Add release notes for the PR to docs/format/source/format_release_notes.rst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant