source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/clickincell.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 6.4 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>clickincell.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="clickincell.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Interpolation//clickincell.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="angle.html">&lt;&lt;prev file</a> | <a href="compute_fromirr_bilinear_weigaddr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="clickincell.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Interpolation/</a></h1>
82      <h2 class="pro_file">clickincell.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 click on a map and find in which cell the click was
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_clickincell">
105
106          <h2><a class="top" href="#container">top</a>clickincell <span class="categories">
107 Grid
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>clickincell(<a href="#_clickincell_keyword_CELLTYPE">CELLTYPE</a>=<span class="result">CELLTYPE</span>, <a href="#_clickincell_keyword_DRAWCELL">DRAWCELL</a>=<span class="result">DRAWCELL</span>, <a href="#_clickincell_keyword_COLOR">COLOR</a>=<span class="result">COLOR</span>, <a href="#_clickincell_keyword_ORIGINAL">ORIGINAL</a>=<span class="result">ORIGINAL</span>, <a href="#_clickincell_keyword_IJ">IJ</a>=<span class="result">IJ</span>, <a href="#_clickincell_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 the index of the selected cells regarding to the grid which
118 is in memory in the variable of the common. If /ij keyword is
119 activated give 2D array (2, n) which are the i,j position of the
120 n selected cells.
121</div>
122
123         
124
125         
126
127            <h3>Keywords</h3>
128           
129            <h4 id="_clickincell_keyword_CELLTYPE">CELLTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130             
131             
132             
133             
134             
135             
136             
137             
138            </h4>
139       
140            <div class="comments">
141 = 'T', 'W', 'U', 'V' or 'F'
142 the type of point
143 that is located in the center of the cell which the click is
144 located. default is T type of cell (with corner defined by F
145 points).
146</div>
147           
148            <h4 id="_clickincell_keyword_DRAWCELL">DRAWCELL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149             
150             
151             
152             
153             
154             
155             
156             
157            </h4>
158       
159            <div class="comments">
160 to draw the cell in which we clicked
161</div>
162           
163            <h4 id="_clickincell_keyword_COLOR">COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164             
165             
166             
167             
168             
169             
170             
171             
172            </h4>
173       
174            <div class="comments">
175 the color used to draw the cells (Clicking one more
176 time in the same cell will draw the cell with the white color)
177</div>
178           
179            <h4 id="_clickincell_keyword_ORIGINAL">ORIGINAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180             
181             
182             
183             
184             
185             
186             
187             
188            </h4>
189       
190            <div class="comments">
191 to get the position of the cell regarding the original
192 grid (with no key_shift, ixminmesh, iyminmesh...)
193</div>
194           
195            <h4 id="_clickincell_keyword_IJ">IJ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196             
197             
198             
199             
200             
201             
202             
203             
204            </h4>
205       
206            <div class="comments">
207 see returns
208</div>
209           
210            <h4 id="_clickincell_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211             
212             
213             
214             
215             
216             
217             
218             
219            </h4>
220       
221            <div class="comments">
222 Used to pass extra keywords to <a href="..//Interpolation/inquad.html">inquad</a> and
223 <a href="/Applications/itt/idl64/help/online_help/PLOT.html">PLOT</a>
224 (when /drawcell)
225</div>
226           
227         
228
229          <h3>Examples</h3><div class="preformat">
230   IDL> res = clickincell()
231
232 Click with the left button to select a cell. Clicking one more
233 time in the same cell remove the cell from the selection.
234 Click on the right button to quit.
235
236   IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho
237   IDL> print, clickincell(/draw,color=150,/xy)
238</div>
239          <h3>Version history</h3>
240         
241          <h4>Version</h4><div class="preformat">
242 $Id: clickincell.pro 372 2008-08-08 12:31:53Z pinsard $
243</div>
244          <h4>History</h4><div class="preformat">
245      Sebastien Masson (smasson@lodyc.jussieu.fr)
246      August 2003
247</div>
248         
249         
250         
251         
252         
253         
254         
255       
256          <h3>Other attributes</h3>
257         
258         
259          <h4>Uses routines</h4><div class="preformat">
260 <a href="..//Obsolete/common.html">common</a>
261</div>
262         
263         
264         
265       
266          <h3>Statistics</h3>
267          <table class="statistics">
268            <tr><td>McCabe cyclic</td><td>          33</td></tr>
269            <tr><td>McCabe essential</td><td>           8</td></tr>
270            <tr><td>McCabe modular design</td><td>           1</td></tr>
271          </table>
272         
273       
274        </div>
275       
276      </div>
277
278     
279
280      <div id="tagline">Produced by IDLdoc 2.0.</div>
281
282    </div>
283
284  </body>
285</html>
Note: See TracBrowser for help on using the repository browser.