Debian Codegraph @

man/aghermann.1.in

raw
1 .TH Aghermann 1 "@build_date@" @VERSION@ "Aghermann"
2 .SH NAME
3 Aghermann -- a sleep research experiment manager and Achermann et al (1993) model simulator
4 .SH SYNOPSIS
5 aghermann [\-l \fILOG_FILE\fR] [\-n] [\fIEXP_ROOT_DIR\fR]
6 .B
7 .PP
8
9 .SH DESCRIPTION
10 .PP
11 \fBAghermann\fR is a GTK+ program designed to run Process S simulations
12 on Slow-Wave Activity profiles from EEG recordings as outlined in
13 Achermann et al (1993). In this capacity, \fBAghermann\fR produces a
14 set of sleep homeostat parameters which can be used to describe and
15 differentiate individual sleepers, such as short vs long sleepers,
16 early vs late, etc.
17
18 Also provided are general-purpose facilities for displaying EEG and
19 accompanying recordings, such as EOG and EMG, saved in EDF (European
20 Data Format) files (plain EDF as well as EDF+C are supported). These
21 recordings can then be conveniently scored; scores can be
22 imported/exported in plain ASCII. Scoring can be outsourced to
23 external scripts written in lua.
24
25 .SH COMMAND\-LINE OPTIONS
26 .PP
27 If run without arguments, your last session will be restored; an
28 experiment located in \fIEXP_ROOT_DIR\fR will be selected otherwise.
29
30 With option \fB\-n\fR (and an \fIEXP_ROOT_DIR\fR, which is
31 non-optional in this case), the experiment session in that directory
32 will be initialised and immediately closed, upon which \fBAghermann\fR
33 will exit. No windows will be open and no GTK+ code run; this option
34 was implemented with the idea of running the core structural part of
35 \fBAghermann\fR under valgrind.
36
37 With option \fB\-l\fR \fILOG_FILE\fR, aghermann will write a log of
38 its inner workings to \fILOG_FILE\fR; if the latter is "-", stdout is
39 used. By default, (almost all) logging is suppressed.
40
41 .SH NOTE ON EDF FILE METADATA
42 .PP
43 For Aghermann to be able to manage an EDF file, all relevant fields in
44 its header must be filled out correctly, as follows:
45 .IP \(bu
46 \fBpatient_id\fR uniquely identifies the subject;
47 .IP \(bu
48 \fBrecording_id\fR identifies the recording session (out of several
49 other such sessions, each containing the same series of episodes) and
50 the individual episode. These two items must appear in one of the
51 following combinations:
52 .RS 4
53 .IP \(bu
54 \(dqSession/Episode\(dq
55 .IP \(bu
56 \(dqSession : Episode\(dq
57 .IP \(bu
58 \(dqEpisode (Session)\(dq
59 .RE
60 .IP \(bu
61 \fBrecording_date\fR and \fBrecording_time\fR must not overlap with
62 other episodes in the same session and not be too far removed from
63 each other (more than 7 days).
64
65 .SH FILES
66 .TP
67 \fI~/.config/aghermann/sessionrc\fR, contains a list of paths to recent experiment trees.
68 .TP
69 \fI./.agherman.conf\fR and \fI./.expdesign.conf\fR, saved settings of the experiment located in
70 this tree.
71 .SH SEE ALSO
72 edfhed-gtk(1), edfhed(1), edfcat(1).
73
74 The project\(cqs git repository is kept on sf.net and also on github.com;
75 more details on the Achermann model as well as on usage and project
76 background can be found at
77 \fIhttp://johnhommer.com/academic/code/aghermann\fR.
78 .SH AUTHOR
79 Aghermann is written by Andrei Zavada <[email protected]>. Parts of
80 the code have been borrowed from http://exstrom.com (in
81 src/libexstrom); some bare algorithms in libsigfile/mc.* are those
82 found in C# files zipped and posted at code.google.com/p/neuroloopgain.
83