aboutsummaryrefslogtreecommitdiff
path: root/noao/imred/bias/doc/linebias.hlp
blob: 6c5d73a5160fa806ee5c0bd7791f7938f0c221d5 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
.help linebias Mar93 noao.imred.bias
.ih
NAME
linebias -- Fit and subtract an average line bias
.ih
USAGE	
.nf
linebias input output
.fi
.ih
PARAMETERS
.ls input
Images to be bias subtracted.  The images may not contain image sections.
.le
.ls output
Output bias subtracted images.  An output images may be the same as its
matching input image.  The output image pixel type will real regardless
of the input image pixel type.
.le
.ls bias = "[]"
Bias section appended to the input image to define the bias region.
The default section or an empty string will use the full image.
.le
.ls trim = "[]"
Trim section appended to the input image to define the region to be
bias subtracted and output.  The default section or an empty string
will use the full image.
.le
.ls median = no
Take the median of the bias lines?  If no then the bias lines are averaged.
.le
.ls function = "spline3"
The function fit to the average bias line.  The functions are "legendre",
"chebyshev", "spline1", or "spline3".  Abbreviations are allowed.
.le
.ls order
The order (number of terms or number of spline pieces) in the function.
.le
.ls low_reject = 3.0
The low sigma rejection factor.
.le
.ls high_reject = 3.0
The high sigma rejection factor.
.le
.ls niterate = 1
The maximum number of rejection iterations.
.le
.ls interactive = yes
Fit the average bias line interactively?
.le
.ls logfile = ""
Name of a log file.  If no file name is given then no log file is kept.
.le
.ls logfiles = ""
List of log files.  If no file name is given then no log file is kept.
.le
.ls graphics = "stdgraph"
Graphics output device for interactive graphics.
.le
.ls cursor = ""
Graphics cursor input
.le
.ih
DESCRIPTION
For each input image in the input image list an average or median bias line
is determined from the bias region.  The bias region
is defined by the bias section applied to the input image.  A function of
the image columns is fit to the average bias line.  This function is subtracted
from each image line in the trim region.  The trim region is defined by the
trim section applied to the input image.  The bias subtracted and trimmed
image is output to the output image.  The input and output images may not
contain sections and the number of images in each list must be the same.

If the interactive flag is set then the user may interactively examine
and fit the average bias line.  The interactive fitting is done using the
interactive curve fitting routine (see icfit).  Before each image is
processed a prompt of the form "linebias image (yes)? " is given.
A response of yes allows interactive fitting for the specified image
while a response of no uses the last defined fitting parameters.
The default value is accepted with a carriage return.  The possible
responses are "yes", "no", "YES", or "NO".  The capitalized responses
permanently set the response to yes or no and the prompt is not
issued again for the remaining images.  Thus, a response of NO processes
the remaining images non-interactively while a response of YES processes
the remaining image interactively without prompting.
.ih
EXAMPLES
The bias region for a set of images occupies columns 1 to 800 and lines
801 to 832.  To subtract the bias and remove the bias region:

.nf
	cl> linebias.bias = "[*, 801:832]"
	cl> linebias.trim = "[*, 1:800]"
	cl> linebias ccd* ccd*
	linebias ccd001 (yes)? yes
	linebias ccd002 (yes)?
	linebias ccd003 (no)? NO
.fi

The first two lines set the bias and trim parameters.  These parameters
could be temporarily set on the command line but generally these parameters
are only changed when new instruments are used.  The first image
is interactively fit and the fitting order is change to 2.  The
second image is examined and the fit found to be acceptable.  All remaining
image are then fit non-interactively using the same fitting parameters.
.ih
REVISIONS
.ls LINEBIAS V2.10.3
The output pixel type is now real instead of preserving the pixel type
of the input image.
.le
.ih
SEE ALSO
icfit
.endhelp