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

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 6.4 KB
RevLine 
[89]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>
[104]9    <title>clickincell.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="clickincell.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Interpolation//clickincell.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Interpolation/</a></h1>
[89]82      <h2 class="pro_file">clickincell.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
90 click on a map and find in which cell the click was
[101]91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_clickincell">
105
[157]106          <h2><a class="top" href="#container">top</a>clickincell <span class="categories">
107 Grid
[101]108</span></h2>
[89]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       
[234]113          <div class="comments">
114</div>
[89]115
[138]116          <h3>Return value</h3><div class="preformat">
[234]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.
[101]121</div>
[89]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       
[234]140            <div class="comments">
141 = 'T', 'W', 'U', 'V' or 'F' This this the type of point
[101]142     that is located in the center of the cell which the click is
143     located. default is T type of cell (with corner defined by F
144     points).
145</div>
[89]146           
147            <h4 id="_clickincell_keyword_DRAWCELL">DRAWCELL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148             
149             
150             
151             
152             
153             
154             
155             
156            </h4>
157       
[234]158            <div class="comments">
159 to draw the cell in which we clicked
[101]160</div>
[89]161           
162            <h4 id="_clickincell_keyword_COLOR">COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
[234]173            <div class="comments">
174 the color used to draw the cells (Clicking one more
175 time in the same cell will draw the cell with the white color)
[101]176</div>
[89]177           
178            <h4 id="_clickincell_keyword_ORIGINAL">ORIGINAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
[234]189            <div class="comments">
190 to get the position of the cell regarding the original
191 grid (with no key_shift, ixminmesh, iyminmesh...)
[101]192</div>
[89]193           
194            <h4 id="_clickincell_keyword_IJ">IJ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200             
201             
202             
203            </h4>
204       
[234]205            <div class="comments">
206 see outputs
[101]207</div>
[89]208           
209            <h4 id="_clickincell_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
210             
211             
212             
213             
214             
215             
216             
217             
218            </h4>
219       
[234]220            <div class="comments">
221 Used to pass extra keywords to <a href=".//inquad.html">inquad</a> and
222 <proidl>plot</proidl>
223 (when /drawcell)
[101]224</div>
[89]225           
226         
227
[138]228          <h3>Examples</h3><div class="preformat">
229 IDL> res = clickincell()
[101]230     Click with the left button to select a cell. Clicking one more
231     time in the same cell remove the cell from the selection.
[138]232     Click on the right button to quit.
[101]233
[138]234 IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho
235 IDL> print, clickincell(/draw,color=150,/xy)
[101]236</div>
237          <h3>Version history</h3>
[89]238         
[234]239          <h4>Version</h4><div class="preformat">
240 $Id: clickincell.pro 232 2007-03-20 16:59:36Z pinsard $
[118]241</div>
[138]242          <h4>History</h4><div class="preformat">
[101]243      Sebastien Masson (smasson@lodyc.jussieu.fr)
244      August 2003
245</div>
[89]246         
247         
248         
249         
250         
251         
252         
253       
[101]254          <h3>Other attributes</h3>
[89]255         
256         
[234]257          <h4>Uses routines</h4><div class="preformat">
258 common.pro
[101]259</div>
[89]260         
261         
262         
263       
[163]264          <h3>Statistics</h3>
265          <table class="statistics">
266            <tr><td>McCabe cyclic</td><td>          33</td></tr>
267            <tr><td>McCabe essential</td><td>           8</td></tr>
268            <tr><td>McCabe modular design</td><td>           1</td></tr>
269          </table>
[89]270         
271       
272        </div>
273       
274      </div>
275
276     
277
278      <div id="tagline">Produced by IDLdoc 2.0.</div>
279
280    </div>
281
282  </body>
[234]283</html>
Note: See TracBrowser for help on using the repository browser.