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

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

update documentation
File size: 4.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>showimage.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="saveimage.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=""><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>showimage.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Show the contents of a graphics file in the current window.
65
66    The input formats supported are:
67    GIF   8-bit with color table,
68    BMP   8-bit with color table or 24-bit true-color,
69    PICT  8-bit with color table,
70    TIFF  8-bit with color table or 24-bit true-color,
71    JPEG 24-bit true color,
72
73 Any conversions necessary to translate 8-bit or 24-bit files
74 to 8-bit or 24-bit images on-screen are done automatically.
75
76
77   
78
79     
80      <a name="#_showimage"></a>
81
82      <h2>showimage  <font size="-1" color="#006633"> 
83 Input/Output
84</font></h2>
85
86      <p><font face="Courier">showimage<i>, <a href="#_showimage_keyword_FILE">FILE</a></i>, <a href="#_showimage_keyword_DITHER">DITHER</a>=<i>DITHER</i>, <a href="#_showimage_keyword_CURRENT">CURRENT</a>=<i>CURRENT</i></font></p>
87
88   
89
90
91   
92
93   
94    <h3>Parameters</h3>
95   
96
97    <a name="#_showimage_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     
106     
107    </h4>
108
109   
110 Name of the output file (format is identified automatically).
111
112   
113   
114
115   
116    <h3>Keywords</h3>
117
118   
119    <a name="#_showimage_keyword_DITHER"></a>
120    <h4>DITHER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121     
122     
123     
124     
125     
126     
127      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>no dithering</i></font>
128     
129    </h4>
130
131   
132 Set this keyword to dither the input image when displaying
133 24-bit images on an 8-bit display.
134
135   
136    <a name="#_showimage_keyword_CURRENT"></a>
137    <h4>CURRENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138     
139     
140     
141     
142     
143     
144     
145     
146    </h4>
147
148   
149 Set this keyword to display the image in the current window
150 (default is to create a new window sized to fit the image).
151
152   
153   
154
155    <h3>Examples</h3><pre>
156
157   IDL> showimage, filepath('rose.jpg', subdir='examples/data')
158
159    </pre><h3>Version history</h3>
160   
161    <h4>Version</h4>
162 $Id: showimage.pro 371 2008-08-07 09:32:02Z pinsard $
163
164    <h4>History</h4>
165 Liam.Gumley@ssec.wisc.edu
166 <a href="http://cimss.ssec.wisc.edu/~gumley/"/>
167
168 This program is free software; you can redistribute it and/or
169 modify it under the terms of the GNU General Public License
170 as published by the Free Software Foundation; either version 2
171 of the License, or (at your option) any later version.
172
173 This program is distributed in the hope that it will be useful,
174 but WITHOUT ANY WARRANTY; without even the implied warranty of
175 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
176 GNU General Public License for more details.
177
178 You should have received a copy of the GNU General Public License
179 along with this program; if not, write to the Free Software
180 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
181
182   
183
184    <h3>Known issues</h3>
185   
186   
187   
188    <h4>Restrictions</h4>
189 The color table is modified.
190
191
192 Requires IDL 5.2 or higher (image QUERY functions).
193
194
195   
196   
197   
198   
199   
200   
201   
202
203    <font size="-3"><p>&nbsp;</p></font>
204    <hr size="1" color="#CCCCCC"/>
205     
206
207   
208
209    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
210
211  </body>
212</html>
Note: See TracBrowser for help on using the repository browser.