source: trunk/SRC/Documentation/idldoc_html_output/Picture/showimage.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.9 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>showimage.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="showimage.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//showimage.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="saveimage.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="showimage.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">showimage.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Show the contents of a graphics file in the current window.
91
92    The input formats supported are:
93    GIF   8-bit with color table,
94    BMP   8-bit with color table or 24-bit true-color,
95    PICT  8-bit with color table,
96    TIFF  8-bit with color table or 24-bit true-color,
97    JPEG 24-bit true color,
98
99 Any conversions necessary to translate 8-bit or 24-bit files
100 to 8-bit or 24-bit images on-screen are done automatically.
101</div>
102
103     
104
105     
106
107     
108
109     
110
111      <div id="routine_details">
112       
113
114        <div class="routine_details" id="_showimage">
115
116          <h2><a class="top" href="#container">top</a>showimage <span class="categories"> 
117 Input/Output
118</span></h2>
119       
120          <p class="header">
121            showimage<span class="result">, <a href="#_showimage_param_FILE">FILE</a></span>, <a href="#_showimage_keyword_DITHER">DITHER</a>=<span class="result">DITHER</span>, <a href="#_showimage_keyword_CURRENT">CURRENT</a>=<span class="result">CURRENT</span></p>
122       
123          <div class="comments">
124</div>
125
126         
127
128         
129            <h3>Parameters</h3>
130       
131           
132            <h4 id="_showimage_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             
140             
141            </h4>
142       
143          <div class="comments">
144 Name of the output file (format is identified automatically).
145</div>
146           
147
148         
149
150         
151
152            <h3>Keywords</h3>
153           
154            <h4 id="_showimage_keyword_DITHER">DITHER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155             
156             
157             
158             
159             
160             
161              <span class="attr">default:</span> <span class="value">no dithering</span>
162             
163            </h4>
164       
165            <div class="comments">
166 Set this keyword to dither the input image when displaying
167 24-bit images on an 8-bit display.
168</div>
169           
170            <h4 id="_showimage_keyword_CURRENT">CURRENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171             
172             
173             
174             
175             
176             
177             
178             
179            </h4>
180       
181            <div class="comments">
182 Set this keyword to display the image in the current window
183 (default is to create a new window sized to fit the image).
184</div>
185           
186         
187
188          <h3>Examples</h3><div class="preformat">
189 IDL> showimage, filepath('rose.jpg', subdir='examples/data')
190</div>
191          <h3>Version history</h3>
192         
193          <h4>Version</h4><div class="preformat">
194 $Id: showimage.pro 325 2007-12-06 10:04:53Z pinsard $
195</div>
196          <h4>History</h4><div class="preformat">
197 Liam.Gumley@ssec.wisc.edu
198 <a href="http://cimss.ssec.wisc.edu/~gumley/"/>
199
200 This program is free software; you can redistribute it and/or
201 modify it under the terms of the GNU General Public License
202 as published by the Free Software Foundation; either version 2
203 of the License, or (at your option) any later version.
204
205 This program is distributed in the hope that it will be useful,
206 but WITHOUT ANY WARRANTY; without even the implied warranty of
207 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
208 GNU General Public License for more details.
209
210 You should have received a copy of the GNU General Public License
211 along with this program; if not, write to the Free Software
212 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
213</div>
214         
215         
216          <h3>Known issues</h3>
217         
218         
219         
220          <h4>Restrictions</h4><div class="preformat">
221 The color table is modified.
222
223
224 Requires IDL 5.2 or higher (image QUERY functions).
225</div>
226       
227         
228         
229         
230         
231         
232         
233         
234       
235          <h3>Statistics</h3>
236          <table class="statistics">
237            <tr><td>McCabe cyclic</td><td>          34</td></tr>
238            <tr><td>McCabe essential</td><td>           1</td></tr>
239            <tr><td>McCabe modular design</td><td>           1</td></tr>
240          </table>
241         
242       
243        </div>
244       
245      </div>
246
247     
248
249      <div id="tagline">Produced by IDLdoc 2.0.</div>
250
251    </div>
252
253  </body>
254</html>
Note: See TracBrowser for help on using the repository browser.