Skip to content

Commit 676eceb

Browse files
committed
better docs
1 parent 8093fbd commit 676eceb

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

neo/rawio/spikeglxrawio.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -387,18 +387,20 @@ def parse_spikeglx_fname(fname):
387387
Consider the filenames: `Noise4Sam_g0_t0.nidq.bin` or `Noise4Sam_g0_t0.imec0.lf.bin`
388388
The filenames consist of 3 or 4 parts separated by `.`
389389
1. "Noise4Sam_g0_t0" will be the `name` variable. This choosen by the user at recording time.
390-
2. "_g0_" is the "gate_num"
391-
3. "_t0_" is the "trigger_num"
390+
2. "g0" is the "gate_num"
391+
3. "t0" is the "trigger_num"
392392
4. "nidq" or "imec0" will give the `device`
393393
5. "lf" or "ap" will be the `stream_kind`
394-
`stream_name` variable is the concatenation of `device.stream_kind`
394+
`stream_name` variable is the concatenation of `device.stream_kind`
395+
396+
If CatGT is used, then the trigger numbers in the file names ("t0"/"t1"/etc.)
397+
will be renamed to "tcat". In this case, the parsed "trigger_num" will be set to "cat".
395398
396399
This function is copied/modified from Graham Findlay.
397400
398401
Notes:
399-
* Sometimes the original file name is modified by the user and "_gt0_" or "_t0_"
402+
* Sometimes the original file name is modified by the user and "_g0_" or "_t0_"
400403
are manually removed. In that case gate_name and trigger_num will be None.
401-
* If tcat is used, then the trigger_num will be set to "cat".
402404
403405
Parameters
404406
---------
@@ -412,7 +414,7 @@ def parse_spikeglx_fname(fname):
412414
gate_num: int or None
413415
The gate identifier, e.g. 0.
414416
trigger_num: int | str or None
415-
The trigger identifier, e.g. 1. If tcat is used, then the trigger_num will be set to "cat".
417+
The trigger identifier, e.g. 1. If CatGT is used, then the trigger_num will be set to "cat".
416418
device: str
417419
The probe identifier, e.g. "imec2"
418420
stream_kind: str or None

0 commit comments

Comments
 (0)