source: trunk/SRC/Documentation/idldoc_assistant_output/Picture/saveimage.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 7.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>saveimage.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="imdisp.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="showimage.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Picture/</font></h1>
58    <h2>saveimage.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Save the current graphics window to an output file (GIF by default).
65
66    The output formats supported are:
67    GIF   8-bit with color table,
68    BMP   8-bit with color table,
69    PNG   8-bit with color table,
70    PICT  8-bit with color table,
71    JPEG 24-bit true color,
72    TIFF 24-bit true-color.
73
74    Any conversions necessary to convert 8-bit or 24-bit images onscreen to
75    8-bit or 24-bit output files are done automatically.
76
77
78   
79
80     
81      <a name="#_saveimage"></a>
82
83      <h2>saveimage  <font size="-1" color="#006633">
84 Input/Output
85</font></h2>
86
87      <p><font face="Courier">saveimage<i>, <a href="#_saveimage_keyword_FILE">FILE</a></i>, <a href="#_saveimage_keyword_BMP">BMP</a>=<i>BMP</i>, <a href="#_saveimage_keyword_PNG">PNG</a>=<i>PNG</i>, <a href="#_saveimage_keyword_PICT">PICT</a>=<i>PICT</i>, <a href="#_saveimage_keyword_JPEG">JPEG</a>=<i>JPEG</i>, <a href="#_saveimage_keyword_TIFF">TIFF</a>=<i>TIFF</i>, <a href="#_saveimage_keyword_QUALITY">QUALITY</a>=<i>QUALITY</i>, <a href="#_saveimage_keyword_DITHER">DITHER</a>=<i>DITHER</i>, <a href="#_saveimage_keyword_CUBE">CUBE</a>=<i>CUBE</i>, <a href="#_saveimage_keyword_QUIET">QUIET</a>=<i>QUIET</i>, <a href="#_saveimage_keyword_MULTIPLE">MULTIPLE</a>=<i>MULTIPLE</i></font></p>
88
89   
90
91
92   
93
94   
95    <h3>Parameters</h3>
96   
97
98    <a name="#_saveimage_keyword_FILE"></a>
99    <h4>FILE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
100      <font size="-1" color="#006633">in</font>
101     
102     
103      <font size="-1" color="#006633">required</font>
104     
105     
106      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>format GIF</i></font>
107     
108    </h4>
109
110   
111 Name of the output file
112
113   
114   
115
116   
117    <h3>Keywords</h3>
118
119   
120    <a name="#_saveimage_keyword_BMP"></a>
121    <h4>BMP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122     
123     
124     
125     
126     
127     
128     
129     
130    </h4>
131
132   
133 Set this keyword to create BMP format (8-bit with color table).
134
135   
136    <a name="#_saveimage_keyword_PNG"></a>
137    <h4>PNG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138     
139     
140     
141     
142     
143     
144     
145     
146    </h4>
147
148   
149 Set this keyword to create PNG format (8-bit with color table).
150
151   
152    <a name="#_saveimage_keyword_PICT"></a>
153    <h4>PICT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154     
155     
156     
157     
158     
159     
160     
161     
162    </h4>
163
164   
165 Set this keyword to create PICT format (8-bit with color table).
166
167   
168    <a name="#_saveimage_keyword_JPEG"></a>
169    <h4>JPEG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170     
171     
172     
173     
174     
175     
176     
177     
178    </h4>
179
180   
181 Set this keyword to create JPEG format (24-bit true color).
182
183   
184    <a name="#_saveimage_keyword_TIFF"></a>
185    <h4>TIFF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186     
187     
188     
189     
190     
191     
192     
193     
194    </h4>
195
196   
197 Set this keyword to create TIFF format (24-bit true color).
198
199   
200    <a name="#_saveimage_keyword_QUALITY"></a>
201    <h4>QUALITY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202     
203     
204     
205     
206     
207     
208      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>75</i></font>
209     
210    </h4>
211
212   
213 If set to a named variable, specifies the quality for
214 JPEG output. Ranges from 0 ("terrible") to
215 100 ("excellent"). Smaller quality values yield higher
216 compression ratios and smaller output files.
217
218   
219    <a name="#_saveimage_keyword_DITHER"></a>
220    <h4>DITHER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221     
222     
223     
224     
225     
226     
227      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>no dithering</i></font>
228     
229    </h4>
230
231   
232 If set, dither the output image when creating 8-bit output
233 which is read from a 24-bit display.
234
235   
236    <a name="#_saveimage_keyword_CUBE"></a>
237    <h4>CUBE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238     
239     
240     
241     
242     
243     
244     
245     
246    </h4>
247
248     {default=to use statistical method)
249 If set, use the color cube method to quantize colors when
250 creating 8-bit output which is read from a 24-bit display.
251 This may improve the accuracy of colors in the output image,
252 especially white.
253
254   
255    <a name="#_saveimage_keyword_QUIET"></a>
256    <h4>QUIET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257     
258     
259     
260     
261     
262     
263      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>to print an information message</i></font>
264     
265    </h4>
266
267   
268 Set this keyword to suppress the information message.
269
270   
271    <a name="#_saveimage_keyword_MULTIPLE"></a>
272    <h4>MULTIPLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
273     
274     
275     
276     
277     
278     
279     
280     
281    </h4>
282
283   
284   
285   
286
287    <h3>Examples</h3><pre>
288
289   IDL> openr, lun, filepath('hurric.dat', subdir='examples/data'), /get_lun
290   IDL> image = bytarr(440, 330)
291   IDL> readu, lun, image
292   IDL> free_lun, lun
293   IDL> loadct, 13
294   IDL> tvscl, image
295   IDL> saveimage, 'hurric.gif'
296
297    </pre><h3>Version history</h3>
298   
299    <h4>Version</h4>
300 $Id: saveimage.pro 371 2008-08-07 09:32:02Z pinsard $
301
302    <h4>History</h4>
303 Liam.Gumley@ssec.wisc.edu
304 <a href="http://cimss.ssec.wisc.edu/~gumley/"/>
305
306 This program is free software; you can redistribute it and/or
307 modify it under the terms of the GNU General Public License
308 as published by the Free Software Foundation; either version 2
309 of the License, or (at your option) any later version.
310
311 This program is distributed in the hope that it will be useful,
312 but WITHOUT ANY WARRANTY; without even the implied warranty of
313 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
314 GNU General Public License for more details.
315
316 You should have received a copy of the GNU General Public License
317 along with this program; if not, write to the Free Software
318 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
319
320   
321
322    <h3>Known issues</h3>
323   
324   
325   
326    <h4>Restrictions</h4>
327 The output file is overwritten if it exists.
328
329 requires IDL 5.0 or higher (square bracket array syntax).
330
331
332   
333   
334   
335   
336   
337   
338   
339
340    <font size="-3"><p>&nbsp;</p></font>
341    <hr size="1" color="#CCCCCC"/>
342     
343
344   
345
346    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
347
348  </body>
349</html>
Note: See TracBrowser for help on using the repository browser.