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.

Sign up for GitHub

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

Jump to bottom

Make Units.waveform_mean and Units.waveform_sd ragged #576

Merged
merged 2 commits into from
Apr 25, 2024
Merged

Make Units.waveform_mean and Units.waveform_sd ragged #576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eff94c
Make Units.waveform_mean and Units.waveform_sd ragged
rly Apr 25, 2024
160efa6
Update format_release_notes.rst
rly Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions core/nwb.misc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,13 @@ groups:
- - null
- null
- null
doc: Spike waveform mean for each spike unit.
doc: Spike waveform mean for each spike unit. The 'waveform_mean_index'
column indexes which waveforms in this column belong to a given unit, where each waveform
was recorded from a different electrode. The 'electrodes' column should be used to indicate which
electrodes are associated with each unit, and the order of the mean waveforms for a given unit
in the 'waveform_mean' dataset should be the same as the order of the electrodes referenced in
the 'electrodes' column of this table. The number of samples for each waveform mean must be the
same.
quantity: '?'
attributes:
- name: sampling_rate
Expand All @@ -254,6 +260,11 @@ groups:
value: volts
doc: Unit of measurement. This value is fixed to 'volts'.
required: false
- name: waveform_mean_index
neurodata_type_inc: VectorIndex
doc: Optional index into the 'waveform_mean' dataset to allow each unit to have a different number of mean
waveforms, one per electrode. See 'waveform_mean' for more details.
quantity: '?'
- name: waveform_sd
neurodata_type_inc: VectorData
dtype: float32
Expand All @@ -269,7 +280,13 @@ groups:
- - null
- null
- null
doc: Spike waveform standard deviation for each spike unit.
doc: Spike waveform standard deviation for each spike unit. The 'waveform_sd_index'
column indexes which waveforms in this column belong to a given unit, where each waveform
was recorded from a different electrode. The 'electrodes' column should be used to indicate which
electrodes are associated with each unit, and the order of the waveform standard deviations for a
given unit in the 'waveform_sd' dataset should be the same as the order of the electrodes referenced
in the 'electrodes' column of this table. The number of samples for each waveform standard deviation
must be the same.
quantity: '?'
attributes:
- name: sampling_rate
Expand All @@ -281,6 +298,11 @@ groups:
value: volts
doc: Unit of measurement. This value is fixed to 'volts'.
required: false
- name: waveform_sd_index
neurodata_type_inc: VectorIndex
doc: Optional index into the 'waveform_sd' dataset to allow each unit to have a different number of
waveform standard deviations, one per electrode. See 'waveform_sd' for more details.
quantity: '?'
- name: waveforms
neurodata_type_inc: VectorData
dtype: numeric
Expand All @@ -305,7 +327,7 @@ groups:
associated with a single waveform), then the 'waveforms_index' column will have values 1, 2, ..., N, where N is
the number of spike events. The number of electrodes for each spike event should be the same within a given unit.
The 'electrodes' column should be used to indicate which electrodes are associated with each unit, and the order
of the waveforms within a given unit x spike event should be in the same order as the electrodes referenced in
of the waveforms within a given unit x spike event should be the same as the order of the electrodes referenced in
the 'electrodes' column of this table. The number of samples for each waveform must be the same."
quantity: '?'
attributes:
Expand All @@ -320,10 +342,10 @@ groups:
required: false
- name: waveforms_index
neurodata_type_inc: VectorIndex
doc: Index into the waveforms dataset. One value for every spike event. See 'waveforms' for more detail.
doc: Index into the 'waveforms' dataset. One value for every spike event. See 'waveforms' for more detail.
quantity: '?'
- name: waveforms_index_index
neurodata_type_inc: VectorIndex
doc: Index into the waveforms_index dataset. One value for every unit (row in the table). See 'waveforms' for more
doc: Index into the 'waveforms_index' dataset. One value for every unit (row in the table). See 'waveforms' for more
detail.
quantity: '?'
5 changes: 5 additions & 0 deletions docs/format/source/format_release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ Release Notes
Minor changes
^^^^^^^^^^^^^
- Added support to set boundary metadata for ``SpatialSeries``. (#524)
- Added columns ``waveform_mean_index`` and ``waveform_sd_index`` to ``Units`` to make the ``waveform_mean`` and
``waveform_sd`` columns ragged. This allows for a different number of waveform means/SDs per unit which is useful
when each unit is associated with a different number of electrodes and there is a waveform mean/SD for each
electrode and unit. (#576)


2.7.0 (February 7, 2024)
------------------------
Expand Down
Loading