source: trunk/SRC/Documentation/idldoc_assistant_output/Picture/image_viewer.html

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

update documentation

File size: 10.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>image_viewer.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=""><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="imdisp.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>image_viewer.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 The purpose of this program is to provide an interactive tool that can be used
65 to view JPEG, BMP, GIF, PNG, and TIFF picture files.  Images are loaded into
66 memory, so the initial file access may take a while, but once each picture has
67 been opened they can all be viewed in a very rapid fashion.
68
69
70   
71    <h2>Routine summary</h2>
72
73    <dl>
74     
75      <dt><a href="#_image_viewer_open_files">image_viewer_open_files<i>, event</i></a><dt>
76      <dd><font size="-1"> </font></dd>
77     
78      <dt><a href="#_image_viewer_open_folder">image_viewer_open_folder<i>, event</i></a><dt>
79      <dd><font size="-1"> </font></dd>
80     
81      <dt><a href="#_image_viewer_cancel">image_viewer_cancel<i>, event</i></a><dt>
82      <dd><font size="-1"> </font></dd>
83     
84      <dt><a href="#_image_viewer_timer">image_viewer_timer<i>, event</i></a><dt>
85      <dd><font size="-1"> </font></dd>
86     
87      <dt><a href="#_image_viewer_exit">image_viewer_exit<i>, event</i></a><dt>
88      <dd><font size="-1"> </font></dd>
89     
90      <dt><a href="#_image_viewer_help">image_viewer_help<i>, event</i></a><dt>
91      <dd><font size="-1"> </font></dd>
92     
93      <dt><a href="#_image_viewer_thumbs">image_viewer_thumbs<i>, event</i></a><dt>
94      <dd><font size="-1"> </font></dd>
95     
96      <dt><a href="#_image_viewer_cleanup">image_viewer_cleanup<i>, widgetID</i></a><dt>
97      <dd><font size="-1"> </font></dd>
98     
99      <dt><a href="#_image_viewer_event">image_viewer_event<i>, event</i></a><dt>
100      <dd><font size="-1"> </font></dd>
101     
102      <dt><a href="#_image_viewer">image_viewer</a><dt>
103      <dd><font size="-1"> </font></dd>
104     
105    </dl>
106
107    <p>&nbsp;</p>
108   
109
110     
111      <a name="#_image_viewer_open_files"></a>
112
113      <h2>image_viewer_open_files  <font size="-1" color="#006633">
114 Visualization, Widget
115</font></h2>
116
117      <p><font face="Courier">image_viewer_open_files<i>, <a href="#_image_viewer_open_files_keyword_event">event</a></i></font></p>
118
119   
120
121
122   
123
124   
125    <h3>Parameters</h3>
126   
127
128    <a name="#_image_viewer_open_files_keyword_event"></a>
129    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130      <font size="-1" color="#006633">in</font>
131     
132     
133      <font size="-1" color="#006633">required</font>
134     
135     
136     
137     
138    </h4>
139
140   
141
142   
143   
144
145   
146
147   
148    </pre><h3>Version history</h3>
149   
150    <h4>Version</h4>
151 $Id: image_viewer.pro 325 2007-12-06 10:04:53Z pinsard $
152_
153
154    <h4>History</h4>
155 Written by: AEB, 1/02.
156
157   
158
159    <h3>Known issues</h3>
160   
161   
162   
163    <h4>Restrictions</h4>
164 While this program is running in an IDL session it will change the current
165 working directory, enables/disables color decomposition, and sets !QUIET=1,
166 !ORDER=0, & !P.BACKGROUND=0.  These settings are returned to their initial
167 settings before the program was initiated once it is terminated.
168
169
170 This program is supported in IDL version 5.5 and newer.  In order to open
171 GIF files or TIFF files with LZW compression the copy of IDL being used must
172 be licensed with these features.  IDL only supports BMP files in the standard
173 Windows format and does not support OS2 bitmaps.
174
175
176   
177   
178   
179   
180   
181   
182   
183
184    <font size="-3"><p>&nbsp;</p></font>
185    <hr size="1" color="#CCCCCC"/>
186     
187      <a name="#_image_viewer_open_folder"></a>
188
189      <h2>image_viewer_open_folder  </h2>
190
191      <p><font face="Courier">image_viewer_open_folder<i>, <a href="#_image_viewer_open_folder_keyword_event">event</a></i></font></p>
192
193   
194
195
196   
197
198   
199    <h3>Parameters</h3>
200   
201
202    <a name="#_image_viewer_open_folder_keyword_event"></a>
203    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204      <font size="-1" color="#006633">in</font>
205     
206     
207      <font size="-1" color="#006633">required</font>
208     
209     
210     
211     
212    </h4>
213
214   
215
216   
217   
218
219   
220
221   
222   
223   
224   
225   
226   
227
228   
229   
230   
231   
232   
233
234   
235   
236   
237   
238   
239   
240   
241
242    <font size="-3"><p>&nbsp;</p></font>
243    <hr size="1" color="#CCCCCC"/>
244     
245      <a name="#_image_viewer_cancel"></a>
246
247      <h2>image_viewer_cancel  </h2>
248
249      <p><font face="Courier">image_viewer_cancel<i>, <a href="#_image_viewer_cancel_keyword_event">event</a></i></font></p>
250
251   
252
253
254   
255
256   
257    <h3>Parameters</h3>
258   
259
260    <a name="#_image_viewer_cancel_keyword_event"></a>
261    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262      <font size="-1" color="#006633">in</font>
263     
264     
265      <font size="-1" color="#006633">required</font>
266     
267     
268     
269     
270    </h4>
271
272   
273
274   
275   
276
277   
278
279   
280   
281   
282   
283   
284   
285
286   
287   
288   
289   
290   
291
292   
293   
294   
295   
296   
297   
298   
299
300    <font size="-3"><p>&nbsp;</p></font>
301    <hr size="1" color="#CCCCCC"/>
302     
303      <a name="#_image_viewer_timer"></a>
304
305      <h2>image_viewer_timer  </h2>
306
307      <p><font face="Courier">image_viewer_timer<i>, <a href="#_image_viewer_timer_keyword_event">event</a></i></font></p>
308
309   
310
311
312   
313
314   
315    <h3>Parameters</h3>
316   
317
318    <a name="#_image_viewer_timer_keyword_event"></a>
319    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
320      <font size="-1" color="#006633">in</font>
321     
322     
323      <font size="-1" color="#006633">required</font>
324     
325     
326     
327     
328    </h4>
329
330   
331
332   
333   
334
335   
336
337   
338   
339   
340   
341   
342   
343
344   
345   
346   
347   
348   
349
350   
351   
352   
353   
354   
355   
356   
357
358    <font size="-3"><p>&nbsp;</p></font>
359    <hr size="1" color="#CCCCCC"/>
360     
361      <a name="#_image_viewer_exit"></a>
362
363      <h2>image_viewer_exit  </h2>
364
365      <p><font face="Courier">image_viewer_exit<i>, <a href="#_image_viewer_exit_keyword_event">event</a></i></font></p>
366
367   
368
369
370   
371
372   
373    <h3>Parameters</h3>
374   
375
376    <a name="#_image_viewer_exit_keyword_event"></a>
377    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
378      <font size="-1" color="#006633">in</font>
379     
380     
381      <font size="-1" color="#006633">required</font>
382     
383     
384     
385     
386    </h4>
387
388   
389
390   
391   
392
393   
394
395   
396   
397   
398   
399   
400   
401
402   
403   
404   
405   
406   
407
408   
409   
410   
411   
412   
413   
414   
415
416    <font size="-3"><p>&nbsp;</p></font>
417    <hr size="1" color="#CCCCCC"/>
418     
419      <a name="#_image_viewer_help"></a>
420
421      <h2>image_viewer_help  </h2>
422
423      <p><font face="Courier">image_viewer_help<i>, <a href="#_image_viewer_help_keyword_event">event</a></i></font></p>
424
425   
426
427
428   
429
430   
431    <h3>Parameters</h3>
432   
433
434    <a name="#_image_viewer_help_keyword_event"></a>
435    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
436      <font size="-1" color="#006633">in</font>
437     
438     
439      <font size="-1" color="#006633">required</font>
440     
441     
442     
443     
444    </h4>
445
446   
447
448   
449   
450
451   
452
453   
454   
455   
456   
457   
458   
459
460   
461   
462   
463   
464   
465
466   
467   
468   
469   
470   
471   
472   
473
474    <font size="-3"><p>&nbsp;</p></font>
475    <hr size="1" color="#CCCCCC"/>
476     
477      <a name="#_image_viewer_thumbs"></a>
478
479      <h2>image_viewer_thumbs  </h2>
480
481      <p><font face="Courier">image_viewer_thumbs<i>, <a href="#_image_viewer_thumbs_keyword_event">event</a></i></font></p>
482
483   
484
485
486   
487
488   
489    <h3>Parameters</h3>
490   
491
492    <a name="#_image_viewer_thumbs_keyword_event"></a>
493    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
494      <font size="-1" color="#006633">in</font>
495     
496     
497      <font size="-1" color="#006633">required</font>
498     
499     
500     
501     
502    </h4>
503
504   
505
506   
507   
508
509   
510
511   
512   
513   
514   
515   
516   
517
518   
519   
520   
521   
522   
523
524   
525   
526   
527   
528   
529   
530   
531
532    <font size="-3"><p>&nbsp;</p></font>
533    <hr size="1" color="#CCCCCC"/>
534     
535      <a name="#_image_viewer_cleanup"></a>
536
537      <h2>image_viewer_cleanup  </h2>
538
539      <p><font face="Courier">image_viewer_cleanup<i>, <a href="#_image_viewer_cleanup_keyword_widgetID">widgetID</a></i></font></p>
540
541   
542
543
544   
545
546   
547    <h3>Parameters</h3>
548   
549
550    <a name="#_image_viewer_cleanup_keyword_widgetID"></a>
551    <h4>widgetID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
552      <font size="-1" color="#006633">in</font>
553     
554     
555      <font size="-1" color="#006633">required</font>
556     
557     
558     
559     
560    </h4>
561
562   
563
564   
565   
566
567   
568
569   
570   
571   
572   
573   
574   
575
576   
577   
578   
579   
580   
581
582   
583   
584   
585   
586   
587   
588   
589
590    <font size="-3"><p>&nbsp;</p></font>
591    <hr size="1" color="#CCCCCC"/>
592     
593      <a name="#_image_viewer_event"></a>
594
595      <h2>image_viewer_event  </h2>
596
597      <p><font face="Courier">image_viewer_event<i>, <a href="#_image_viewer_event_keyword_event">event</a></i></font></p>
598
599   
600
601
602   
603
604   
605    <h3>Parameters</h3>
606   
607
608    <a name="#_image_viewer_event_keyword_event"></a>
609    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
610      <font size="-1" color="#006633">in</font>
611     
612     
613      <font size="-1" color="#006633">required</font>
614     
615     
616     
617     
618    </h4>
619
620   
621
622   
623   
624
625   
626
627   
628   
629   
630   
631   
632   
633
634   
635   
636   
637   
638   
639
640   
641   
642   
643   
644   
645   
646   
647
648    <font size="-3"><p>&nbsp;</p></font>
649    <hr size="1" color="#CCCCCC"/>
650     
651      <a name="#_image_viewer"></a>
652
653      <h2>image_viewer  </h2>
654
655      <p><font face="Courier">image_viewer</font></p>
656
657   
658
659
660   
661
662   
663
664   
665
666   
667   
668   
669   
670   
671   
672
673   
674   
675   
676   
677   
678
679   
680   
681   
682   
683   
684   
685   
686
687    <font size="-3"><p>&nbsp;</p></font>
688    <hr size="1" color="#CCCCCC"/>
689     
690
691   
692
693    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
694
695  </body>
696</html>
Note: See TracBrowser for help on using the repository browser.