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

Update TimeIntervals.timeseries to use new TimeSeriesReferenceVectorData #486

Merged
merged 6 commits into from
Apr 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 1 addition & 14 deletions core/nwb.epoch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,7 @@ groups:
doc: Index for tags.
quantity: '?'
- name: timeseries
neurodata_type_inc: VectorData
dtype:
- name: idx_start
dtype: int32
doc: Start index into the TimeSeries 'data' and 'timestamp' datasets of the
referenced TimeSeries. The first dimension of those arrays is always time.
- name: count
dtype: int32
doc: Number of data samples available in this time series, during this epoch.
- name: timeseries
dtype:
target_type: TimeSeries
reftype: object
doc: the TimeSeries that this index applies to.
neurodata_type_inc: TimeSeriesReferenceVectorData
doc: An index into a TimeSeries object.
quantity: '?'
- name: timeseries_index
Expand Down
15 changes: 10 additions & 5 deletions docs/format/source/format_release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@ Release Notes
2.5.0 (Upcoming)
---------------------

Major changes
^^^^^^^^^^^^^
- Shape of SpatialSeries.data is more restrictive to prevent > 3 columns. (#510)

Minor changes
^^^^^^^^^^^^^
- Added an ``offset`` attribute to all ``TimeSeries`` objects to allow enhanced translation to scientific units.
- Updated ``TimeIntervals`` to use the new ``TimeSeriesReferenceVectorData`` type. This does not alter the overall structure
of ``TimeIntervals`` in a major way aside from changing the value of the ``neurodata_type`` attribute in the file
from ``VectorData`` to ```TimeSeriesReferenceVectorData``. This change replaces the existing ``TimeIntervals.timeseries``
column with a ``TimeSeriesReferenceVectorData`` type column of the same name and overall schema. This change facilitates creating
common functionality around ``TimeSeriesReferenceVectorData``. This change affects all existing ``TimeIntervals`` tables
as part of the ``intervals/`` group, i.e., ``intervals/epochs``, ``intervals/trials``, and ``intervals/invalid_times``. (#486)
- Clarified the doc string for the ``reference`` column of the electrodes table. (#498)
- Added ``cell_id`` field to ``IntracellularElectrode``. (#512)

Major changes
^^^^^^^^^^^^^
- Shape of SpatialSeries.data is more restrictive to prevent > 3 columns. (#510)


2.4.0 (Aug. 11, 2021)
---------------------

Expand Down