← Back to branch summary

~ubuntu-branches/ubuntu/wily/eso-midas/wily-proposed

« back to all changes in this revision

Viewing changes to prim/help/centermome.hlq

  • Committer: Package Import Robot
  • Author(s): Ole Streicher
  • Date: 2014-04-22 14:44:58 UTC
  • Revision ID: package-import@ubuntu.com-20140422144458-okiwi1assxkkiz39
Tags: upstream-13.09pl1.2+dfsg
Import upstream version 13.09pl1.2+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
prim/help/centermome.hlq
 
1
% @(#)centermome.hlq    19.1 (ESO-IPG) 02/25/03 14:02:59 
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1990 European Southern Observatory
 
4
%.IDENT      centermome.hlq
 
5
%.AUTHOR     KB, IPG/ESO
 
6
%.KEYWORDS   MIDAS, help files, CENTER/MOMENT
 
7
%.PURPOSE    On-line help file for the command: CENTER/MOMENT
 
8
%.VERSION    1.0  07-FEB-1990 : Creation, KB
 
9
%.VERSION    1.1  02-MAR-1992 : Update, KB
 
10
%.VERSION    1.2  09-NOV-1992 : Update, KB
 
11
%----------------------------------------------------------------
 
12
\se
 
13
SECTION./MOME
 
14
\es\co
 
15
CENTER/MOMENT                                            29-JUL-1999  KB
 
16
\oc\su
 
17
CENTER/MOMENT [in_specs] [out_specs] [out_opt] [curs_specs]
 
18
              [wsize] [zw_option] [invert_flag]
 
19
        find intensity weighted center
 
20
\us\pu
 
21
Purpose: 
 
22
          Compute the central position of the specified object using an
 
23
          intensity weighted first moment of the pixel values.
 
24
\up\sub
 
25
Subject: 
 
26
          Position, fitting, centering.
 
27
\bus\sy
 
28
Syntax:  
 
29
          CENTER/MOMENT [in_specs] [out_specs] [out_opt] [curs_specs]
 
30
                        [wsize] [zw_option] [invert_flag]
 
31
\ys\pa
 
32
          in_specs = input specifications, either
 
33
\\
 
34
             (a) CURSOR  - if the subimages are interactively chosen via the
 
35
                 cursor rectangle, or
 
36
\\
 
37
             (b) image,table - if the subimages are defined in a table in the
 
38
                 columns labeled :XSTART, :XEND, :YSTART and :YEND, or only
 
39
                 columns :XSTART and :XEND (1-dim centering) or only single
 
40
                 column :X_POSITION (two rows per interval needed);
 
41
\\
 
42
             (c) image - if subimage will be a (max) 200 * 200 window around
 
43
                 center of image
 
44
\\
 
45
             (d) image,xfrpix,yfrpix - if subimage will be a window of `wsize'
 
46
                 around xfrpix,yfrpix (frame pixels)
 
47
\\
 
48
             defaulted to CURSOR
 
49
\ap\pa
 
50
          out_specs = output specifications:
 
51
\\
 
52
             (x) table name, may be same as given in in_specs
 
53
\\
 
54
             (y) if same table, only the xcenter, ycenter, xerr, yerr,
 
55
                 xsigma, ysigma and status will be stored in columns
 
56
\\
 
57
                 :XCEN, :YCEN, :XERR, :YERR, :XSIG, :YSIG, ;STATUS
 
58
\\
 
59
                 if new table, then in addition to the columns explained
 
60
                 above, also the columns labeled :XSTART, :YSTART, :XEND,
 
61
                 :YEND and :NO will be filled
 
62
\\
 
63
             (z) descriptor,D if the results should be stored in a real
 
64
                 descriptor of the involved image frame;
 
65
\\
 
66
             Per Default the values are displayed only on the terminal and
 
67
             stored in the keyword OUTPUTR which is filled as follows:
 
68
             xstart, ystart, xend, yend, xcenter, ycenter, xerr, yerr, xsigma,
 
69
             ysigma, return_status, xfwhm, yfwhm, icent
 
70
\\
 
71
             Xstart, ystart, xend, yend, xcenter, ycenter are also stored
 
72
             as double precision values in keyword OUTPUTD(1 - 6).
 
73
\ap\pa
 
74
          out_opt = A, append data to a table (or descriptor), else start at
 
75
             the beginning, only applicable to (x) or (z)
 
76
\\
 
77
             ID, write also column labeled :IDENT to output table,
 
78
             only applicable to (x)
 
79
\ap\pa
 
80
          curs_specs = no_curs,drawflag,max_input:
 
81
\\
 
82
             no_curs = 1 or 2, if single cursor a fixed subimage according
 
83
             to next parameter `wsize' is used; for 2 cursors the size of
 
84
             subimage is determined by the size of the cursor rectangle.
 
85
\\
 
86
             drawflag = option for drawing subwindow limits in the overlay
 
87
             channel;
 
88
\\
 
89
             max_input = max. of cursor inputs.
 
90
\\
 
91
             This parameter is only used if in_specs = CURSOR (a);
 
92
\\
 
93
             defaulted to 2,1,9999
 
94
\ap\pa
 
95
          wsize = no. of x-and y-pixels for subwindow centered via the
 
96
             single cursor or `inp_specs' (d);
 
97
\\
 
98
             defaulted to 50,50
 
99
\ap\pa
 
100
          zw_option = zwindow_flag,zoom;
 
101
\\
 
102
             zwindow_flag = W for zoom window, N for none,
 
103
\\
 
104
             zoom = initial zoom factor;
 
105
\\
 
106
             only applicable to X11 window displays and option (a),
 
107
\\
 
108
             defaulted to N,4 (see the help of GET/CURSOR for more info about
 
109
             the additional functionality provided in that mode);
 
110
\ap\pa
 
111
          invert_flag = YES or NO;
 
112
\\
 
113
             if the objects are at a minimum and not maximum of the data, i.e.
 
114
             instead of a `peak' you have a `valley', set this par. to YES.
 
115
\\
 
116
             defaulted to NO
 
117
\ap\sa
 
118
See also:
 
119
          CENTER/GAUSS, MAGNITUDE/...
 
120
\as\no
 
121
Note:  
 
122
          When using the cursor input option, a cursor window will appear 
 
123
          on the screen.
 
124
\\
 
125
          Use the mouse to move the complete window (or single cursor), 
 
126
          use the arrow keys to change window size. Left mouse button 
 
127
          (or RETURN key) is ENTER button, second left button is EXIT button.
 
128
\\
 
129
          If you also use the `zw_option', the cursor in the main display is
 
130
          only used to define the subwindow to work on. Then move the cursor
 
131
          to the auxiliary (zoom) window and proceed as described above.
 
132
\\
 
133
          When using the out_opt ID for table output, computations proceed
 
134
          after pressing the ENTER button and(!) entering also an identifier
 
135
          of max. 8 characters and hitting RETURN on the keyboard.
 
136
          Otherwise the string IDabcd will be written into column :IDENT
 
137
          with "abcd" the sequence number.
 
138
\\
 
139
          Last results of center calculations are also written into
 
140
          keyword OUTPUTR.
 
141
\\
 
142
          The return status from the centering algorithm should be 0
 
143
          otherwise something is wrong (maybe just some non-convergence)
 
144
\on\exs
 
145
Examples:
 
146
\ex
 
147
          1) CENTER/MOMENT
 
148
             Use cursor to define subimages and display start- and
 
149
             end-coordinates of subimage as well as center values and
 
150
             associated errors and return status on terminal only
 
151
\xe\ex
 
152
          2) CENTER/MOMENT CURSOR values,d
 
153
             as 1)  but write data to beginning of real descriptor VALUES
 
154
             of displayed image
 
155
\xe\ex
 
156
          3) CENTER/MOMENT cursor VALUES,D A
 
157
             as 2)  but append data to the end of real descriptor VALUES
 
158
\xe\ex
 
159
          4) CENTER/MOMENT CURSOR values
 
160
             as 1) but store data into table `values.tbl' (will be created
 
161
             by MIDAS)
 
162
\xe\ex
 
163
          6) CENTER/MOMENT ccd001,sources
 
164
             use columns :XSTART, :YSTART, :XEND and :YEND of `sources.tbl'
 
165
             to define the subimages of image `ccd001.bdf'; 
 
166
             just display results
 
167
\xe\ex
 
168
          7) CENTER/MOMENT ccd001,sources VALUES,D
 
169
             as 6) but write results into real descr named Values of frame
 
170
             `ccd001.bdf'
 
171
\xe\ex
 
172
          8) CENTER/MOMENT ccd001,sources sources
 
173
             as 6) but store results also in input table `sources.tbl'
 
174
\xe\ex
 
175
          9) CENTER/MOMENT ccd001,sources center
 
176
             as 8) but store results into new table `center.tbl'
 
177
\xe\ex
 
178
         10) CENTER/MOMENT ccd001,233,402 ? ? ? 20,20
 
179
             use a subwindow of 20x20 pixels centered at frame pixels 233,402
 
180
             of `ccd001.bdf'
 
181
\xe\ex
 
182
         11) CENTER/MOMENT cursor p6=w
 
183
             as 1) but use zoom window to determine working area via cursor,
 
184
             but we need X11 for that...
 
185
\xe \sxe