← Back to branch summary

~ubuntu-branches/debian/jessie/eso-midas/jessie

« back to all changes in this revision

Viewing changes to prim/help/get_curs.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/get_curs.hlq
 
1
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
2
%.COPYRIGHT  (c)  1990 European Southern Observatory
 
3
%.IDENT      get_curs.hlq
 
4
%.AUTHOR     KB, IPG/ESO
 
5
%.KEYWORDS   MIDAS, help files, GET/CURSOR
 
6
%.PURPOSE    On-line help file for the command: GET/CURSOR
 
7
%.VERSION    1.0  12-JUL-1990 : Creation, KB
 
8
% 041129        last modif
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./CURS
 
12
\es\co
 
13
GET/CURSOR                                      12-FEB-2003  KB
 
14
\oc\su
 
15
GET/CURSOR [output] [option] [marker] [curs_specs] [zw_option] 
 
16
        read cursor coords from display
 
17
\us\pu
 
18
Purpose:  
 
19
           Read cursor coordinates from image display system.
 
20
\up\sy
 
21
Syntax: 
 
22
           GET/CURSOR [output] [option] [marker] [curs_specs] [zw_option]
 
23
\ys\pa
 
24
           output = specification for storage of world coordinates and pixel
 
25
              values, may be:
 
26
              table name (a),
 
27
              descriptor name (b), specified as descr_name,DESCR
 
28
              omitted (i.e. = ?) (c), data is only displayed on the terminal;
 
29
              defaulted to ? 
 
30
\ap\pa
 
31
           option = append_flag for descriptors;
 
32
               A => data values will be appended to the end of the descriptor,
 
33
                    else data is written to beginning of the descriptor - this
 
34
                    is the default;
 
35
                    append_flag+id_flag or no_flag for tables;
 
36
               A => data values will be appended to the end of the table, 
 
37
                    else a new table is created - this is the default;
 
38
               ID => for each cursor input the user is prompted for an
 
39
                     identification (limited to 8 chars.);
 
40
               NO or NO,start_no => enable automatic numbering of coordinate
 
41
                     reading, starting at start_no;
 
42
                     this number is stored in a column labeled :No ;
 
43
              defaulted to nothing of the above (see also the Notes)
 
44
\ap\pa
 
45
           marker = two-character flag for marking position in the overlay;
 
46
              if first character = Y, a cross (rectangle) will be drawn in the
 
47
              overlay channel at the current cursor position(s);
 
48
              if second character = Y, the identifier or sequence number will
 
49
              also be written to the overlay channel, only applicable for
 
50
              option ID and NO described above;
 
51
              defaulted to YN
 
52
\ap\pa
 
53
           curs_specs = max number of coordinate readings and no. of cursors;
 
54
              if set to 0,0 (or just 0) the cursor coordinates will be read 
 
55
              out continuously and world coords. and intensity displayed;
 
56
              defaulted to 9999,1
 
57
\ap\pa
 
58
           zw_option = zoom_window_flag,zoom;
 
59
              zoom_window_flag = W for zoom_window, N for none,
 
60
              zoom = initial zoom factor;
 
61
              defaulted to N,4;
 
62
\ap\sa
 
63
See also:
 
64
           CREATE/CURSOR, SET/CURSOR, VIEW/IMAGE, EXTRACT/CURSOR, GET/GCURSOR
 
65
\as\no
 
66
Note: 
 
67
              If the output goes to a table the columns :X_coord,:Y_coord,
 
68
           :Value,:X_coordpix and :Y_coordpix will be created, if only one 
 
69
           cursor involved.
 
70
              If both cursors are involved, then for a rectangle the columns 
 
71
           :Xstart,:Xend, :Ystart,:Yend,:Value1, :Value2, :Xstartpix,
 
72
           :Ystartpix, :Xendpix and :Yendpix will be created;
 
73
           and for a circle the columns :X_coord,:Y_coord,:Value,:Radius1,
 
74
           :X_coordpix and :Y_coordpix will be created.
 
75
              If option = NO or NO,number a column labeled :No is also created,
 
76
           else a column :Ident is created which will contain an automatic
 
77
           identification (IDxyz) or if option = ID the user is prompted each
 
78
           time for an identification.
 
79
              The append_flag and either id_ or no_flag can be combined via 
 
