source: trunk/SRC/Documentation/idldoc_html_output/Picture/saveimage.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

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