Skip to content

Commit 36ab944

Browse files
committed
docs(ephys): add stream_id column documentation for channels.tsv
Document the stream_id column format for linking channels to their corresponding data streams. Include specifications for: - NWB files with internal HDF5 paths to ElectricalSeries objects - NIX files referencing data arrays following NIX/Neo organization - Handling multiple data streams with comma-separated lists - Cross-file references using filename:path syntax
1 parent 0957556 commit 36ab944

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/modality-specific-files/microelectrode-electrophysiology.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,24 @@ Columns in the `*_channels.tsv` file are:
215215

216216
{{ MACROS___make_columns_table("microephys.microephysChannels") }}
217217

218+
### The `stream_id` Column
219+
220+
The `stream_id` column links each channel to its corresponding data stream within the data file. The format of `stream_id` depends on the data file format:
221+
222+
**For NWB files (`.nwb`):**
223+
The `stream_id` SHOULD be the internal HDF5 path to the neurodata object (typically an `ElectricalSeries`) that contains the voltage recordings for that channel, for example `/acquisition/ElectricalSeries`.
224+
If no path is provided, it is assumed to be `/acquisition/ElectricalSeries`.
225+
If the directory contains multiple NWB files, and not all of those files contain data from the channel, the `stream_id` SHOULD include the filename(s) that do followed by a colon and the internal path, for example `sub-01_ses-01_run-02_ecephys.nwb:/acquisition/ElectricalSeries`.
226+
227+
**For NIX files (`.nix`):**
228+
The `stream_id` SHOULD reference the data array or signal within the NIX file structure that contains the recordings for that channel, following the NIX/Neo data organization.
229+
230+
**Multiple data streams:**
231+
If a single channel's data spans multiple neurodata objects within a file or across multiple files,
232+
the `stream_id` MUST be specified as a comma-separated list.
233+
For example: `/acquisition/ElectricalSeries1,/acquisition/ElectricalSeries2` or
234+
`file1.nwb:/acquisition/ElectricalSeries,file2.nwb:/acquisition/ElectricalSeries`.
235+
218236
### Example `*_channels.tsv`
219237

220238
**Extracellular electrophysiology example:**

0 commit comments

Comments
 (0)