~ubuntu-branches/ubuntu/trusty/horae/trusty

« back to all changes in this revision

Viewing changes to debian/athena.1

  • Committer: Bazaar Package Importer
  • Author(s): Carlo Segre
  • Date: 2006-12-26 11:54:29 UTC
  • Revision ID: james.westby@ubuntu.com-20061226115429-6wif9j2nmom5b3ae
Tags: 063-3
Fix debian/rules file to account for changes in source tree 
organization and for case where maintainer forgets to delete 
unneeded CPAN module sources from upstream tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH ATHENA 1 "June 26, 2006"
 
2
.SH NAME
 
3
athena \- interactive \s-1XAS\s0 data processing
 
4
.SH SYNOPSIS
 
5
.B athena
 
6
.RI " file" ...
 
7
.SH DESCRIPTION
 
8
This manpage documents the 
 
9
.B athena
 
10
program, for interactive \s-1XAS\s0 data processing, including
 
11
converting raw data to mu(E), aligning, merging, deglitching, Fourier
 
12
transforming, and plotting.  Basically, \fBAthena\fR is intended to
 
13
handle all chores involving \s-1XAS\s0 data except for quantitative analysis
 
14
by fitting to theoretical standards.  \fBAthena\fR's sister program
 
15
\&\fBArtemis\fR is the fitting program.
 
16
.PP
 
17
\&\fBAthena\fR has two interesting and unusual features.  The first is that
 
18
there are no buttons for explicitly removing the background from mu(E)
 
19
data or for performing Fourier transforms.  The only active buttons
 
20
displayed on the main window are for plotting.  \fBAthena\fR always knows
 
21
when data requires a background removal or a Fourier transform and
 
22
will perform the necessary analysis steps before displaying the plot.
 
23
.PP
 
24
The second interesting feature is that it is just as easy to perform
 
25
analysis and plotting chores on multiple data sets as on an individual
 
26
data set.  \fBAthena\fR automates the most common data processing chores
 
27
and automatically generates plots of one or more data sets.
 
28
.SH "SYNOPSIS"
 
29
.IX Header "SYNOPSIS"
 
30
\&\fBAthena\fR is a graphical and interactive program written in the perl
 
31
programming language, using the Tk display engine, the \s-1IFEFFIT\s0 \s-1EXAFS\s0
 
32
library, and the \s-1PGPLOT\s0 plotting library.  (See below for a list of
 
33
relevant URLs.)
 
34
.PP
 
35
When \fBAthena\fR starts, you are presented with a window whose layout
 
36
looks something like this:
 
37
.PP
 
38
.Vb 23
 
39
\&     +----------------------------------------+
 
40
\&     |    menubar                             |
 
41
\&     +---------------------------+------------+
 
42
\&     |                           |            |
 
43
\&     |                           |            |
 
44
\&     |                           |   Group    |
 
45
\&     |     Group                 |   List     |
 
46
\&     |    Parameters             |            |
 
47
\&     |                           |            |
 
48
\&     |                           |            |
 
49
\&     |                           +------------+
 
50
\&     |                           | Plot crrnt |
 
51
\&     |                           +------------+
 
52
\&     |                           | Plot mrked |
 
53
\&     |                           +------------+
 
54
\&     |                           |            |
 
55
\&     |                           |   Plot     |
 
56
\&     |                           |  Features  |
 
57
\&     |                           |            |
 
58
\&     |                           |            |
 
59
\&     +---------------------------+------------+
 
60
\&     |    echo area                           |
 
61
\&     +----------------------------------------+
 
62
.Ve
 
63
.PP
 
64
As you import data into \fBAthena\fR, \fIdata groups\fR are created and
 
65
those groups are listed in the section labeled `Group List' .  You
 
66
select a group as the active one by clicking the left mouse button on
 
67
its entry in the group list.  When selected, the list entry is
 
68
highlighted with an orange background and the parameters associated
 
69
with that group are displayed in the large area on the left labeled
 
70
`Group Parameters'.  When you pass the mouse over a label in the group
 
