[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> |
---|
| 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 documentation</td> |
---|
| 67 | </tr> |
---|
| 68 | </table> |
---|
| 69 | |
---|
| 70 | </div> |
---|
| 71 | |
---|
| 72 | <div id="secondary_navbar"> |
---|
| 73 | |
---|
| 74 | <a href="angle.html"><<prev file</a> | <a href="compute_fromreg_bilinear_weigaddr.html">next file >></a> <a href="clickincell.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine 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 | |
---|
[101] | 89 | <div id="file_comments"> click on a map and find in which cell the click was |
---|
| 90 | </div> |
---|
[89] | 91 | |
---|
| 92 | |
---|
| 93 | |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | <div id="routine_details"> |
---|
| 101 | |
---|
| 102 | |
---|
| 103 | <div class="routine_details" id="_clickincell"> |
---|
| 104 | |
---|
[101] | 105 | <h2><a class="top" href="#container">top</a>clickincell <span class="categories"> finding where is a point on a grid |
---|
| 106 | </span></h2> |
---|
[89] | 107 | |
---|
| 108 | <p class="header"> |
---|
| 109 | <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> |
---|
| 110 | |
---|
[101] | 111 | <div class="comments"></div> |
---|
[89] | 112 | |
---|
[101] | 113 | <h3>Return value</h3><div class="value"> |
---|
| 114 | the index of the selected cells regarding to the grid which |
---|
[89] | 115 | is in memory in the variable of the common. If /ij keyword is |
---|
| 116 | activated give 2D array (2, n) which are the i,j position of the |
---|
| 117 | n selected cells. |
---|
[101] | 118 | </div> |
---|
[89] | 119 | |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | |
---|
| 124 | <h3>Keywords</h3> |
---|
| 125 | |
---|
| 126 | <h4 id="_clickincell_keyword_CELLTYPE">CELLTYPE |
---|
| 127 | |
---|
| 128 | |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | |
---|
| 133 | |
---|
| 134 | |
---|
| 135 | </h4> |
---|
| 136 | |
---|
[101] | 137 | <div class="comments"> = 'T', 'W', 'U', 'V' or 'F' This this the type of point |
---|
| 138 | that is located in the center of the cell which the click is |
---|
| 139 | located. default is T type of cell (with corner defined by F |
---|
| 140 | points). |
---|
| 141 | </div> |
---|
[89] | 142 | |
---|
| 143 | <h4 id="_clickincell_keyword_DRAWCELL">DRAWCELL |
---|
| 144 | |
---|
| 145 | |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | </h4> |
---|
| 153 | |
---|
[101] | 154 | <div class="comments"> to draw the cell in which we clicked |
---|
| 155 | </div> |
---|
[89] | 156 | |
---|
| 157 | <h4 id="_clickincell_keyword_COLOR">COLOR |
---|
| 158 | |
---|
| 159 | |
---|
| 160 | |
---|
| 161 | |
---|
| 162 | |
---|
| 163 | |
---|
| 164 | |
---|
| 165 | |
---|
| 166 | </h4> |
---|
| 167 | |
---|
[101] | 168 | <div class="comments"> the color used to draw the cells (Clicking one more |
---|
| 169 | time in the same cell will draw the cell with the white color) |
---|
| 170 | </div> |
---|
[89] | 171 | |
---|
| 172 | <h4 id="_clickincell_keyword_ORIGINAL">ORIGINAL |
---|
| 173 | |
---|
| 174 | |
---|
| 175 | |
---|
| 176 | |
---|
| 177 | |
---|
| 178 | |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | </h4> |
---|
| 182 | |
---|
[101] | 183 | <div class="comments"> to get the position of the cell regarding the original |
---|
| 184 | grid (with no key_shift, ixminmesh, iyminmesh...) |
---|
| 185 | </div> |
---|
[89] | 186 | |
---|
| 187 | <h4 id="_clickincell_keyword_IJ">IJ |
---|
| 188 | |
---|
| 189 | |
---|
| 190 | |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | </h4> |
---|
| 197 | |
---|
[101] | 198 | <div class="comments"> see outpus |
---|
| 199 | </div> |
---|
[89] | 200 | |
---|
| 201 | <h4 id="_clickincell_keyword__EXTRA">_EXTRA |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | |
---|
| 205 | |
---|
| 206 | |
---|
| 207 | |
---|
| 208 | |
---|
| 209 | |
---|
| 210 | </h4> |
---|
| 211 | |
---|
[101] | 212 | <div class="comments"> to pass extra keywords to inquad and plot (when /drawcell) |
---|
| 213 | </div> |
---|
[89] | 214 | |
---|
| 215 | |
---|
| 216 | |
---|
[101] | 217 | <h3>Examples</h3><div class="value"> |
---|
| 218 | |
---|
| 219 | res = clickincell() |
---|
| 220 | Click with the left button to select a cell. Clicking one more |
---|
| 221 | time in the same cell remove the cell from the selection. |
---|
| 222 | Click on the right button to quit. |
---|
| 223 | |
---|
| 224 | |
---|
| 225 | |
---|
| 226 | IDL> plt, findgen(jpi,jpj),/nodata,map=[90,0,0],/ortho |
---|
| 227 | IDL> print, clickincell(/draw,color=150,/xy) |
---|
| 228 | </div> |
---|
| 229 | <h3>Version history</h3> |
---|
[89] | 230 | |
---|
| 231 | |
---|
[101] | 232 | <h4>History</h4><div class="value"> |
---|
| 233 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
| 234 | August 2003 |
---|
| 235 | </div> |
---|
[89] | 236 | |
---|
| 237 | |
---|
| 238 | |
---|
| 239 | |
---|
| 240 | |
---|
| 241 | |
---|
| 242 | |
---|
| 243 | |
---|
[101] | 244 | <h3>Other attributes</h3> |
---|
[89] | 245 | |
---|
| 246 | |
---|
[101] | 247 | <h4>Uses routines</h4><div class="value"> common.pro |
---|
| 248 | </div> |
---|
[89] | 249 | |
---|
| 250 | |
---|
| 251 | |
---|
| 252 | |
---|
| 253 | |
---|
| 254 | |
---|
| 255 | </div> |
---|
| 256 | |
---|
| 257 | </div> |
---|
| 258 | |
---|
| 259 | |
---|
| 260 | |
---|
| 261 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 262 | |
---|
| 263 | </div> |
---|
| 264 | |
---|
| 265 | </body> |
---|
| 266 | </html> |
---|