source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/clickincell.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 4.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>clickincell.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="angle.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="compute_fromirr_bilinear_weigaddr.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Interpolation/</font></h1>
58    <h2>clickincell.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 click on a map and find in which cell the click was
65
66
67   
68
69     
70      <a name="#_clickincell"></a>
71
72      <h2>clickincell  <font size="-1" color="#006633">
73 Grid
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>clickincell(<a href="#_clickincell_keyword_CELLTYPE">CELLTYPE</a>=<i>CELLTYPE</i>, <a href="#_clickincell_keyword_DRAWCELL">DRAWCELL</a>=<i>DRAWCELL</i>, <a href="#_clickincell_keyword_COLOR">COLOR</a>=<i>COLOR</i>, <a href="#_clickincell_keyword_ORIGINAL">ORIGINAL</a>=<i>ORIGINAL</i>, <a href="#_clickincell_keyword_IJ">IJ</a>=<i>IJ</i>, <a href="#_clickincell_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 the index of the selected cells regarding to the grid which
83 is in memory in the variable of the common. If /ij keyword is
84 activated give 2D array (2, n) which are the i,j position of the
85 n selected cells.
86
87
88   
89
90   
91    <h3>Keywords</h3>
92
93   
94    <a name="#_clickincell_keyword_CELLTYPE"></a>
95    <h4>CELLTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
96     
97     
98     
99     
100     
101     
102     
103     
104    </h4>
105
106   
107 = 'T', 'W', 'U', 'V' or 'F'
108 the type of point
109     that is located in the center of the cell which the click is
110     located. default is T type of cell (with corner defined by F
111     points).
112
113   
114    <a name="#_clickincell_keyword_DRAWCELL"></a>
115    <h4>DRAWCELL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116     
117     
118     
119     
120     
121     
122     
123     
124    </h4>
125
126   
127 to draw the cell in which we clicked
128
129   
130    <a name="#_clickincell_keyword_COLOR"></a>
131    <h4>COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132     
133     
134     
135     
136     
137     
138     
139     
140    </h4>
141
142   
143 the color used to draw the cells (Clicking one more
144 time in the same cell will draw the cell with the white color)
145
146   
147    <a name="#_clickincell_keyword_ORIGINAL"></a>
148    <h4>ORIGINAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149     
150     
151     
152     
153     
154     
155     
156     
157    </h4>
158
159   
160 to get the position of the cell regarding the original
161 grid (with no key_shift, ixminmesh, iyminmesh...)
162
163   
164    <a name="#_clickincell_keyword_IJ"></a>
165    <h4>IJ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166     
167     
168     
169     
170     
171     
172     
173     
174    </h4>
175
176   
177 see returns
178
179   
180    <a name="#_clickincell_keyword__EXTRA"></a>
181    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182     
183     
184     
185     
186     
187     
188     
189     
190    </h4>
191
192   
193 Used to pass extra keywords to <a href="..//Interpolation/inquad.html">inquad</a> and
194 <a href="/Applications/itt/idl64/help/online_help/PLOT.html">PLOT</a>
195 (when /drawcell)
196
197   
198   
199
200    <h3>Examples</h3><pre>
201 IDL> res = clickincell()
202     Click with the left button to select a cell. Clicking one more
203     time in the same cell remove the cell from the selection.
204     Click on the right button to quit.
205
206 IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho
207 IDL> print, clickincell(/draw,color=150,/xy)
208
209    </pre><h3>Version history</h3>
210   
211    <h4>Version</h4>
212 $Id: clickincell.pro 327 2007-12-13 16:22:35Z pinsard $
213
214    <h4>History</h4>
215      Sebastien Masson (smasson@lodyc.jussieu.fr)
216      August 2003
217
218   
219
220   
221   
222   
223   
224   
225
226    <h3>Other attributes</h3>
227   
228   
229    <h4>Uses routines</h4>
230 common.pro
231
232   
233   
234   
235
236    <font size="-3"><p>&nbsp;</p></font>
237    <hr size="1" color="#CCCCCC"/>
238     
239
240   
241
242    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
243
244  </body>
245</html>
Note: See TracBrowser for help on using the repository browser.