TrodesExtractionGUI/export-help.txt at master · nubs01/TrodesExtractionGUI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
exportLFP
--------------------------------------------------------
Used to extract LFP data from a raw rec file and save to individual files.
Usage:  exportLFP -rec INPUTFILENAME OPTION1 VALUE1 OPTION2 VALUE2 ...

Input arguments
Defaults:
 -outputrate 1500
 -highpass 0
 -lowpass 400
 -interp -1 (inf)
 -userefs 0
-oneperntrode <0 or 1> -- if 1 (default) only the LFP channel is used for each ntrode. Otherwise all channels are exported.

-rec <filename>  -- Recording filename. Required. Muliple -rec <filename> entries can be used to append data in output.
-v or -version -- Prints the current executable's version information to the terminal.
-highpass <integer> -- High pass filter value. Overrides settings in file.
-lowpass <integer> -- Low pass filter value. Overrides settings in file.
-outputrate <integer> -- Define the output sampling rate in the output file(s).
-interp <integer> -- Maximum number of dropped packets to interpolate.
-userefs <1 or 0> -- Whether or not to subtract digital references.
-usespikefilters <1 or 0> -- Whether or not to apply the spike filter settings in the file.
-output <basename> -- The base name for the output files. If not specified, the base name of the first .rec file is used.
-outputdirectory <directory> -- A root directory to extract output files to (default is directory of .rec file).
-reconfig <filename> -- Use a different workspace than the one embedded in the recording file.
-abortbaddata <1 or 0> -- Whether or not to abort export if data appears corrupted.
-paddingbytes <integer> -- Used to add extra bytes to the expected packet size if an override is required

--------------------------------------------------------
exportspikes
--------------------------------------------------------
Used to extract spike waveforms from a raw rec file and save to individual files for each nTrode.
Usage:  exportspikes -rec INPUTFILENAME OPTION1 VALUE1 OPTION2 VALUE2 ...

Input arguments
Defaults:
 -invert 1 -outputrate -1 (full sampling, can't be changed')
 -usespikefilters 1
 -interp 0
 -userefs 1


-invert <1 or 0> -- Whether or not to invert spikes to go upward

-rec <filename>  -- Recording filename. Required. Muliple -rec <filename> entries can be used to append data in output.
-v or -version -- Prints the current executable's version information to the terminal.
-highpass <integer> -- High pass filter value. Overrides settings in file.
-lowpass <integer> -- Low pass filter value. Overrides settings in file.
-outputrate <integer> -- Define the output sampling rate in the output file(s).
-interp <integer> -- Maximum number of dropped packets to interpolate.
-userefs <1 or 0> -- Whether or not to subtract digital references.
-usespikefilters <1 or 0> -- Whether or not to apply the spike filter settings in the file.
-output <basename> -- The base name for the output files. If not specified, the base name of the first .rec file is used.
-outputdirectory <directory> -- A root directory to extract output files to (default is directory of .rec file).
-reconfig <filename> -- Use a different workspace than the one embedded in the recording file.
-abortbaddata <1 or 0> -- Whether or not to abort export if data appears corrupted.
-paddingbytes <integer> -- Used to add extra bytes to the expected packet size if an override is required

--------------------------------------------------------
exporttime
--------------------------------------------------------
Used to extract continuous time periods from a raw rec file and save to binary file.
Usage:  exporttime -rec INPUTFILENAME OPTION1 VALUE1 OPTION2 VALUE2 ...

Input arguments
Defaults:
 -outputrate -1 (full sampling, can't be changed')
 -interp 500 (used to define breaks in continuous periods)


-rec <filename>  -- Recording filename. Required. Muliple -rec <filename> entries can be used to append data in output.
-v or -version -- Prints the current executable's version information to the terminal.
-highpass <integer> -- High pass filter value. Overrides settings in file.
-lowpass <integer> -- Low pass filter value. Overrides settings in file.
-outputrate <integer> -- Define the output sampling rate in the output file(s).
-interp <integer> -- Maximum number of dropped packets to interpolate.
-userefs <1 or 0> -- Whether or not to subtract digital references.
-usespikefilters <1 or 0> -- Whether or not to apply the spike filter settings in the file.
-output <basename> -- The base name for the output files. If not specified, the base name of the first .rec file is used.
-outputdirectory <directory> -- A root directory to extract output files to (default is directory of .rec file).
-reconfig <filename> -- Use a different workspace than the one embedded in the recording file.
-abortbaddata <1 or 0> -- Whether or not to abort export if data appears corrupted.
-paddingbytes <integer> -- Used to add extra bytes to the expected packet size if an override is required