80
           the `+' char., e.g. A+NO,2100 to append to the input table and 
 
81
           fill the column :No with sequence numbers beginning at 2100.
 
82
              If the output goes to a descriptor the world coords of x,y and
 
83
           the intensity are stored for a single cursor. For two cursors,
 
84
           the world coords of x,y and intensity of both cursors are stored,
 
85
           if a rectangle is used; and the world coords of x,y and intensity
 
86
           of the center pixel as weel as the radius are stored, if a circle
 
87
           is used.
 
88
              Use the Mouse to move the cursor; the leftmost Mouse button or 
 
89
           the RETURN key serve as ENTER button; the right Mouse button serves
 
90
           as EXIT button.
 
91
              This command also stores last obtained cursor pixels in keyword
 
92
           CURSOR(1,..,4); the last obtained coordinates in keyword
 
93
           OUTPUTR(10...) and total no. of coords. read in OUTPUTI(1).
 
94
              If `curs_specs' is set to `xxx,1' (which is the default) a single
 
95
           cursor is used, irrespective of any previous SET/CURSOR command
 
96
           which might have initialized a cursor rectangle!
 
97
              If `curs_specs' is set to 0, i.e. continuous cursor read-out is
 
98
           done, always a single cursor is used.
 
99
              Normally, the overlay channel is not cleared at startup of the
 
100
           command; if you want to clear first, set keyword AUX_MODE(9) = 1.
 
101
              If we use the zoom_window mode, use first the cursor to choose a
 
102
           region in the main window. Press ENTER to copy the indicated
 
103
           rectangle to the zoom window. Move the cursor into this window and
 
104
           get the cursor values. To choose another region, press EXIT in the
 
105
           zoom window, move the cursor back to the main window and choose
 
106
           another region. To exit, press EXIT in the main window.
 
107
           A separate terminal window is used for the additional output
 
108
           provided with that option.
 
109
              Options exist for changing the zoom factor, using color LUTs,
 
110
           different ITTs and scrolling (like in VIEW/IMAGE), which can be
 
111
           activated by typing a single key (with the cursor in the main
 
112
           display window), type 'h' for help on that.
 
113
              If a cursor window exists (cf. CREATE/CURSOR) an area of
 
114
           9x9 pixels around the cursor #0 (i.e. the mouse) is shown in
 
115
           the cursor window zoomed up by a factor of 20.
 
116
\on\exs
 
117
Examples:
 
118
\ex
 
119
           GET/CURSOR
 
120
             Display cursor data on terminal only.
 
121
\xe\ex
 
122
           GET/CURSOR coords,descr ? N
 
123
             Also  store world coordinates and intensity into real descriptor
 
124
             COORDS of displayed frame. 
 
125
             Inhibit drawing of cross at cursor position.
 
126
\xe\ex
 
127
           GET/CURSOR coords
 
128
             Create new table `coords.tbl', use single cursor and store data
 
129
             into that table.
 
130
\xe\ex
 
131
           GET/CURSOR coords ? ? 100,2
 
132
             Create new table `coords.tbl', use cursor rectangle and store 
 
133
             max. 100 data into that table.
 
134
\xe\ex
 
135
           GET/CURSOR coords A
 
136
             Append data to existing table `coords.tbl'.
 
137
\xe\ex
 
138
           GET/CURSOR coords ID
 
139
             Create new table, do not use automatic, sequential identifiers, 
 
140
             but get them from the user.
 
141
\xe\ex
 
142
           GET/CURSOR coords A+ID
 
143
             As above, but append to existing tabel `coords.tbl' .
 
144
\xe\ex
 
145
           GET/CURSOR coords A+ID YY
 
146
             Also draw the identifier into the overlay channel.
 
147
\xe\ex
 
148
           GET/CURSOR p4=0
 
149
             When the cursor is inside the image display window read out the
 
150
             cursor position continuously and display data on terminal.
 
151
\xe\ex
 
152
           GET/CURSOR p5=w
 
153
             Use auxiliary zoom window to get the cursor coordinates.
 
154
             If the zoom window does not exist yet, it will be created with
 
155
             half the size in x and y of main display window.
 
156
\xe\ex
 
157
           GET/CURSOR p4=0 p5=w 
 
158
             With the cursor choose a region inside the main image display
 
159
             window. Then inside the zoom window read out the cursor position
 
160
             continuously and display data on terminal.
 
161
\xe\sxe