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

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 6.0 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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_fromreg_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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_clickincell">
103
104          <h2><a class="top" href="#container">top</a>clickincell </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME:clickincell
111
112 PURPOSE: click on a map and find in which cell the click was
113
114 CATEGORY:finding where is a point on a grid
115
116 CALLING SEQUENCE:
117
118     res = clickincell()
119     Click with the left button to select a cell. Clicking one more
120     time in the same cell remove the cell from the selection.
121     Click on the right button to quit. 
122
123 INPUTS:None
124
125 KEYWORD PARAMETERS:
126
127     CELLTYPE = 'T', 'W', 'U', 'V' or 'F': This this the type of point
128     that is located in the center of the cell which the click is
129     located. default is T type of cell (with corner defined by F
130     points).
131
132     /DRAWCELL: to draw the cell in which we clicked
133
134     COLOR = the color used to draw the cells (Clicking one more
135     time in the same cell will draw the cell with the white color)
136
137     /ORIGINAL: to get the position of the cell regarding the original
138     grid (with no key_shift, ixminmesh, iyminmesh...)
139
140     /IJ: see outpus
141
142     _EXTRA: to pass extra keywords to inquad and plot (when /drawcell)
143
144 OUTPUTS:
145     the the index of the selected cells regarding to the grid which
146     is in memory in the variable of the common. If /ij keyword is
147     activated give 2D array (2, n) which are the i,j position of the
148     n selected cells.
149
150 COMMON BLOCKS:common.pro
151
152 SIDE EFFECTS:
153
154 RESTRICTIONS:
155
156 EXAMPLE:
157
158   IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho
159   IDL> print, clickincell(/draw,color=150,/xy)
160
161 MODIFICATION HISTORY:</div>
162
163         
164
165         
166
167         
168
169            <h3>Keywords</h3>
170           
171            <h4 id="_clickincell_keyword_CELLTYPE">CELLTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172             
173             
174             
175             
176             
177             
178             
179             
180            </h4>
181       
182            <div class="comments"></div>
183           
184            <h4 id="_clickincell_keyword_DRAWCELL">DRAWCELL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185             
186             
187             
188             
189             
190             
191             
192             
193            </h4>
194       
195            <div class="comments"></div>
196           
197            <h4 id="_clickincell_keyword_COLOR">COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198             
199             
200             
201             
202             
203             
204             
205             
206            </h4>
207       
208            <div class="comments"></div>
209           
210            <h4 id="_clickincell_keyword_ORIGINAL">ORIGINAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211             
212             
213             
214             
215             
216             
217             
218             
219            </h4>
220       
221            <div class="comments"></div>
222           
223            <h4 id="_clickincell_keyword_IJ">IJ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224             
225             
226             
227             
228             
229             
230             
231             
232            </h4>
233       
234            <div class="comments"></div>
235           
236            <h4 id="_clickincell_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237             
238             
239             
240             
241             
242             
243             
244             
245            </h4>
246       
247            <div class="comments"></div>
248           
249         
250
251         
252         
253         
254         
255         
256         
257         
258         
259         
260         
261         
262         
263       
264         
265         
266         
267         
268         
269         
270         
271       
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.