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

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

Main document available on top directory, Source links available in idldoc html output

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