[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>tracegrille.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="tracegrille.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="../../../../ToBeReviewed/GRILLE//tracegrille.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 documentation</td> |
---|
| 67 | </tr> |
---|
| 68 | </table> |
---|
| 69 | |
---|
| 70 | </div> |
---|
| 71 | |
---|
| 72 | <div id="secondary_navbar"> |
---|
| 73 | |
---|
[189] | 74 | <a href="t2v.html"><<prev file</a> | <a href="u2t.html">next file >></a> <a href="tracegrille.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a> summary: fields | routine 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">ToBeReviewed/GRILLE/</a></h1> |
---|
[89] | 82 | <h2 class="pro_file">tracegrille.pro</h2> |
---|
| 83 | |
---|
| 84 | <div id="file_attr"> |
---|
| 85 | <dl> |
---|
| 86 | </dl> |
---|
| 87 | </div> |
---|
| 88 | |
---|
[142] | 89 | <div id="file_comments"> |
---|
| 90 | Draw the grid |
---|
| 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="_tracegrille"> |
---|
| 105 | |
---|
[142] | 106 | <h2><a class="top" href="#container">top</a>tracegrille <span class="categories"> |
---|
[290] | 107 | Grid |
---|
[234] | 108 | </span></h2> |
---|
[89] | 109 | |
---|
| 110 | <p class="header"> |
---|
[249] | 111 | tracegrille<span class="result">[, <a href="#_tracegrille_param_glamin">glamin</a>][, <a href="#_tracegrille_param_gphiin">gphiin</a>]</span>, <a href="#_tracegrille_keyword_OCEAN">OCEAN</a>=<span class="result">OCEAN</span>, <a href="#_tracegrille_keyword_EARTH">EARTH</a>=<span class="result">EARTH</span>, <a href="#_tracegrille_keyword_XSTRIDE">XSTRIDE</a>=<span class="result">integer</span>, <a href="#_tracegrille_keyword_YSTRIDE">YSTRIDE</a>=<span class="result">integer</span>, <a href="#_tracegrille_keyword_RMOUT">RMOUT</a>=<span class="result">RMOUT</span>, <a href="#_tracegrille_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
---|
[89] | 112 | |
---|
| 113 | <div class="comments"> |
---|
| 114 | </div> |
---|
| 115 | |
---|
| 116 | |
---|
| 117 | |
---|
| 118 | |
---|
| 119 | <h3>Parameters</h3> |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | <h4 id="_tracegrille_param_glamin">glamin |
---|
[142] | 123 | <span class="attr">in</span> |
---|
[89] | 124 | |
---|
[249] | 125 | <span class="attr">optional</span> |
---|
[89] | 126 | |
---|
| 127 | |
---|
[249] | 128 | <span class="attr">type:</span> <span class="value">1d or 2d array</span> |
---|
[290] | 129 | <span class="attr">default:</span> <span class="value">glam specified by vargrid, on the domain defined by <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a></span> |
---|
[89] | 130 | |
---|
| 131 | </h4> |
---|
| 132 | |
---|
[142] | 133 | <div class="comments"> |
---|
[249] | 134 | Longitude of points of the grid. |
---|
[142] | 135 | </div> |
---|
[89] | 136 | |
---|
| 137 | <h4 id="_tracegrille_param_gphiin">gphiin |
---|
[142] | 138 | <span class="attr">in</span> |
---|
[89] | 139 | |
---|
[249] | 140 | <span class="attr">optional</span> |
---|
[89] | 141 | |
---|
| 142 | |
---|
[249] | 143 | <span class="attr">type:</span> <span class="value">1d or 2d array</span> |
---|
[290] | 144 | <span class="attr">default:</span> <span class="value">gphi specified by vargrid, on the domain defined by <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a></span> |
---|
[89] | 145 | |
---|
| 146 | </h4> |
---|
| 147 | |
---|
[142] | 148 | <div class="comments"> |
---|
[249] | 149 | Latitude of points of the grid. |
---|
[142] | 150 | </div> |
---|
[89] | 151 | |
---|
| 152 | |
---|
| 153 | |
---|
| 154 | |
---|
| 155 | |
---|
| 156 | |
---|
| 157 | <h3>Keywords</h3> |
---|
| 158 | |
---|
| 159 | <h4 id="_tracegrille_keyword_OCEAN">OCEAN |
---|
| 160 | |
---|
| 161 | |
---|
| 162 | |
---|
| 163 | |
---|
| 164 | |
---|
| 165 | |
---|
| 166 | |
---|
| 167 | |
---|
| 168 | </h4> |
---|
| 169 | |
---|
[234] | 170 | <div class="comments"> |
---|
[142] | 171 | To trace the grid only on ocean points. |
---|
[234] | 172 | </div> |
---|
[89] | 173 | |
---|
| 174 | <h4 id="_tracegrille_keyword_EARTH">EARTH |
---|
| 175 | |
---|
| 176 | |
---|
| 177 | |
---|
| 178 | |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | </h4> |
---|
| 184 | |
---|
[142] | 185 | <div class="comments"> |
---|
[163] | 186 | To trace the grid only on land points. |
---|
[142] | 187 | </div> |
---|
[89] | 188 | |
---|
| 189 | <h4 id="_tracegrille_keyword_XSTRIDE">XSTRIDE |
---|
| 190 | |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | |
---|
| 194 | |
---|
[163] | 195 | <span class="attr">type:</span> <span class="value">integer</span> |
---|
[249] | 196 | <span class="attr">default:</span> <span class="value">1</span> |
---|
[89] | 197 | |
---|
| 198 | </h4> |
---|
| 199 | |
---|
[234] | 200 | <div class="comments"> |
---|
| 201 | It specify that we want to trace only one line of |
---|
[142] | 202 | constant i every xstride points |
---|
| 203 | </div> |
---|
[89] | 204 | |
---|
| 205 | <h4 id="_tracegrille_keyword_YSTRIDE">YSTRIDE |
---|
| 206 | |
---|
| 207 | |
---|
| 208 | |
---|
| 209 | |
---|
| 210 | |
---|
[163] | 211 | <span class="attr">type:</span> <span class="value">integer</span> |
---|
[249] | 212 | <span class="attr">default:</span> <span class="value">1</span> |
---|
[89] | 213 | |
---|
| 214 | </h4> |
---|
| 215 | |
---|
[163] | 216 | <div class="comments"> |
---|
[234] | 217 | It specify that we want to trace only one line of |
---|
[402] | 218 | constant j every ystride points |
---|
[142] | 219 | </div> |
---|
[89] | 220 | |
---|
| 221 | <h4 id="_tracegrille_keyword_RMOUT">RMOUT |
---|
| 222 | |
---|
| 223 | |
---|
| 224 | |
---|
| 225 | |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | |
---|
| 229 | |
---|
| 230 | </h4> |
---|
| 231 | |
---|
[142] | 232 | <div class="comments"> |
---|
| 233 | Select to remove all cell having one corner out of the |
---|
| 234 | plot boundaries (!x.range, !y.range) |
---|
| 235 | </div> |
---|
[89] | 236 | |
---|
[234] | 237 | <h4 id="_tracegrille_keyword__EXTRA">_EXTRA |
---|
[89] | 238 | |
---|
| 239 | |
---|
| 240 | |
---|
| 241 | |
---|
| 242 | |
---|
| 243 | |
---|
| 244 | |
---|
| 245 | |
---|
| 246 | </h4> |
---|
| 247 | |
---|
[142] | 248 | <div class="comments"> |
---|
[234] | 249 | Used to pass keywords |
---|
| 250 | </div> |
---|
[89] | 251 | |
---|
| 252 | |
---|
| 253 | |
---|
[142] | 254 | <h3>Examples</h3><div class="preformat"> |
---|
| 255 | |
---|
[402] | 256 | IDL> plt,indgen(jpi,jpj),/nocontour,/nofill |
---|
| 257 | IDL> vargrid='T' |
---|
| 258 | IDL> tracegrille,/ocean,color=20 |
---|
| 259 | IDL> tracegrille,/earth,color=80 |
---|
[142] | 260 | </div> |
---|
| 261 | <h3>Version history</h3> |
---|
[89] | 262 | |
---|
[142] | 263 | <h4>Version</h4><div class="preformat"> |
---|
[402] | 264 | $Id: tracegrille.pro 378 2008-08-12 12:35:46Z pinsard $ |
---|
[234] | 265 | </div> |
---|
[157] | 266 | <h4>History</h4><div class="preformat"> |
---|
| 267 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
| 268 | </div> |
---|
[89] | 269 | |
---|
| 270 | |
---|
| 271 | |
---|
| 272 | |
---|
| 273 | |
---|
| 274 | |
---|
| 275 | |
---|
| 276 | |
---|
[142] | 277 | <h3>Other attributes</h3> |
---|
[89] | 278 | |
---|
| 279 | |
---|
[142] | 280 | <h4>Uses routines</h4><div class="preformat"> |
---|
[402] | 281 | <a href="../..//Obsolete/common.html">common</a> |
---|
[234] | 282 | </div> |
---|
[89] | 283 | |
---|
| 284 | |
---|
| 285 | |
---|
| 286 | |
---|
[163] | 287 | <h3>Statistics</h3> |
---|
| 288 | <table class="statistics"> |
---|
| 289 | <tr><td>McCabe cyclic</td><td> 34</td></tr> |
---|
| 290 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 291 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 292 | </table> |
---|
[89] | 293 | |
---|
| 294 | |
---|
| 295 | </div> |
---|
| 296 | |
---|
| 297 | </div> |
---|
| 298 | |
---|
| 299 | |
---|
| 300 | |
---|
| 301 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 302 | |
---|
| 303 | </div> |
---|
| 304 | |
---|
| 305 | </body> |
---|
[249] | 306 | </html> |
---|