71
parameters section, you will notice that the label changes color.
 
72
This indicates that a mouse click on the label will have an effect.
 
73
Clicking the left mouse button will display a hint in the echo area as
 
74
to the function of that parameter.  See the section on group operations 
 
75
for the effect of a right mouse click.
 
76
.PP
 
77
The view of the group parameters is replaced when certain features of
 
78
\&\fBAthena\fR are used.  Choosuing any of the options from the Data,
 
79
Align, Diff, or Analysis menus will temporarily replace the group
 
80
parameters with views of parameters relevant to the chosen task.  For
 
81
example, when the log-ratio option is chosen from the Analysis menu,
 
82
the view of group parameters is replaced by a view of the interface to
 
83
\&\fBAthena\fR's log\-ratio/phase\-difference analysis.
 
84
.PP
 
85
Below the group list are two rows of button for plotting data.  The
 
86
red buttons are for plotting the selected data group.  The purple
 
87
buttons are for plotting multiple data groups.  These buttons are
 
88
labeled according to the data space of the plot.  \fIE\fR, \fIk\fR, \fIR\fR,
 
89
and \fIq\fR refer to \fIenergy\fR, \fIphotoelectron k\fR, \fIreal space R\fR, and
 
90
\&\fIbacktransform k\fR, respectively.
 
91
.PP
 
92
Below the plot buttons are a set of tabs for specifying the details of
 
93
the plots in each space.  For each space you can specify the range of
 
94
the x\-axis.  For energy plots, you can select whether the background
 
95
function is plotted along with the data and whether the data and
 
96
background are normalized.  For k\-space plots, you can select the
 
97
amount of k\-weighting.  For R\- and q\-space plots, you can select which
 
98
part of those complex functions are plotted.  There are also tabs for
 
99
setting up stacked plots and for establishing plot indicators.  For a
 
100
complete discussion see the section on plotting.
 
101
.PP
 
102
Finally, at the bottom of the page is the \fIecho area\fR.  \fBAthena\fR
 
103
uses this area to display hints, brief help messages, warnings, and
 
104
updates about recently performed analysis or plotting actions.  A few
 
105
features of \fBAthena\fR will prompt the user for a text string.  In
 
106
those situations, the echo area is temporarily replaced by text string
 
107
dialog.
 
108
.PP
 
109
Throughout \fBAthena\fR the right mouse button serves to post \fIcontext
 
110
sensitive menus\fR.  These include parameter labels, groups list
 
111
entries, and other elements on the screen.  You should try clicking
 
112
the right mouse button in different places to see what usefuls things
 
113
might pop up.
 
114
.SH "SECTIONS OF THE DOCUMENT"
 
115
.IX Header "SECTIONS OF THE DOCUMENT"
 
116
.IP "Handling data" 4
 
117
.IX Item "Handling data"
 
118
Data groups ||
 
119
Importing data ||
 
120
Saving data ||
 
121
Plotting ||
 
122
Normalization and background removal ||
 
123
The Edit menu ||
 
124
Group operations ||
 
125
.IP "Data operations" 4
 
126
.IX Item "Data operations"
 
127
Energy calibration ||
 
128
Deglitching data ||
 
129
Truncating data ||
 
130
Self-absorption corrections ||
 
131
Dead-time corrections ||
 
132
Aligning data ||
 
133
Calibrating dispersive \s-1XAS\s0 data ||
 
134
Merging data ||
 
135
Difference spectra ||
 
136
.IP "Analysis" 4
 
137
.IX Item "Analysis"
 
138
Log\-ratio/phase\-difference analysis ||
 
139
Principal component analysis ||
 
140
Peak fitting ||
 
141
Linear fitting of spectra ||
 
142
.IP "Using Athena" 4
 
143
.IX Item "Using Athena"
 
144
Setting preferences ||
 
145
Binding key sequences ||
 
146
Getting help ||
 
147
Other features ||
 
148
.SH "REFERENCES"
 
149
.IX Header "REFERENCES"
 
