aboutsummaryrefslogtreecommitdiff
path: root/noao/digiphot/apphot/doc/aptest.hlp
blob: 85fad0d9ba2f87c9c9652b7b484da50dd00e9625 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.help aptest Dec92 noao.digiphot.apphot
.ih
NAME
aptest -- run basic tests on the apphot package tasks
.ih
USAGE
aptest imname
.ih
PARAMETERS
.ls imname
The name of the output test image. The actual test image is stored in fits
format in the APPHOT package subdirectory test. If the image already exists
APTEST will exit with a warning message.
.le
.ls aplogfile = ""
The name of the output log file. By default all the text output is logged
in a file called \fI"imname.log"\fR. If the log file already exists APTEST will
exit with a warning message.
.le
.ls applotfile = ""
The name of the output log file. By default all the plot output is logged in
a file called \fI"imname.plot"\fR. If the plot file already exists APTEST will
exit with a warning message.
.le
.ih
DESCRIPTION
APTEST is a simple script which exercises each of the tasks in the APPHOT
package in turn. At startup APTEST reads a small fits image stored in the
APPHOT test subdirectory and creates the image \fIimname\fR in the user's
working directory. APTEST initializes the APPHOT package by returning
all the parameters to their default state, runs each of the APPHOT
tasks in non-interactive mode, spools the text output to the file
\fIaplogfile\fR, and spools the plot output from the RADPROF task to the plot
metacode file \fIapplotfile\fR.
.ih
EXAMPLES

1. Check to see that all the APPHOT tasks are functioning correctly.

.nf
	ap> apphot

	... load the apphot package

	ap> aptest testim

	... run the test script

	ap> lprint testim.log

	... print the text output

	ap> gkidir testim.plot

	... list the contents of the plot file

	ap> gkiextract testim.plot 1-N | stdplot

	... send the plots to the plotter
.fi

.ih
TIME REQUIREMENTS
.ih
BUGS
.ih
SEE ALSO
.endhelp