| 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>tvplus.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="tvplus.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="../../../../../ToBeReviewed/PLOTS/DESSINE//tvplus.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 documentation</td> |
|---|
| 67 | </tr> |
|---|
| 68 | </table> |
|---|
| 69 | |
|---|
| 70 | </div> |
|---|
| 71 | |
|---|
| 72 | <div id="secondary_navbar"> |
|---|
| 73 | |
|---|
| 74 | <a href="splot.html"><<prev file</a> | next file >> <a href="tvplus.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> |
|---|
| 75 | |
|---|
| 76 | </div> |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | <div id="container"> |
|---|
| 80 | |
|---|
| 81 | <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/PLOTS/DESSINE/</a></h1> |
|---|
| 82 | <h2 class="pro_file">tvplus.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | Enhanced version of tvscl |
|---|
| 91 | </div> |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | <div id="routine_details"> |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | <div class="routine_details" id="_tvplus"> |
|---|
| 105 | |
|---|
| 106 | <h2><a class="top" href="#container">top</a>tvplus <span class="categories"> quick exploration of 2D arrays |
|---|
| 107 | |
|---|
| 108 | INPUTS: |
|---|
| 109 | </span></h2> |
|---|
| 110 | |
|---|
| 111 | <p class="header"> |
|---|
| 112 | tvplus<span class="result">, <a href="#_tvplus_param_z2d">z2d</a>[, <a href="#_tvplus_param_cellsize">cellsize</a>]</span>, <a href="#_tvplus_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_tvplus_keyword_C_MASK">C_MASK</a>=<span class="result">C_MASK</span>, <a href="#_tvplus_keyword_C_NAN">C_NAN</a>=<span class="result">C_NAN</span>, <a href="#_tvplus_keyword_WINDOW">WINDOW</a>=<span class="result">WINDOW</span>, <a href="#_tvplus_keyword_MIN">MIN</a>=<span class="result">MIN</span>, <a href="#_tvplus_keyword_MAX">MAX</a>=<span class="result">MAX</span>, <a href="#_tvplus_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_tvplus_keyword_OFFSET">OFFSET</a>=<span class="result">OFFSET</span>, <a href="#_tvplus_keyword_NOUSEINFOS">NOUSEINFOS</a>=<span class="result">NOUSEINFOS</span>, <a href="#_tvplus_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_tvplus_keyword_NOINTERP">NOINTERP</a>=<span class="result">NOINTERP</span>, <a href="#_tvplus_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
|---|
| 113 | |
|---|
| 114 | <div class="comments"> |
|---|
| 115 | </div> |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | <h3>Parameters</h3> |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | <h4 id="_tvplus_param_z2d">z2d |
|---|
| 124 | <span class="attr">in</span> |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | <span class="attr">required</span> |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | </h4> |
|---|
| 133 | |
|---|
| 134 | <div class="comments"> |
|---|
| 135 | 2D array to visualize |
|---|
| 136 | </div> |
|---|
| 137 | |
|---|
| 138 | <h4 id="_tvplus_param_cellsize">cellsize |
|---|
| 139 | <span class="attr">in</span> |
|---|
| 140 | |
|---|
| 141 | <span class="attr">optional</span> |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | </h4> |
|---|
| 148 | |
|---|
| 149 | <div class="comments"> |
|---|
| 150 | This is the size (in pixel) of the square |
|---|
| 151 | representing 1 array element. By default, this size is computed |
|---|
| 152 | automatically in order that the size of the plotting window do |
|---|
| 153 | not exceed the screen size. If the user specify a large value |
|---|
| 154 | of cellsize that forces tvplus to create a window larger than |
|---|
| 155 | the screen, a "scrolling window" will be displayed instead of a |
|---|
| 156 | regular window. Unfortunately the nice functionnalities of tvplus |
|---|
| 157 | are not coded for "scrolling window" case... |
|---|
| 158 | </div> |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | <h3>Keywords</h3> |
|---|
| 166 | |
|---|
| 167 | <h4 id="_tvplus_keyword_BOTTOM">BOTTOM |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | <span class="attr">default:</span> <span class="value">1</span> |
|---|
| 175 | |
|---|
| 176 | </h4> |
|---|
| 177 | |
|---|
| 178 | <div class="comments"> |
|---|
| 179 | The lowest color index of the colors to be used |
|---|
| 180 | </div> |
|---|
| 181 | |
|---|
| 182 | <h4 id="_tvplus_keyword_C_MASK">C_MASK |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | <span class="attr">default:</span> <span class="value">0</span> |
|---|
| 190 | |
|---|
| 191 | </h4> |
|---|
| 192 | |
|---|
| 193 | <div class="comments"> |
|---|
| 194 | The color number that should be used for the mask values. |
|---|
| 195 | </div> |
|---|
| 196 | |
|---|
| 197 | <h4 id="_tvplus_keyword_C_NAN">C_NAN |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | <span class="attr">default:</span> <span class="value">!d.n_colors < 255</span> |
|---|
| 205 | |
|---|
| 206 | </h4> |
|---|
| 207 | |
|---|
| 208 | <div class="comments"> |
|---|
| 209 | The color number that should be used for the NaN values. |
|---|
| 210 | </div> |
|---|
| 211 | |
|---|
| 212 | <h4 id="_tvplus_keyword_WINDOW">WINDOW |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | </h4> |
|---|
| 222 | |
|---|
| 223 | <div class="comments"> |
|---|
| 224 | Number of the window used to display the array values. |
|---|
| 225 | default is window number 0. |
|---|
| 226 | </div> |
|---|
| 227 | |
|---|
| 228 | <h4 id="_tvplus_keyword_MIN">MIN |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | </h4> |
|---|
| 238 | |
|---|
| 239 | <div class="comments"> |
|---|
| 240 | Scalar used to specify the min value to be drawn. |
|---|
| 241 | </div> |
|---|
| 242 | |
|---|
| 243 | <h4 id="_tvplus_keyword_MAX">MAX |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | </h4> |
|---|
| 253 | |
|---|
| 254 | <div class="comments"> |
|---|
| 255 | Scalar used to specify the max value to be drawn. |
|---|
| 256 | </div> |
|---|
| 257 | |
|---|
| 258 | <h4 id="_tvplus_keyword_MASK">MASK |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | </h4> |
|---|
| 268 | |
|---|
| 269 | <div class="comments"> |
|---|
| 270 | The mask value. Note that if abs(mask) < 1.e6, then the |
|---|
| 271 | exact value of the mask is used to find the maskwd point. |
|---|
| 272 | if abs(mask) > 1.e6, the test to find the masked value is ge |
|---|
| 273 | abs(mask)/10. This is necessary to avoid the rounding errors |
|---|
| 274 | </div> |
|---|
| 275 | |
|---|
| 276 | <h4 id="_tvplus_keyword_OFFSET">OFFSET |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | </h4> |
|---|
| 286 | |
|---|
| 287 | <div class="comments"> |
|---|
| 288 | 2 elements vector used by tvplus itself when showing zoom. |
|---|
| 289 | It is used to shift the ranges of xaxis and yaxis. |
|---|
| 290 | For example: tvplus,sst[x1:x2,y1:y2],offest=[x1,y1] |
|---|
| 291 | </div> |
|---|
| 292 | |
|---|
| 293 | <h4 id="_tvplus_keyword_NOUSEINFOS">NOUSEINFOS |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | </h4> |
|---|
| 303 | |
|---|
| 304 | <div class="comments"> |
|---|
| 305 | Activate to suppress the printed message explaining how to use tvplus |
|---|
| 306 | </div> |
|---|
| 307 | |
|---|
| 308 | <h4 id="_tvplus_keyword_NCOLORS">NCOLORS |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | <span class="attr">default:</span> <span class="value">(d.n_colors < 256) - 1 - bottom</span> |
|---|
| 316 | |
|---|
| 317 | </h4> |
|---|
| 318 | |
|---|
| 319 | <div class="comments"> |
|---|
| 320 | number of colors to be used. |
|---|
| 321 | </div> |
|---|
| 322 | |
|---|
| 323 | <h4 id="_tvplus_keyword_NOINTERP">NOINTERP |
|---|
| 324 | |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | </h4> |
|---|
| 333 | |
|---|
| 334 | <div class="comments"> |
|---|
| 335 | Used this keyword if you don't want that the values |
|---|
| 336 | are interpolated from BOTTOM using NCOLORS colors. |
|---|
| 337 | This can be for example useful when working on byte type arrays. |
|---|
| 338 | </div> |
|---|
| 339 | |
|---|
| 340 | <h4 id="_tvplus_keyword__EXTRA">_EXTRA |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | </h4> |
|---|
| 350 | |
|---|
| 351 | <div class="comments"> |
|---|
| 352 | used to pass keywords to TV, PLOT, COLORBAR |
|---|
| 353 | </div> |
|---|
| 354 | |
|---|
| 355 | |
|---|
| 356 | |
|---|
| 357 | <h3>Examples</h3><div class="preformat"> |
|---|
| 358 | IDL> tvplus, dist(100) |
|---|
| 359 | </div> |
|---|
| 360 | <h3>Version history</h3> |
|---|
| 361 | |
|---|
| 362 | <h4>Version</h4><div class="preformat"> |
|---|
| 363 | $Id: tvplus.pro 163 2006-08-29 12:59:46Z navarro $ |
|---|
| 364 | </div> |
|---|
| 365 | <h4>History</h4><div class="preformat"> |
|---|
| 366 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 367 | 18/12/98 |
|---|
| 368 | Aug 2005: quick cleaning + english |
|---|
| 369 | </div> |
|---|
| 370 | |
|---|
| 371 | |
|---|
| 372 | <h3>Known issues</h3> |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | <h4>Restrictions</h4><div class="preformat"> |
|---|
| 377 | use your mouse to scan the array values... |
|---|
| 378 | left button : mouse position and associated array value |
|---|
| 379 | middle button: use it twice to define a zoom box |
|---|
| 380 | right button : quit |
|---|
| 381 | |
|---|
| 382 | the nice functionnalities of tvplus are not coded |
|---|
| 383 | for "scrolling window" case... |
|---|
| 384 | </div> |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | <h3>Statistics</h3> |
|---|
| 395 | <table class="statistics"> |
|---|
| 396 | <tr><td>McCabe cyclic</td><td> 47</td></tr> |
|---|
| 397 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 398 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 399 | </table> |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | </div> |
|---|
| 403 | |
|---|
| 404 | </div> |
|---|
| 405 | |
|---|
| 406 | |
|---|
| 407 | |
|---|
| 408 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 409 | |
|---|
| 410 | </div> |
|---|
| 411 | |
|---|
| 412 | </body> |
|---|
| 413 | </html> |
|---|