--------------------------------------------------------
exportdio
--------------------------------------------------------
Used to extract digital I/O channels from a raw rec file and save to individual files for each channel.
Usage:  exportdio -rec INPUTFILENAME OPTION1 VALUE1 OPTION2 VALUE2 ...

Input arguments

-rec <filename>  -- Recording filename. Required. Muliple -rec <filename> entries can be used to append data in output.
-v or -version -- Prints the current executable's version information to the terminal.
-highpass <integer> -- High pass filter value. Overrides settings in file.
-lowpass <integer> -- Low pass filter value. Overrides settings in file.
-outputrate <integer> -- Define the output sampling rate in the output file(s).
-interp <integer> -- Maximum number of dropped packets to interpolate.
-userefs <1 or 0> -- Whether or not to subtract digital references.
-usespikefilters <1 or 0> -- Whether or not to apply the spike filter settings in the file.
-output <basename> -- The base name for the output files. If not specified, the base name of the first .rec file is used.
-outputdirectory <directory> -- A root directory to extract output files to (default is directory of .rec file).
-reconfig <filename> -- Use a different workspace than the one embedded in the recording file.
-abortbaddata <1 or 0> -- Whether or not to abort export if data appears corrupted.
-paddingbytes <integer> -- Used to add extra bytes to the expected packet size if an override is required

--------------------------------------------------------
exportmda
--------------------------------------------------------
Used to extract data from a raw rec file and save to a set of files in MDA format.
NOTE: FILTERING IS TURNED OFF.
Usage:  exportmda -rec INPUTFILENAME OPTION1 VALUE1 OPTION2 VALUE2 ...

Input arguments
Defaults:
 -outputrate -1 (full)
 -usespikefilters 1
 -interp -1 (inf)
 -userefs 1

-rec <filename>  -- Recording filename. Required. Muliple -rec <filename> entries can be used to append data in output.
-v or -version -- Prints the current executable's version information to the terminal.
-highpass <integer> -- High pass filter value. Overrides settings in file.
-lowpass <integer> -- Low pass filter value. Overrides settings in file.
-outputrate <integer> -- Define the output sampling rate in the output file(s).
-interp <integer> -- Maximum number of dropped packets to interpolate.
-userefs <1 or 0> -- Whether or not to subtract digital references.
-usespikefilters <1 or 0> -- Whether or not to apply the spike filter settings in the file.
-output <basename> -- The base name for the output files. If not specified, the base name of the first .rec file is used.
-outputdirectory <directory> -- A root directory to extract output files to (default is directory of .rec file).
-reconfig <filename> -- Use a different workspace than the one embedded in the recording file.
-abortbaddata <1 or 0> -- Whether or not to abort export if data appears corrupted.
-paddingbytes <integer> -- Used to add extra bytes to the expected packet size if an override is required

--------------------------------------------------------
exportphy
--------------------------------------------------------
Used to extract data from a raw rec file and save to a file for PHY file format.
Usage:  exportPHY -rec INPUTFILENAME OPTION1 VALUE1 OPTION2 VALUE2 ...

Input arguments
Defaults:
 -outputrate -1 (full)
 -usespikefilters 1
 -interp -1 (inf)
 -userefs 1

-rec <filename>  -- Recording filename. Required. Muliple -rec <filename> entries can be used to append data in output.
-v or -version -- Prints the current executable's version information to the terminal.
-highpass <integer> -- High pass filter value. Overrides settings in file.
-lowpass <integer> -- Low pass filter value. Overrides settings in file.
-outputrate <integer> -- Define the output sampling rate in the output file(s).
-interp <integer> -- Maximum number of dropped packets to interpolate.
-userefs <1 or 0> -- Whether or not to subtract digital references.
-usespikefilters <1 or 0> -- Whether or not to apply the spike filter settings in the file.
-output <basename> -- The base name for the output files. If not specified, the base name of the first .rec file is used.
-outputdirectory <directory> -- A root directory to extract output files to (default is directory of .rec file).
-reconfig <filename> -- Use a different workspace than the one embedded in the recording file.
-abortbaddata <1 or 0> -- Whether or not to abort export if data appears corrupted.
-paddingbytes <integer> -- Used to add extra bytes to the expected packet size if an override is required