| 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>saveimage.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="saveimage.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="../../../Picture//saveimage.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="imdisp.html"><<prev file</a> | <a href="showimage.html">next file >></a> <a href="saveimage.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">Picture/</a></h1> |
|---|
| 82 | <h2 class="pro_file">saveimage.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | Save the current graphics window to an output file (GIF by default). |
|---|
| 91 | |
|---|
| 92 | The output formats supported are: |
|---|
| 93 | GIF 8-bit with color table, |
|---|
| 94 | BMP 8-bit with color table, |
|---|
| 95 | PNG 8-bit with color table, |
|---|
| 96 | PICT 8-bit with color table, |
|---|
| 97 | JPEG 24-bit true color, |
|---|
| 98 | TIFF 24-bit true-color. |
|---|
| 99 | |
|---|
| 100 | Any conversions necessary to convert 8-bit or 24-bit images onscreen to |
|---|
| 101 | 8-bit or 24-bit output files are done automatically. |
|---|
| 102 | </div> |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | |
|---|
| 112 | <div id="routine_details"> |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | <div class="routine_details" id="_saveimage"> |
|---|
| 116 | |
|---|
| 117 | <h2><a class="top" href="#container">top</a>saveimage <span class="categories"> |
|---|
| 118 | Input/Output |
|---|
| 119 | </span></h2> |
|---|
| 120 | |
|---|
| 121 | <p class="header"> |
|---|
| 122 | saveimage<span class="result">, <a href="#_saveimage_param_FILE">FILE</a></span>, <a href="#_saveimage_keyword_BMP">BMP</a>=<span class="result">BMP</span>, <a href="#_saveimage_keyword_PNG">PNG</a>=<span class="result">PNG</span>, <a href="#_saveimage_keyword_PICT">PICT</a>=<span class="result">PICT</span>, <a href="#_saveimage_keyword_JPEG">JPEG</a>=<span class="result">JPEG</span>, <a href="#_saveimage_keyword_TIFF">TIFF</a>=<span class="result">TIFF</span>, <a href="#_saveimage_keyword_QUALITY">QUALITY</a>=<span class="result">QUALITY</span>, <a href="#_saveimage_keyword_DITHER">DITHER</a>=<span class="result">DITHER</span>, <a href="#_saveimage_keyword_CUBE">CUBE</a>=<span class="result">CUBE</span>, <a href="#_saveimage_keyword_QUIET">QUIET</a>=<span class="result">QUIET</span>, <a href="#_saveimage_keyword_MULTIPLE">MULTIPLE</a>=<span class="result">MULTIPLE</span></p> |
|---|
| 123 | |
|---|
| 124 | <div class="comments"> |
|---|
| 125 | </div> |
|---|
| 126 | |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | <h3>Parameters</h3> |
|---|
| 131 | |
|---|
| 132 | |
|---|
| 133 | <h4 id="_saveimage_param_FILE">FILE |
|---|
| 134 | <span class="attr">in</span> |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | <span class="attr">required</span> |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | <span class="attr">default:</span> <span class="value">format GIF</span> |
|---|
| 141 | |
|---|
| 142 | </h4> |
|---|
| 143 | |
|---|
| 144 | <div class="comments"> |
|---|
| 145 | Name of the output file |
|---|
| 146 | </div> |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | <h3>Keywords</h3> |
|---|
| 154 | |
|---|
| 155 | <h4 id="_saveimage_keyword_BMP">BMP |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | </h4> |
|---|
| 165 | |
|---|
| 166 | <div class="comments"> |
|---|
| 167 | Set this keyword to create BMP format (8-bit with color table). |
|---|
| 168 | </div> |
|---|
| 169 | |
|---|
| 170 | <h4 id="_saveimage_keyword_PNG">PNG |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | </h4> |
|---|
| 180 | |
|---|
| 181 | <div class="comments"> |
|---|
| 182 | Set this keyword to create PNG format (8-bit with color table). |
|---|
| 183 | </div> |
|---|
| 184 | |
|---|
| 185 | <h4 id="_saveimage_keyword_PICT">PICT |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | </h4> |
|---|
| 195 | |
|---|
| 196 | <div class="comments"> |
|---|
| 197 | Set this keyword to create PICT format (8-bit with color table). |
|---|
| 198 | </div> |
|---|
| 199 | |
|---|
| 200 | <h4 id="_saveimage_keyword_JPEG">JPEG |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | </h4> |
|---|
| 210 | |
|---|
| 211 | <div class="comments"> |
|---|
| 212 | Set this keyword to create JPEG format (24-bit true color). |
|---|
| 213 | </div> |
|---|
| 214 | |
|---|
| 215 | <h4 id="_saveimage_keyword_TIFF">TIFF |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | </h4> |
|---|
| 225 | |
|---|
| 226 | <div class="comments"> |
|---|
| 227 | Set this keyword to create TIFF format (24-bit true color). |
|---|
| 228 | </div> |
|---|
| 229 | |
|---|
| 230 | <h4 id="_saveimage_keyword_QUALITY">QUALITY |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | <span class="attr">default:</span> <span class="value">75</span> |
|---|
| 238 | |
|---|
| 239 | </h4> |
|---|
| 240 | |
|---|
| 241 | <div class="comments"> |
|---|
| 242 | If set to a named variable, specifies the quality for |
|---|
| 243 | JPEG output. Ranges from 0 ("terrible") to |
|---|
| 244 | 100 ("excellent"). Smaller quality values yield higher |
|---|
| 245 | compression ratios and smaller output files. |
|---|
| 246 | </div> |
|---|
| 247 | |
|---|
| 248 | <h4 id="_saveimage_keyword_DITHER">DITHER |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | <span class="attr">default:</span> <span class="value">no dithering</span> |
|---|
| 256 | |
|---|
| 257 | </h4> |
|---|
| 258 | |
|---|
| 259 | <div class="comments"> |
|---|
| 260 | If set, dither the output image when creating 8-bit output |
|---|
| 261 | which is read from a 24-bit display. |
|---|
| 262 | </div> |
|---|
| 263 | |
|---|
| 264 | <h4 id="_saveimage_keyword_CUBE">CUBE |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | </h4> |
|---|
| 274 | |
|---|
| 275 | <div class="comments"> {default=to use statistical method) |
|---|
| 276 | If set, use the color cube method to quantize colors when |
|---|
| 277 | creating 8-bit output which is read from a 24-bit display. |
|---|
| 278 | This may improve the accuracy of colors in the output image, |
|---|
| 279 | especially white. |
|---|
| 280 | </div> |
|---|
| 281 | |
|---|
| 282 | <h4 id="_saveimage_keyword_QUIET">QUIET |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | <span class="attr">default:</span> <span class="value">to print an information message</span> |
|---|
| 290 | |
|---|
| 291 | </h4> |
|---|
| 292 | |
|---|
| 293 | <div class="comments"> |
|---|
| 294 | Set this keyword to suppress the information message. |
|---|
| 295 | </div> |
|---|
| 296 | |
|---|
| 297 | <h4 id="_saveimage_keyword_MULTIPLE">MULTIPLE |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | </h4> |
|---|
| 307 | |
|---|
| 308 | <div class="comments"></div> |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | <h3>Examples</h3><div class="preformat"> |
|---|
| 313 | |
|---|
| 314 | IDL> openr, lun, filepath('hurric.dat', subdir='examples/data'), /get_lun |
|---|
| 315 | IDL> image = bytarr(440, 330) |
|---|
| 316 | IDL> readu, lun, image |
|---|
| 317 | IDL> free_lun, lun |
|---|
| 318 | IDL> loadct, 13 |
|---|
| 319 | IDL> tvscl, image |
|---|
| 320 | IDL> saveimage, 'hurric.gif' |
|---|
| 321 | </div> |
|---|
| 322 | <h3>Version history</h3> |
|---|
| 323 | |
|---|
| 324 | <h4>Version</h4><div class="preformat"> |
|---|
| 325 | $Id: saveimage.pro 371 2008-08-07 09:32:02Z pinsard $ |
|---|
| 326 | </div> |
|---|
| 327 | <h4>History</h4><div class="preformat"> |
|---|
| 328 | Liam.Gumley@ssec.wisc.edu |
|---|
| 329 | <a href="http://cimss.ssec.wisc.edu/~gumley/"/> |
|---|
| 330 | |
|---|
| 331 | This program is free software; you can redistribute it and/or |
|---|
| 332 | modify it under the terms of the GNU General Public License |
|---|
| 333 | as published by the Free Software Foundation; either version 2 |
|---|
| 334 | of the License, or (at your option) any later version. |
|---|
| 335 | |
|---|
| 336 | This program is distributed in the hope that it will be useful, |
|---|
| 337 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 338 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 339 | GNU General Public License for more details. |
|---|
| 340 | |
|---|
| 341 | You should have received a copy of the GNU General Public License |
|---|
| 342 | along with this program; if not, write to the Free Software |
|---|
| 343 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|---|
| 344 | </div> |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | <h3>Known issues</h3> |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | <h4>Restrictions</h4><div class="preformat"> |
|---|
| 352 | The output file is overwritten if it exists. |
|---|
| 353 | |
|---|
| 354 | requires IDL 5.0 or higher (square bracket array syntax). |
|---|
| 355 | </div> |
|---|
| 356 | |
|---|
| 357 | |
|---|
| 358 | |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | <h3>Statistics</h3> |
|---|
| 366 | <table class="statistics"> |
|---|
| 367 | <tr><td>McCabe cyclic</td><td> 37</td></tr> |
|---|
| 368 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 369 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 370 | </table> |
|---|
| 371 | |
|---|
| 372 | |
|---|
| 373 | </div> |
|---|
| 374 | |
|---|
| 375 | </div> |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | |
|---|
| 379 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 380 | |
|---|
| 381 | </div> |
|---|
| 382 | |
|---|
| 383 | </body> |
|---|
| 384 | </html> |
|---|
