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

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

update documentation
File size: 14.0 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>image_viewer.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="image_viewer.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//image_viewer.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&lt;&lt; prev file | <a href="imdisp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="image_viewer.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&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">image_viewer.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 The purpose of this program is to provide an interactive tool that can be used
91 to view JPEG, BMP, GIF, PNG, and TIFF picture files.  Images are loaded into
92 memory, so the initial file access may take a while, but once each picture has
93 been opened they can all be viewed in a very rapid fashion.
94</div>
95
96     
97
98     
99
100     
101
102     
103      <div id="routine_summary">               
104        <h2>Routine summary</h2>
105       
106        <dl>
107         
108          <dt><p><a href="#_image_viewer_open_files">image_viewer_open_files<span class="result">, event</span></a></p><dt>
109          <dd> </dd>   
110         
111          <dt><p><a href="#_image_viewer_open_folder">image_viewer_open_folder<span class="result">, event</span></a></p><dt>
112          <dd> </dd>   
113         
114          <dt><p><a href="#_image_viewer_cancel">image_viewer_cancel<span class="result">, event</span></a></p><dt>
115          <dd> </dd>   
116         
117          <dt><p><a href="#_image_viewer_timer">image_viewer_timer<span class="result">, event</span></a></p><dt>
118          <dd> </dd>   
119         
120          <dt><p><a href="#_image_viewer_exit">image_viewer_exit<span class="result">, event</span></a></p><dt>
121          <dd> </dd>   
122         
123          <dt><p><a href="#_image_viewer_help">image_viewer_help<span class="result">, event</span></a></p><dt>
124          <dd> </dd>   
125         
126          <dt><p><a href="#_image_viewer_thumbs">image_viewer_thumbs<span class="result">, event</span></a></p><dt>
127          <dd> </dd>   
128         
129          <dt><p><a href="#_image_viewer_cleanup">image_viewer_cleanup<span class="result">, widgetID</span></a></p><dt>
130          <dd> </dd>   
131         
132          <dt><p><a href="#_image_viewer_event">image_viewer_event<span class="result">, event</span></a></p><dt>
133          <dd> </dd>   
134         
135          <dt><p><a href="#_image_viewer">image_viewer</a></p><dt>
136          <dd> </dd>   
137               
138        </dl>
139      </div>
140     
141
142      <div id="routine_details">
143       
144
145        <div class="routine_details" id="_image_viewer_open_files">
146
147          <h2><a class="top" href="#container">top</a>image_viewer_open_files <span class="categories">
148 Visualization, Widget
149</span></h2>
150       
151          <p class="header">
152            image_viewer_open_files<span class="result">, <a href="#_image_viewer_open_files_param_event">event</a></span></p>
153       
154          <div class="comments">
155</div>
156
157         
158
159         
160            <h3>Parameters</h3>
161       
162           
163            <h4 id="_image_viewer_open_files_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164              <span class="attr">in</span>
165             
166             
167              <span class="attr">required</span>
168             
169             
170             
171             
172            </h4>
173       
174          <div class="comments">
175</div>
176           
177
178         
179
180         
181
182         
183          <h3>Version history</h3>
184         
185          <h4>Version</h4><div class="preformat">
186 $Id: image_viewer.pro 325 2007-12-06 10:04:53Z pinsard $
187_
188</div>
189          <h4>History</h4><div class="preformat">
190 Written by: AEB, 1/02.
191</div>
192         
193         
194          <h3>Known issues</h3>
195         
196         
197         
198          <h4>Restrictions</h4><div class="preformat">
199 While this program is running in an IDL session it will change the current
200 working directory, enables/disables color decomposition, and sets !QUIET=1,
201 !ORDER=0, & !P.BACKGROUND=0.  These settings are returned to their initial
202 settings before the program was initiated once it is terminated.
203
204
205 This program is supported in IDL version 5.5 and newer.  In order to open
206 GIF files or TIFF files with LZW compression the copy of IDL being used must
207 be licensed with these features.  IDL only supports BMP files in the standard
208 Windows format and does not support OS2 bitmaps.
209</div>
210       
211         
212         
213         
214         
215         
216         
217         
218       
219          <h3>Statistics</h3>
220          <table class="statistics">
221            <tr><td>McCabe cyclic</td><td>           6</td></tr>
222            <tr><td>McCabe essential</td><td>           1</td></tr>
223            <tr><td>McCabe modular design</td><td>           1</td></tr>
224          </table>
225         
226       
227        </div>
228       
229
230        <div class="routine_details" id="_image_viewer_open_folder">
231
232          <h2><a class="top" href="#container">top</a>image_viewer_open_folder </h2>
233       
234          <p class="header">
235            image_viewer_open_folder<span class="result">, <a href="#_image_viewer_open_folder_param_event">event</a></span></p>
236       
237          <div class="comments">
238</div>
239
240         
241
242         
243            <h3>Parameters</h3>
244       
245           
246            <h4 id="_image_viewer_open_folder_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247              <span class="attr">in</span>
248             
249             
250              <span class="attr">required</span>
251             
252             
253             
254             
255            </h4>
256       
257          <div class="comments">
258</div>
259           
260
261         
262
263         
264
265         
266         
267         
268         
269         
270         
271         
272         
273         
274         
275         
276         
277       
278         
279         
280         
281         
282         
283         
284         
285       
286          <h3>Statistics</h3>
287          <table class="statistics">
288            <tr><td>McCabe cyclic</td><td>           7</td></tr>
289            <tr><td>McCabe essential</td><td>           1</td></tr>
290            <tr><td>McCabe modular design</td><td>           1</td></tr>
291          </table>
292         
293       
294        </div>
295       
296
297        <div class="routine_details" id="_image_viewer_cancel">
298
299          <h2><a class="top" href="#container">top</a>image_viewer_cancel </h2>
300       
301          <p class="header">
302            image_viewer_cancel<span class="result">, <a href="#_image_viewer_cancel_param_event">event</a></span></p>
303       
304          <div class="comments">
305</div>
306
307         
308
309         
310            <h3>Parameters</h3>
311       
312           
313            <h4 id="_image_viewer_cancel_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
314              <span class="attr">in</span>
315             
316             
317              <span class="attr">required</span>
318             
319             
320             
321             
322            </h4>
323       
324          <div class="comments">
325</div>
326           
327
328         
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          <h3>Statistics</h3>
354          <table class="statistics">
355            <tr><td>McCabe cyclic</td><td>           1</td></tr>
356            <tr><td>McCabe essential</td><td>           1</td></tr>
357            <tr><td>McCabe modular design</td><td>           1</td></tr>
358          </table>
359         
360       
361        </div>
362       
363
364        <div class="routine_details" id="_image_viewer_timer">
365
366          <h2><a class="top" href="#container">top</a>image_viewer_timer </h2>
367       
368          <p class="header">
369            image_viewer_timer<span class="result">, <a href="#_image_viewer_timer_param_event">event</a></span></p>
370       
371          <div class="comments">
372</div>
373
374         
375
376         
377            <h3>Parameters</h3>
378       
379           
380            <h4 id="_image_viewer_timer_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
381              <span class="attr">in</span>
382             
383             
384              <span class="attr">required</span>
385             
386             
387             
388             
389            </h4>
390       
391          <div class="comments">
392</div>
393           
394
395         
396
397         
398
399         
400         
401         
402         
403         
404         
405         
406         
407         
408         
409         
410         
411       
412         
413         
414         
415         
416         
417         
418         
419       
420          <h3>Statistics</h3>
421          <table class="statistics">
422            <tr><td>McCabe cyclic</td><td>         128</td></tr>
423            <tr><td>McCabe essential</td><td>           1</td></tr>
424            <tr><td>McCabe modular design</td><td>           1</td></tr>
425          </table>
426         
427       
428        </div>
429       
430
431        <div class="routine_details" id="_image_viewer_exit">
432
433          <h2><a class="top" href="#container">top</a>image_viewer_exit </h2>
434       
435          <p class="header">
436            image_viewer_exit<span class="result">, <a href="#_image_viewer_exit_param_event">event</a></span></p>
437       
438          <div class="comments">
439</div>
440
441         
442
443         
444            <h3>Parameters</h3>
445       
446           
447            <h4 id="_image_viewer_exit_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
448              <span class="attr">in</span>
449             
450             
451              <span class="attr">required</span>
452             
453             
454             
455             
456            </h4>
457       
458          <div class="comments">
459</div>
460           
461
462         
463
464         
465
466         
467         
468         
469         
470         
471         
472         
473         
474         
475         
476         
477         
478       
479         
480         
481         
482         
483         
484         
485         
486       
487          <h3>Statistics</h3>
488          <table class="statistics">
489            <tr><td>McCabe cyclic</td><td>           1</td></tr>
490            <tr><td>McCabe essential</td><td>           1</td></tr>
491            <tr><td>McCabe modular design</td><td>           1</td></tr>
492          </table>
493         
494       
495        </div>
496       
497
498        <div class="routine_details" id="_image_viewer_help">
499
500          <h2><a class="top" href="#container">top</a>image_viewer_help </h2>
501       
502          <p class="header">
503            image_viewer_help<span class="result">, <a href="#_image_viewer_help_param_event">event</a></span></p>
504       
505          <div class="comments">
506</div>
507
508         
509
510         
511            <h3>Parameters</h3>
512       
513           
514            <h4 id="_image_viewer_help_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
515              <span class="attr">in</span>
516             
517             
518              <span class="attr">required</span>
519             
520             
521             
522             
523            </h4>
524       
525          <div class="comments">
526</div>
527           
528
529         
530
531         
532
533         
534         
535         
536         
537         
538         
539         
540         
541         
542         
543         
544         
545       
546         
547         
548         
549         
550         
551         
552         
553       
554          <h3>Statistics</h3>
555          <table class="statistics">
556            <tr><td>McCabe cyclic</td><td>           1</td></tr>
557            <tr><td>McCabe essential</td><td>           1</td></tr>
558            <tr><td>McCabe modular design</td><td>           1</td></tr>
559          </table>
560         
561       
562        </div>
563       
564
565        <div class="routine_details" id="_image_viewer_thumbs">
566
567          <h2><a class="top" href="#container">top</a>image_viewer_thumbs </h2>
568       
569          <p class="header">
570            image_viewer_thumbs<span class="result">, <a href="#_image_viewer_thumbs_param_event">event</a></span></p>
571       
572          <div class="comments">
573</div>
574
575         
576
577         
578            <h3>Parameters</h3>
579       
580           
581            <h4 id="_image_viewer_thumbs_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
582              <span class="attr">in</span>
583             
584             
585              <span class="attr">required</span>
586             
587             
588             
589             
590            </h4>
591       
592          <div class="comments">
593</div>
594           
595
596         
597
598         
599
600         
601         
602         
603         
604         
605         
606         
607         
608         
609         
610         
611         
612       
613         
614         
615         
616         
617         
618         
619         
620       
621          <h3>Statistics</h3>
622          <table class="statistics">
623            <tr><td>McCabe cyclic</td><td>           5</td></tr>
624            <tr><td>McCabe essential</td><td>           1</td></tr>
625            <tr><td>McCabe modular design</td><td>           1</td></tr>
626          </table>
627         
628       
629        </div>
630       
631
632        <div class="routine_details" id="_image_viewer_cleanup">
633
634          <h2><a class="top" href="#container">top</a>image_viewer_cleanup </h2>
635       
636          <p class="header">
637            image_viewer_cleanup<span class="result">, <a href="#_image_viewer_cleanup_param_widgetID">widgetID</a></span></p>
638       
639          <div class="comments">
640</div>
641
642         
643
644         
645            <h3>Parameters</h3>
646       
647           
648            <h4 id="_image_viewer_cleanup_param_widgetID">widgetID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
649              <span class="attr">in</span>
650             
651             
652              <span class="attr">required</span>
653             
654             
655             
656             
657            </h4>
658       
659          <div class="comments">
660</div>
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       
688          <h3>Statistics</h3>
689          <table class="statistics">
690            <tr><td>McCabe cyclic</td><td>           3</td></tr>
691            <tr><td>McCabe essential</td><td>           1</td></tr>
692            <tr><td>McCabe modular design</td><td>           1</td></tr>
693          </table>
694         
695       
696        </div>
697       
698
699        <div class="routine_details" id="_image_viewer_event">
700
701          <h2><a class="top" href="#container">top</a>image_viewer_event </h2>
702       
703          <p class="header">
704            image_viewer_event<span class="result">, <a href="#_image_viewer_event_param_event">event</a></span></p>
705       
706          <div class="comments">
707</div>
708
709         
710
711         
712            <h3>Parameters</h3>
713       
714           
715            <h4 id="_image_viewer_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
716              <span class="attr">in</span>
717             
718             
719              <span class="attr">required</span>
720             
721             
722             
723             
724            </h4>
725       
726          <div class="comments">
727</div>
728           
729
730         
731
732         
733
734         
735         
736         
737         
738         
739         
740         
741         
742         
743         
744         
745         
746       
747         
748         
749         
750         
751         
752         
753         
754       
755          <h3>Statistics</h3>
756          <table class="statistics">
757            <tr><td>McCabe cyclic</td><td>           2</td></tr>
758            <tr><td>McCabe essential</td><td>           1</td></tr>
759            <tr><td>McCabe modular design</td><td>           1</td></tr>
760          </table>
761         
762       
763        </div>
764       
765
766        <div class="routine_details" id="_image_viewer">
767
768          <h2><a class="top" href="#container">top</a>image_viewer </h2>
769       
770          <p class="header">
771            image_viewer</p>
772       
773          <div class="comments">
774</div>
775
776         
777
778         
779
780         
781
782         
783         
784         
785         
786         
787         
788         
789         
790         
791         
792         
793         
794       
795         
796         
797         
798         
799         
800         
801         
802       
803          <h3>Statistics</h3>
804          <table class="statistics">
805            <tr><td>McCabe cyclic</td><td>          13</td></tr>
806            <tr><td>McCabe essential</td><td>           1</td></tr>
807            <tr><td>McCabe modular design</td><td>           1</td></tr>
808          </table>
809         
810       
811        </div>
812       
813      </div>
814
815     
816
817      <div id="tagline">Produced by IDLdoc 2.0.</div>
818
819    </div>
820
821  </body>
822</html>
Note: See TracBrowser for help on using the repository browser.