Template:StorageParams - Revision history

Mellinger: /* name */

2026-03-12T16:47:40Z

name

← Older revision		Revision as of 16:47, 12 March 2026
Line 64:		Line 64:

	=====name=====		=====name=====
	A ~~nonempty name~~ string that ~~uniquely~~ identifies the output file.		A string that identifies the output file.
	When constructing a file name, that string is appended to the run's base name.		When constructing a file name, that string is appended to the run's base name.
	''Example:'' When "name" is "EEG", and the primary output file's name is "Wilbur001Run02.dat", then the secondary file name will be "Wilbur001R02.EEG.dat".		''Example:'' When "name" is "EEG", and the primary output file's name is "Wilbur001Run02.dat", then the secondary file name will be "Wilbur001R02.EEG.dat".
			=====prefix=====
			A string that is prepended to the output file name, separated with a dot.
			This may be used alternatively, or in conjunction with "name". The combination of "prefix" and "name" must uniquely identify the output file.

	=====channels=====		=====channels=====

Mellinger: /* decimation */

2024-11-23T10:31:29Z

decimation

← Older revision		Revision as of 10:31, 23 November 2024
Line 72:		Line 72:

	=====decimation=====		=====decimation=====
	An optional integer decimation factor used to downsample the secondary output file's data. Before downsampling, a 3rd order IIR filter is applied to avoid aliasing artifacts. Note that the decimation factor must also be a divisor of the SampleBlockSize.		An optional integer decimation factor used to downsample the secondary output file's data. Before downsampling, a 3rd order IIR filter is applied to avoid aliasing artifacts. Note that the decimation factor must also be a divisor of the [[User Reference:DataIOFilter#SampleBlockSize\|sample block size]].

Mellinger: /* channels */

2024-11-23T10:28:18Z

channels

← Older revision		Revision as of 10:28, 23 November 2024
Line 69:		Line 69:

	=====channels=====		=====channels=====
	A channel list as described for ~~PrimaryChannelList~~ above.		A channel list as described for PrimaryOutputChannels above.

	=====decimation=====		=====decimation=====
	An optional integer decimation factor used to downsample the secondary output file's data. Before downsampling, a 3rd order IIR filter is applied to avoid aliasing artifacts. Note that the decimation factor must also be a divisor of the SampleBlockSize.		An optional integer decimation factor used to downsample the secondary output file's data. Before downsampling, a 3rd order IIR filter is applied to avoid aliasing artifacts. Note that the decimation factor must also be a divisor of the SampleBlockSize.

Mellinger: /* FileSplittingCondition */

2024-11-23T10:27:57Z

FileSplittingCondition

← Older revision		Revision as of 10:27, 23 November 2024
Line 45:		Line 45:

	By default, the ''FileSplittingCondition'' parameter is empty, i.e. no file splitting occurs.		By default, the ''FileSplittingCondition'' parameter is empty, i.e. no file splitting occurs.

			====PrimaryOutputChannels====
			List of channels stored into the primary output file (see SecondaryOutputFiles below).
			Channel names may contain * and ? wildcards, and character ranges enclosed in []; wildcard patterns may be negated by prepending an exclamation mark.
			Ranges of channels may be specified using : or - to separate begin from end.

			By default, this is set to "*", indicating that all channels should be recorded.

			''Examples:''
			1-8 // the first 8 channels
			1-8 !4 // the first 8 channels except the 4th
			EEG* // wildcard pattern that matches all channels beginnning with "EEG"
			MCQ01-MCQ23 // range of channels by name

			====SecondaryOutputFiles====
			A matrix where each row corresponds to a secondary output file.
			Columns are:

			=====name=====
			A nonempty name string that uniquely identifies the output file.
			When constructing a file name, that string is appended to the run's base name.
			''Example:'' When "name" is "EEG", and the primary output file's name is "Wilbur001Run02.dat", then the secondary file name will be "Wilbur001R02.EEG.dat".

			=====channels=====
			A channel list as described for PrimaryChannelList above.

			=====decimation=====
			An optional integer decimation factor used to downsample the secondary output file's data. Before downsampling, a 3rd order IIR filter is applied to avoid aliasing artifacts. Note that the decimation factor must also be a divisor of the SampleBlockSize.

Mellinger: /* ID_System, ID_Amp, ID_Montage */

2023-03-28T17:23:17Z

ID_System, ID_Amp, ID_Montage

← Older revision		Revision as of 17:23, 28 March 2023
Line 35:		Line 35:
	====ID_System, ID_Amp, ID_Montage====		====ID_System, ID_Amp, ID_Montage====
	These parameters are provided for documentation purposes and may contain arbitrary text.		These parameters are provided for documentation purposes and may contain arbitrary text.

			====FileSplittingCondition====
			While recording, recorded files may be split into multiple files with '''part2, part3, ... partN''' appended to the file name (before the extension). The first file will not be renamed to '''part1''', though.
			When a condition is entered into the ''FileSplittingCondition'' parameter, it will be evaluated after each block of data has been written. Each time the condition is fulfilled, the old file will be closed, and a new one will be opened. Each partial file will be a valid file in the chosen ''FileWriter's'' format in its own right; only file names will carry information about how files should be combined to result in the full run file.

			Conditions are simple strings representing either
			* a temporal duration, e.g. 00:00:30 for a duration of 30 seconds, or
			* a file size, e.g. 1.5MB for a size of 1.5 megabytes. Units of kB, MB, GB, TB and kiB, MiB, GiB, and TiB are supported. Prefixes without the ''i'' will refer to powers of 1000, whereas prefixes with an ''i'' refer to powers of 1024.

			By default, the ''FileSplittingCondition'' parameter is empty, i.e. no file splitting occurs.

Mellinger: /* DataFile */

2022-09-19T16:46:52Z

DataFile

← Older revision		Revision as of 16:46, 19 September 2022
Line 14:		Line 14:
	the <tt>${SubjectRun}</tt> parameter along with the session number, and a date.		the <tt>${SubjectRun}</tt> parameter along with the session number, and a date.

	Date variables: The user can introduce date and/or time into the file name. One ~~can~~ enter <tt>${D}<~~/tt>, <tt~~>~~${M~~}</tt>,		Date variables: The user can introduce date and/or time into the file name. One may enter <tt>${DateTime:<format string>}</tt> to add date and/or time in an arbitrary format. <tt><format string></tt> must be a date-time format string as defined for the [https://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html POSIX strftime() function]. For example, <tt>${DateTime:%F}</tt> will produce the date in the standard format YYYY-MM-DD. Be careful with time formats which will typically contain the : character, which is illegal in Windows file names. To produce both date and time, use <tt>${DateTime:%F-%H-%M-%S}</tt>.
	<tt>~~${Y}~~<~~/tt~~>, <tt>~~${H}<~~/~~tt>~~, <tt>${M}</tt>, and <tt>${S}</tt> ~~in any order to add date and/or time in an arbitrary format~~.
	'''NOTE:''' When the file name contains both a run number, and a date/time string, auto-incrementing the run number will not work properly. Auto-incrementing the run number depends on all other components of the file name being constant, which is not the case for		'''NOTE:''' When the file name contains both a run number, and a date/time string, auto-incrementing the run number will not work properly. Auto-incrementing the run number depends on all other components of the file name being constant, which is not the case for
	date and time.		date and time.

Mellinger: /* DataFile */

2022-08-02T14:55:52Z

DataFile

← Older revision		Revision as of 14:55, 2 August 2022
Line 14:		Line 14:
	the <tt>${SubjectRun}</tt> parameter along with the session number, and a date.		the <tt>${SubjectRun}</tt> parameter along with the session number, and a date.

	Date ~~String~~: The user can ~~alter the~~ date ~~string to reformat it in~~ the file name. One can enter <tt>${D}</tt>, <tt>${M}</tt>, and <tt>${Y}</tt> in any order to ~~append the~~ date in an arbitrary format.		Date variables: The user can introduce date and/or time into the file name. One can enter <tt>${D}</tt>, <tt>${M}</tt>,
			<tt>${Y}</tt>, <tt>${H}</tt>, <tt>${M}</tt>, and <tt>${S}</tt> in any order to add date and/or time in an arbitrary format.
			'''NOTE:''' When the file name contains both a run number, and a date/time string, auto-incrementing the run number will not work properly. Auto-incrementing the run number depends on all other components of the file name being constant, which is not the case for
			date and time.

	====SubjectName====		====SubjectName====

Mellinger: /* SubjectRun */

2022-08-02T14:48:09Z

SubjectRun

← Older revision		Revision as of 14:48, 2 August 2022
Line 27:		Line 27:
	A number indicating the current run. Runs correspond to data files. To avoid accidental loss of data, run numbers are auto-incremented to the largest unused value.		A number indicating the current run. Runs correspond to data files. To avoid accidental loss of data, run numbers are auto-incremented to the largest unused value.
	Within a session directory, data file names are by default constructed according to		Within a session directory, data file names are by default constructed according to
	${SubjectName}S${SubjectSession}R${SubjectRun~~}_${D}-${M}-${Y~~}.${FileFormat}		${SubjectName}S${SubjectSession}R${SubjectRun}.${FileFormat}
	By default, a data file's extension depends on its [[User Reference:Data File Formats\|File Format]].		By default, a data file's extension depends on its [[User Reference:Data File Formats\|File Format]].

	====ID_System, ID_Amp, ID_Montage====		====ID_System, ID_Amp, ID_Montage====
	These parameters are provided for documentation purposes and may contain arbitrary text.		These parameters are provided for documentation purposes and may contain arbitrary text.

Mellinger: /* SubjectRun */

2022-07-22T12:25:14Z

SubjectRun

← Older revision		Revision as of 12:25, 22 July 2022
Line 26:		Line 26:
	====SubjectRun====		====SubjectRun====
	A number indicating the current run. Runs correspond to data files. To avoid accidental loss of data, run numbers are auto-incremented to the largest unused value.		A number indicating the current run. Runs correspond to data files. To avoid accidental loss of data, run numbers are auto-incremented to the largest unused value.
	Within a session directory, data file names are constructed according to		Within a session directory, data file names are by default constructed according to
	{SubjectName}S{SubjectSession}R{SubjectRun}		${SubjectName}S${SubjectSession}R${SubjectRun}_${D}-${M}-${Y}.${FileFormat}
	A data file's extension depends on its [[User Reference:Data File Formats\|File Format]].		By default, a data file's extension depends on its [[User Reference:Data File Formats\|File Format]].

	====ID_System, ID_Amp, ID_Montage====		====ID_System, ID_Amp, ID_Montage====
	These parameters are provided for documentation purposes and may contain arbitrary text.		These parameters are provided for documentation purposes and may contain arbitrary text.

Mellinger: /* SubjectSession */

2022-07-22T12:17:18Z

SubjectSession

← Older revision		Revision as of 12:17, 22 July 2022
Line 21:		Line 21:
	====SubjectSession====		====SubjectSession====
	A textual ID for the current session. Sessions correspond to data directories.		A textual ID for the current session. Sessions correspond to data directories.
	~~The~~ path of a session directory is constructed according to		By default, the path of a session directory is constructed according to
	{DataDirectory}/{SubjectName}{SubjectSession}		${DataDirectory}/${SubjectName}${SubjectSession}

	====SubjectRun====		====SubjectRun====