AnyWave:ADES

From WikiMEG
Revision as of 10:00, 19 February 2014 by Bruno (Talk | contribs)

Jump to: navigation, search

ADES stands for AnyWave DEScriptive format.

ADES format is composed of at least two files but a third file can be used for markers.

The most important file is the header file for which extension is .ades

The header file (.ades)

This is a text file using a very simple syntax. Let's have a look:

  1. #ADES header file
  2. samplingRate = 1000
  3. numberOfSamples = 4000
  4. A1 = EEG
  5. A2 = EEG
  6. A3 = EEG

Line 1 begins with # which is the starting character for comments. However, this first line is mandatory and defines the header file as ADES header.</br> The next line defines the sampling rate of the data. This parameter is mandatory and must be expressed in Hertz.
Third line defines the total number of samples per channel in the data file.
The following lines describe the channels present in the data file. In our example, there are 3 channels, A1, A2, A3.
The channels are defined to be EEG channels but could be defined as SEEG, MEG, EMG, ECG, or even Trigger.
It is also possible to omit the channel's type. AnyWave will consider channels as EEG by default in that case.
That's all for the header file, a very simple syntax.

The data file (.dat)

Data are stored in a binary file which name is exactly the same than the header file except the extension: .dat

Samples are stored as float, 32bits little endian. The channels are multiplexed.

The marker file (.mrk)

It is possible to have a third optional file describing markers in the data. This file is an AnyWave marker file. The name must be the same than the header file but with extension .mrk

This is a text file with a simple format:

  1. // AnyWave Marker File
  2. Start	-1	0.957031
  3. Section	-1	0.960938	2
  4. Marker1	-1	150.957
  5. CRISE	-1	213.023
  6. Marker2	-1	300.957
  7. Marker3	-1	450.957
  8. Marker4	-1	578.707
  9. ?	-1	600.957
  10. END	-1	621.582

The first line must be // AnyWave Marker File. AnyWave will then recognize the file as a marker file.
Next come the markers, one marker by line.
Attributes must be separated by tabulations.
The first attribute is the label of the marker.
The second attribute is the integer value associated with the marker. -1 means that there is no value.
The third attribute is the position in seconds, from the begining of the data file.
There is a optional fourth parameter: the duration in seconds.
The duration attribute is only necessary to define markers of type Selection in AnyWave. Those are markers which mark a segment of data.

In our example, we have a total of 9 markers. One of them is a Selection marker, called Section and has a duration of 2 seconds. The first marker is called Start and the last one is called END.
Depending on the acquisition system used to record data or if the file was exported by AnyWave, markers can have different labels.

Building your own ADES file

It is quite simple to build a ADES file from Matlab for example. Suppose you have data stored as a Matlab matrix, writing a Matlab function to export the data as ADES format is not very difficult.

Here is a Matlab function that will export to ADES format:

function mat2awv(data,fileName,FS,labels,labelType) 
 
% write in the current folder ADES and DAT files from matrix in MATLAB workspace
% data = matrix of data (nbchannel * time points) - the data have to be in
% microVolt
% fileName = string of the output files without extension ; the ades and
% dat files will have the same name
% FS = sampling rate 
% labels = cell array with channel labels
% labelType : 'EEG' or 'MEG'
% Sophie Chen - January 2014
 
%% generate the ADES file
adesFile = [fileName '.ades'];
 
fid = fopen(adesFile,'w');
 
fprintf(fid,'%s\r\n','#ADES header file ');
fprintf(fid,'%s','samplingRate = ');
fprintf(fid,'%d\r\n',FS);
fprintf(fid,'%s','numberOfSamples = ');
fprintf(fid,'%d\r\n',size(data,2));
 
for lab = 1:length(labels)
    fprintf(fid,'%s\r\n',[labels{lab} ' = ' labelType]);
end
 
fclose(fid);
 
%% generate the DAT file
 
datFile = [fileName '.dat'];
 
fad = fopen(datFile,'wb');
fwrite(fad, data, 'float32');
fclose(fad);
end