150
Here are the relevant URLs:
 
151
.IP "\s-1IFEFFIT\s0" 4
 
152
.IX Item "IFEFFIT"
 
153
.Vb 1
 
154
\&  http://cars.uchicago.edu/ifeffit
 
155
.Ve
 
156
.IP "\s-1PGPLOT\s0" 4
 
157
.IX Item "PGPLOT"
 
158
.Vb 1
 
159
\&  http://www.astro.caltech.edu/~tjp/pgplot/
 
160
.Ve
 
161
.IP "Perl" 4
 
162
.IX Item "Perl"
 
163
.Vb 1
 
164
\&  http://www.perl.com
 
165
.Ve
 
166
.IP "perl/Tk" 4
 
167
.IX Item "perl/Tk"
 
168
.Vb 1
 
169
\&  http://www.lehigh.edu/~sol0/ptk/
 
170
.Ve
 
171
.IP "Central atom phase shifts" 4
 
172
.IX Item "Central atom phase shifts"
 
173
.Vb 1
 
174
\&  http://leonardo.phys.washington.edu/~ravel/software/feff_tables/
 
175
.Ve
 
176
.SH "MISSING FEATURES"
 
177
.IX Header "MISSING FEATURES"
 
178
You betcha!  Lots!  Here's a partial list:
 
179
.IP "\(bu" 4
 
180
Principle Component Analysis on the set of marked groups
 
181
.IP "\(bu" 4
 
182
\&\s-1XANES\s0 analysis by fitting a sum of scans to an unknown
 
183
.IP "\(bu" 4
 
184
Dead-time and self-absorption corrections
 
185
.IP "\(bu" 4
 
186
Handle dispersive data sets, i.e. data sets wherein the I0 and \s-1IT\s0
 
187
measurements are in separate data files becuase the data were obtained
 
188
sequentially
 
189
.IP "\(bu" 4
 
190
Calibrate dispersive data to a trusted standard
 
191
.IP "\(bu" 4
 
192
Handle \s-1SPEC\s0 files. An independent perl module would be ideal. This is
 
193
a project some eager contributor could tackle without having to delve
 
194
into \s-1ATHENA\s0's source code.
 
195
.IP "\(bu" 4
 
196
Alignment of scans using a reference, either of the same edge or of a
 
197
nearby edge. (Any suggestions? I am lacking a good idea about how to
 
198
implement this...)
 
199
.IP "\(bu" 4
 
200
Formulas for the energy axis (useful for converting encoder readings
 
201
to energy values)
 
202
.IP "\(bu" 4
 
203
R and q space records, that is to be able to read and write data in R
 
204
and q space just as easily as E or k space.
 
205
.IP "\(bu" 4
 
206
Internationalization. That is, build a framework for having text
 
207
strings read from external files and for the language to be a
 
208
configuration option.
 
209
.IP "\(bu" 4
 
210
Documentation, documentation, documentation
 
211
.SH "WHAT'S IN A NAME?"
 
212
.IX Header "WHAT'S IN A NAME?"
 
213
Athena was the goddess of wisdom and is also associated with skill and
 
214
justice.  Those are all good qualities for a data analysis program!
 
215
.PP
 
216
.SH OPTIONS
 
217
This program requires no options.
 
218
.SH SEE ALSO
 
219
This program is part of the horae XAS analysis suite
 
220
which can be obtained at 
 
221
.br
 
222
http://cars9.uchicago.edu/~ravel/software/
 
223
.SH "AUTHOR"
 
224
.IX Header "AUTHOR"
 
225
.Vb 2
 
226
\&  Bruce Ravel <ravel@phys.washington.edu> (c) 2001 - 2003
 
227
.Ve
 
228
.PP
 
229
.Vb 3
 
230
\&  Ifeffit is copyright (c) 1992 - 2003 Matt Newville
 
231
\&  newville@cars.uchicago.edu
 
232
\&  http://cars9.uchicago.edu/~newville/ifeffit/
 
233
.Ve