User Reference:EDFFileWriter

From BCI2000 Wiki
Jump to: navigation, search

Contents

Function

The EDFFileWriter component writes out data in the EDF File Format.

Parameters

Common Data Storage Parameters

These are storage parameters common to all Data File Formats.

DataDirectory

Path to an existing directory. Recorded data will be stored below that directory. The path may be absolute, or relative to the source module's working directory at startup. Usually, the working directory at startup matches the source module's executable location in the prog directory.

SubjectName

A textual ID for the subject. This text will appear in session directories, and data file names.

SubjectSession

A textual ID for the current session. Sessions correspond to data directories. The path of a session directory is constructed according to

{DataDirectory}/{SubjectName}{SubjectSession}

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. Within a session directory, data file names are constructed according to

{SubjectName}S{SubjectSession}R{SubjectRun}

A data file's extension depends on its File Format.

ID_System, ID_Amp, ID_Montage

These parameters are provided for documentation purposes and may contain arbitrary text.

SavePrmFile

Determines whether a BCI2000 parameter file is saved along with the EDF file. As EDF cannot represent BCI2000 parameters, parameter information is lost if SavePrmFile is switched off. This parameter is optional, and will not appear in the parameter configuration dialog by default. To use it, specify --SavePrmFile=1 on the command line when starting up the source module.

EDFFileWriter Specific Parameters

SubjectYearOfBirth

Year the subject was born, in YYYY format.

SubjectSex

An enumerated value specifying the subject's sex:

  • 0: not specified,
  • 1: male,
  • 2: female.

TransducerType

A string describing the transducer (sensor) type, e.g. EEG: Ag/AgCl.

SignalUnit

A string specifying the physical unit of the calibrated signal. Differently from the notation used throughout the rest of BCI2000, this is usually "uV" rather than "muV".

EquipmentID

A string identifying the equipment provider.

LabID

A string identifying the recording laboratory.

TechnicianID

A string identifying the recording technician.

States

None.

See also

User Reference:DataIOFilter, User Reference:Data File Formats

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox