| 1 |
.TH edfhed 1 "@build_date@" @VERSION@ "Aghermann" |
| 2 |
.SH NAME |
| 3 |
edfhed -- EDF header dumper/editor. |
| 4 |
.SH SYNOPSIS |
| 5 |
edfhed [OPTIONS] \fIFILE.edf\fR ... |
| 6 |
.B |
| 7 |
.PP |
| 8 |
.SH DESCRIPTION |
| 9 |
.PP |
| 10 |
\fBedfhed\fR is a terminal program to view the header of EDF files |
| 11 |
(with option \fB\-b\fR, or without any options), or modify fields in |
| 12 |
the header (see options \fB\-s\fR, \fB\-T\fR and \fB\-R\fR). |
| 13 |
.TP |
| 14 |
\fB\-b\fR, \fB\-\-no\-channels\fR |
| 15 |
Only dump general header fields (no channel details). |
| 16 |
.TP |
| 17 |
\fB\-a\fR, \fB\-\-with\-annotations\fR |
| 18 |
List embedded annotations if any. |
| 19 |
.TP |
| 20 |
\fB\-R\fR, \fB\-\-from\-tree\fR |
| 21 |
Given file location \(oqSubject/Session/Episode.edf\(cq, set \fBrecording_id\fR to |
| 22 |
\(oqSession/Episode\(cq and \fBpatient_id\fR to \(oqSubject\(cq. |
| 23 |
.TP |
| 24 |
\fB\-T\fR, \fB\-\-from\-mtime\fR |
| 25 |
Set \fBrecording_date\fR and \fBrecording_time\fR fields to file |
| 26 |
modification date/time. |
| 27 |
.TP |
| 28 |
\fB\-t\fR, \fB\-\-touch\-mtime\fR |
| 29 |
Set file mtime to timestamp assembled from \fBrecording_date\fR and |
| 30 |
\fBrecording_time\fR fields (assuming local timezone). |
| 31 |
.TP |
| 32 |
\fB\-s\fR, \fB\-\-set\fR=[CH:]FIELD:VALUE |
| 33 |
Set FIELD to VALUE (in channel CH if specified, as a 1-based integer index). |
| 34 |
|
| 35 |
Possible general fields are: \fBversion_number\fR, \fBpatient_id\fR, |
| 36 |
\fBrecording_id\fR, \fBrecording_date\fR, \fBrecording_time\fR, |
| 37 |
\fBreserved\fR (remember that the contents of this field is |
| 38 |
significant wrt EDF/EDF+ distinction). |
| 39 |
|
| 40 |
The \fBversion_number\fR field must match the string "0\ \ \ \ \ \ |
| 41 |
\ " for the file to be recognised as a valid EDF by edfhed. |
| 42 |
|
| 43 |
Channel fields: \fBlabel\fR, \fBtransducer_type\fR, \fBphysical_dim\fR, |
| 44 |
\fBphysical_min\fR, \fBphysical_max\fR, \fBdigital_min\fR, \fBdigital_max\fR, |
| 45 |
\fBfiltering_info\fR, \fBreserved\fR. |
| 46 |
|
| 47 |
Direct field assignment done via \fB\-\-set\fR option(s) will override any |
| 48 |
assignments effected by options \fB\-T\fR or \fB\-R\fR. |
| 49 |
.TP |
| 50 |
\fB\-?, \-\-help\fR |
| 51 |
Give a brief options summary. |
| 52 |
.TP |
| 53 |
\fB\-\-usage\fR |
| 54 |
Display usage information. |
| 55 |
.TP |
| 56 |
\fB\-V, \-\-version\fR |
| 57 |
Display version. |
| 58 |
.SH USE WITH AGHERMANN |
| 59 |
.PP |
| 60 |
For Aghermann to be able to manage an EDF file, all relevant fields in |
| 61 |
its header must be filled out correctly, as follows: |
| 62 |
.IP \(bu |
| 63 |
\fBpatient_id\fR uniquely identifies the subject; |
| 64 |
.IP \(bu |
| 65 |
\fBrecording_id\fR identifies the recording session (out of several |
| 66 |
other such sessions, each containing the same series of episodes) and |
| 67 |
the individual episode. These two items must appear in one of the |
| 68 |
following combinations: |
| 69 |
.RS 4 |
| 70 |
.IP \(bu |
| 71 |
\(dqSession/Episode\(dq |
| 72 |
.IP \(bu |
| 73 |
\(dqSession : Episode\(dq |
| 74 |
.IP \(bu |
| 75 |
\(dqEpisode (Session)\(dq |
| 76 |
.RE |
| 77 |
.IP \(bu |
| 78 |
\fBrecording_date\fR and \fBrecording_time\fR must (obviously) be |
| 79 |
both correct. |
| 80 |
.IP \(bu |
| 81 |
Channel \fIlabel\fRs must be a valid System 10-20 channel designation, |
| 82 |
i.e., \(dqNz\(dq, \(dqFp1\(dq, \(dqFpz\(dq, \(dqFp2\(dq, \(dqAF7\(dq, |
| 83 |
\(dqAF3\(dq, \(dqAFz\(dq, \(dqAF4\(dq, \(dqAF8\(dq, \(dqF9\(dq, |
| 84 |
\(dqF7\(dq, \(dqF5\(dq, \(dqF3\(dq, \(dqF1\(dq, \(dqFz\(dq, |
| 85 |
\(dqF2\(dq, \(dqF4\(dq, \(dqF6\(dq, \(dqF8\(dq, \(dqF10\(dq, |
| 86 |
\(dqFT9\(dq, \(dqFT7\(dq, \(dqFC5\(dq, \(dqFC3\(dq, \(dqFC1\(dq, |
| 87 |
\(dqFCz\(dq, \(dqFC2\(dq, \(dqFC4\(dq, \(dqFC6\(dq, \(dqFCT8\(dq, |
| 88 |
\(dqFT10\(dq, \(dqA1\(dq, \(dqT9\(dq, \(dqT7\(dq, \(dqC5\(dq, |
| 89 |
\(dqC3\(dq, \(dqC1\(dq, \(dqCz\(dq, \(dqC2\(dq, \(dqC4\(dq, |
| 90 |
\(dqC6\(dq, \(dqT8\(dq, \(dqT10\(dq, \(dqA2\(dq, \(dqTP9\(dq, |
| 91 |
\(dqTP7\(dq, \(dqCP5\(dq, \(dqCP3\(dq, \(dqCP1\(dq, \(dqCPz\(dq, |
| 92 |
\(dqCP2\(dq, \(dqCP4\(dq, \(dqCP6\(dq, \(dqTP8\(dq, \(dqTP10\(dq, |
| 93 |
\(dqP9\(dq, \(dqP7\(dq, \(dqP5\(dq, \(dqP3\(dq, \(dqP1\(dq, |
| 94 |
\(dqPz\(dq, \(dqP2\(dq, \(dqP4\(dq, \(dqP6\(dq, \(dqP8\(dq, |
| 95 |
\(dqP10\(dq, \(dqPO7\(dq, \(dqPO3\(dq, \(dqPOz\(dq, \(dqPO4\(dq, |
| 96 |
\(dqPO8\(dq, \(dqO1\(dq, \(dqOz\(dq, \(dqO2\(dq, \(dqIz\(dq, plus a |
| 97 |
few channels of other signal types: \(dqLeft\(dq, \(dqRight\(dq, |
| 98 |
\(dqChin\(dq, |
| 99 |
|
| 100 |
optionally prepended by signal type (\(dqEEG\(dq, \(dqEOG\(dq, |
| 101 |
\(dqEMG\(dq, \(dqECG\(dq, \(dqERG\(dq, \(dqNC\(dq, \(dqMEG\(dq, |
| 102 |
\(dqMCG\(dq, \(dqEP\(dq, \(dqTemp\(dq, \(dqResp\(dq, \(dqSaO2\(dq, |
| 103 |
\(dqLight\(dq, \(dqSound\(dq, \(dqEvent\(dq, \(dqFreq\(dq) and a |
| 104 |
space. |
| 105 |
.SH SEE ALSO |
| 106 |
aghermann(1), edfhed-gtk(1), edfcat(1). |
| 107 |
.SH AUTHOR |
| 108 |
edfhed is written by Andrei Zavada <[email protected]> as part |
| 109 |
of the Aghermann project. |