Skip to content

Commit 51b4b54

Browse files
h-mayorquinclauderly
authored
Improving documentation for resolution attribute in the Units table (#666)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Ryan Ly <310197+rly@users.noreply.github.com>
1 parent a6b23f0 commit 51b4b54

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

core/nwb.misc.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,10 +199,11 @@ groups:
199199
attributes:
200200
- name: resolution
201201
dtype: float64
202-
doc: The smallest possible difference between two spike times. Usually 1 divided by the acquisition sampling rate
203-
from which spike times were extracted, but could be larger if the acquisition time series was downsampled or
204-
smaller if the acquisition time series was smoothed/interpolated and it is possible for the spike time to be
205-
between samples.
202+
doc: The temporal resolution of the spike times, in seconds. This is typically the sampling period (1/sampling_rate)
203+
of the acquisition data from which spikes were extracted. If the acquisition data was downsampled before
204+
spike sorting, the resolution should be based on the downsampled sampling rate (lower sampling rate, larger resolution value). If interpolation
205+
was applied during spike sorting, then spike times may fall between samples of the acquisition data, so the
206+
resolution should be the interpolation step size (higher sampling rate, smaller resolution value).
206207
required: false
207208
- name: obs_intervals_index
208209
neurodata_type_inc: VectorIndex

docs/format/source/format_release_notes.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ Minor changes
1616
that are typically used together for analysis, such as spike sorting. (#659)
1717
- Specified that units for ``ElectrodesTable`` coordinate fields (``x``, ``y``, ``z``, ``rel_x``, ``rel_y``, ``rel_z``)
1818
should be in microns. (#658)
19-
- Expanded documentation for the ``Subject`` 'age' dataset, including details on ISO 8601 Duration format and
19+
- Expanded documentation for the ``Subject`` 'age' dataset, including details on ISO 8601 Duration format and
2020
age range representation.
21+
- Improved documentation of ``Units.spike_times.resolution`` to clarify that it represents the temporal resolution
22+
(sampling period) of the spike times. (#666)
2123

2224
2.9.0 (June 26, 2025)
2325
---------------------

0 commit comments

Comments
 (0)