Skip to content

Improving documentation for resolution attribute in the Units table #666

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

Open
h-mayorquin wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Improving documentation for resolution attribute in the Units table #666

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
74346fa
Improve UnitsTable resolution docs
h-mayorquin Jan 20, 2026
1b63da7
Add PR number on release notes
h-mayorquin Jan 20, 2026
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
8 changes: 4 additions & 4 deletions core/nwb.misc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,10 @@ groups:
attributes:
- name: resolution
dtype: float64
doc: The smallest possible difference between two spike times. Usually 1 divided by the acquisition sampling rate
from which spike times were extracted, but could be larger if the acquisition time series was downsampled or
smaller if the acquisition time series was smoothed/interpolated and it is possible for the spike time to be
between samples.
doc: The temporal resolution of the spike times, in seconds. This is typically the sampling period (1/sampling_rate)
of the acquisition data from which spikes were extracted. Notes - (1) If the acquisition data was downsampled before
spike sorting, the resolution will be larger (coarser) than the original acquisition sampling period. (2) If
interpolation was applied during spike sorting, spike times may fall between samples of the acquisition data.
required: false
- name: obs_intervals_index
neurodata_type_inc: VectorIndex
Expand Down
2 changes: 2 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 @@ -12,6 +12,8 @@ Minor changes
that are typically used together for analysis, such as spike sorting. (#659)
- Specified that units for ``ElectrodesTable`` coordinate fields (``x``, ``y``, ``z``, ``rel_x``, ``rel_y``, ``rel_z``)
should be in microns. (#658)
- Improved documentation of ``Units.spike_times.resolution`` to clarify that it represents the temporal resolution
(sampling period) of the spike times. (#666)


2.9.0 (June 26, 2025)
Expand Down