Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/Picture/imdisp.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago
header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 28.7 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>imdisp.pro (SAXO Documentation)</title>
10
11
12	<style type="text/css" media="all">
13
14	/* CSS for all files which appear in the "main" viewing area: overview,
15	directory overviews, warnings, index, search, pro files, source
16	code, help, and etc files. */
17
18	/* Link styles --------------------------------------------------------------- */
19
20	a { text-decoration: none; }
21
22	a:link, a:visited {
23	color: #660000;
24	border-bottom: 1px dotted #C0C0F0;
25	}
26
27	a:hover, a:focus {
28	color: #993333;
29	background: #FFFFCC;
30	border-bottom: 1px dotted #303099;
31	}
32
33
34	/* Main styles --------------------------------------------------------------- */
35	p.preformat {
36	font-family: Courier;
37	}
38
39	body {
40	margin: 0;
41	padding: 0;
42	font-size: 10pt;
43	font-family: Verdana, Helvetica, Arial, sans-serif;
44	background-color: #FFFFFF;
45	}
46
47	p {
48	margin-top: 0.5em;
49	margin-bottom: 0;
50	}
51
52	#container { margin: 1em; }
53
54	code.section { white-space: pre; }
55
56	pre.snippet {
57	margin-left: 5%;
58	background: #F0F0F0;
59	border: 1px dashed #999999;
60	width: 43em;
61	padding: 0.5em 0.5em 0.5em 0.5em;
62	white-space: pre;
63	}
64
65	/* Navbar styles ------------------------------------------------------------- */
66
67	#navbar_title {
68	color: #000033;
69	background-color: #F0F0FF;
70	font-family: Arial, Helvetica, sans-serif;
71	padding: 20px 30px;
72	border-bottom: 1px solid #000033;
73	}
74
75	#navbar_title * {
76	margin: 0;
77	padding: 0;
78	}
79
80	#navbar_title h1 {
81	letter-spacing: 0.1em;
82	font-variant: small-caps;
83	font-size: 250%;
84	text-indent: -1em;
85	padding-left: 1em;
86	}
87
88	#navbar_title h2 {
89	font-size: 110%;
90	font-weight: normal;
91	color: #333399;
92	}
93
94	#main_navbar table {
95	width: 100%;
96	border-bottom: 1px solid #666699;
97	}
98
99	#main_navbar td {
100	background: #CCCCFF;
101	font-size: 80%;
102	font-weight: bold;
103	font-family: Arial, Helvetica, sans-serif;
104	border-top: 3px solid #CCCCFF;
105	border-bottom: 3px solid #CCCCFF;
106	padding-left: 6px;
107	padding-right: 6px;
108	margin: 0;
109	}
110
111	#main_navbar td#selected {
112	background: #CCCCFF;
113	font-size: 80%;
114	font-weight: bold;
115	font-family: Arial, Helvetica, sans-serif;
116	border-top: 3px solid #333399;
117	border-bottom: 3px solid #CCCCFF;
118	padding-left: 6px;
119	padding-right: 6px;
120	margin: 0;
121	}
122
123	#main_navbar td#flexible {
124	width: 100%;
125	text-align: right;
126	padding-right: 1em;
127	background: #CCCCFF;
128	font-size: 70%;
129	font-weight: normal;
130	font-family: Arial, Helvetica, sans-serif;
131	text-transform: uppercase;
132	border-top: 3px solid #CCCCFF;
133	border-bottom: 3px solid #CCCCFF;
134	}
135
136	#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
137
138	#main_navbar a:hover, #main_navbar a:focus {
139	color: #FFFF66;
140	background: #CCCCFF;
141	border-bottom: 1px none #606099;
142	border: 0;
143	}
144
145	#secondary_navbar {
146	font-size: 80%;
147	font-weight: normal;
148	font-family: Arial, Helvetica, sans-serif;
149	margin-top: 4px;
150	margin-left: 20px;
151	white-space: nowrap;
152	}
153
154
155	/* Tagline and footer styles ------------------------------------------------- */
156
157	div#tagline {
158	margin-top: 6px;
159	border-top: 1px dotted lightsteelblue;
160	padding-top: 6px;
161	font-size: 66%;
162	font-style: italic;
163	}
164
165	div#footer {
166	margin-top: 6px;
167	border-top: 1px dotted lightsteelblue;
168	padding-top: 6px;
169	font-size: 66%;
170	font-style: italic;
171	}
172
173	/* Basic data presenation styles -------------------------------------------- */
174
175	.index_letter {
176	font-size: 300%;
177	font-weight: bold;
178	color: #000066;
179	margin: 0.5em 0 0 -0.1em;
180	}
181
182	h1, h2, h3, h4 {
183	font-weight: normal;
184	color: #3333CC;
185	}
186
187	h1 {
188	padding-top: 0.75em;
189	font-size: 160%;
190	}
191
192	h2 {
193	padding-top: 1em;
194	font-size: 120%;
195	}
196
197	h3 {
198	padding-top: 0.75em;
199	margin-bottom: 0.25em;
200	font-size: 100%;
201	}
202
203	h4 {
204	padding: 0;
205	margin: 0.5em 0 0 0;
206	font-size: 80%;
207	}
208
209	table.basic {
210	empty-cells: show;
211	margin: 1.5em 1em 0 1em;
212	border: 1px dotted #CFCFFF;
213	font-size: 80%;
214	}
215
216	table.basic th {
217	background-color: #F0F0FF;
218	font-weight: bold;
219	text-align: left;
220	padding: 4px 1em 4px 4px;
221	border-bottom: 1px dotted #666699;
222	}
223
224	table.basic td {
225	vertical-align: top;
226	padding: 4px 1em 4px 4px;
227	}
228
229	dd {
230	margin-bottom: 0.25em;
231	font-size: 80%;
232	}
233
234
235	/* Warnings styles ----------------------------------------------------------- */
236
237
238	#todo dl, #bugs dl {
239	margin: 0 0 0 1.5em;
240	font-size: 80%;
241	}
242
243	#todo dd, #bugs dd {
244	margin-left: 3em;
245	font-size: 100%;
246	}
247
248	#undoc table, #obsolete table, #statistics table {
249	width: 80%;
250	margin-left: 2em;
251	}
252
253	#undoc td, #obsolete td, #statistics td {
254	padding: 0 0 0 0;
255	font-size: 80%;
256	white-space: nowrap;
257	}
258
259	#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
260
261	#undoc td.docstat, #statistics td.stat {
262	width: 50%;
263	text-align: right;
264	}
265
266	#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
267
268	#undoc td.notdoc, #statistics td.warning { color: #993333; }
269
270	/* File + routine styles ----------------------------------------------------- */
271
272	h1.directory {
273	padding: 1em 0 0 0;
274	margin: 0;
275	font-size: 66%;
276	}
277
278	h1.directory a { border-bottom: 0; }
279
280	h2.pro_file {
281	padding: 0;
282	margin: 0;
283	font-size: 140%;
284	}
285
286	div#file_attr {
287	padding: 0 1em 0 1em;
288	margin: 1em;
289	background: #F6F6F6;
290	border: 1px dotted #999999;
291	}
292
293	div#file_attr dt {
294	font-size: 80%;
295	font-weight: bold;
296	}
297
298	div#file_attr dd {
299	font-size: 80%;
300	}
301
302	div#class_diagram {
303	padding: 1em 0 1em 0;
304	white-space: pre;
305	font-family: 'Courier New';
306	}
307
308	table#sav_attr {
309	font-size: 90%;
310	margin: 1em;
311	padding: 1em 1em 1em 1em;
312	background: #F6F6F6;
313	border: 1px dotted #999999;
314	}
315
316	table#sav_attr th { text-align: left; }
317
318	table#sav_attr td { vertical-align: top; padding-right: 2em; }
319
320	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
321
322	p.sav_warning { margin-left: 4em; font-family: 80%; }
323
324	table.variables {
325	font-family: 'Courier New', monospace;
326	font-size: 80%;
327	text-indent: -2em;
328	padding-left: 2em;
329	}
330
331	table.variables td.image { width: 64px; }
332
333	div#file_comments { white-space: pre;
334	margin: 2em;
335	font-size: 80%;
336	}
337
338
339	div.field_summary {
340	padding: 0 1em 0 1em;
341	margin: 1em;
342	background: #FFFFF0;
343	border: 1px dotted #C0C000;
344	}
345
346	div#routine_summary {
347	padding: 0 1em 0 1em;
348	margin: 1em;
349	background: #F0F0FF;
350	border: 1px dotted #9999FF;
351	}
352
353	div.field_summary h2, div#routine_summary h2 {
354	padding: 0.5em 0 0 0;
355	margin: 0;
356	}
357
358	div.field_summary table, div.field_summary p {
359	margin: 1em 1em;
360	}
361
362	div.field_summary td.name {
363	vertical-align: top;
364	padding-bottom: 0.25em;
365	color: #3333CC;
366	}
367
368	div.field_summary span.field_type {
369	font-weight: normal;
370	font-size: 80%;
371	color: black;
372	}
373
374	div.field_summary td.comments {
375	vertical-align: top;
376	padding-left: 2em;
377	font-size: 80%;
378	}
379
380	p.commaList {
381	margin: 1em 1em 1em 1em;
382	}
383
384	span.warning {
385	color: #CC6633;
386	font-weight: bold;
387	font-size: 66%;
388	text-transform: uppercase;
389	}
390
391	span.categories {
392	color: #006633;
393	font-weight: bold;
394	font-size: 66%;
395	text-transform: uppercase;
396	}
397
398	span.undoc {
399	color: #FF6633;
400	font-weight: bold;
401	font-size: 80%;
402	text-transform: uppercase;
403	}
404
405	span.attr {
406	color: #006633;
407	font-weight: bold;
408	font-size: 80%;
409	text-transform: uppercase;
410	}
411
412	span.value {
413	color: #006633;
414	font-weight: normal;
415	text-transform: none;
416	}
417
418	a.top {
419	font-weight: bold;
420	font-size: 66%;
421	text-transform: uppercase;
422	float: right;
423	}
424
425	span.result {
426	font-family: Verdana, Arial, Helvetica, sans-serif;
427	font-style: italic;
428	font-size: 80%;
429	}
430
431	div#routine_summary p, div.routine_details p.header {
432	padding-top: 0.5em;
433	margin-left: 1.5em;
434	text-indent: -1.5em;
435	font-family: 'Courier New', monospace;
436	}
437
438	div.routine_details {
439	padding: 0.5em 1em 0.5em 1em;
440	margin: 1em;
441	border: 1px dotted #CCCCCC;
442	}
443
444	div.routine_details h2 {
445	padding-top: 0;
446	margin-top: 0;
447	}
448
449	div.routine_details div.value {
450	margin: 0 1em 0 1em;
451	font-size: 80%;
452	}
453
454	div.routine_details div.comments {
455	font-size: 80%;
456	margin: 0.75em 1em 1em 1em;
457	}
458
459	div.routine_details div.preformat {
460	white-space: pre;
461	}
462
463	table.statistics {
464	font-size: 80%;
465	margin-left: 1em;
466	}
467
468	table.statistics td {
469	padding: 0 2em 0 0;
470	}
471
472	/* Overview styles ----------------------------------------------------------- */
473
474	div.overview {
475	width: 100%;
476	margin-top: 1em;
477	clear: both;
478	}
479
480	div.overview table {
481	empty-cells: show;
482	font-size: 90%;
483	margin: 1em 1em 1em 1em;
484	padding: 1em 0.5em 1em 0.5em;
485	background: #F6F6F6;
486	border: 1px dotted #999999;
487	}
488
489	div.overview td {
490	padding: 3px 1em 3px 1em;
491	}
492
493	div.overview td.dir {
494	width: 1%;
495	vertical-align: top;
496	text-align: right;
497	padding-right: 1em;
498	}
499
500
501	/* Navigation list styles for tree structures -------------------------------- */
502
503	#tree {
504	text-align: left;
505	font-size: 90%;
506	margin: 0.75em 0 0.75em 0;
507	padding: 0;
508	}
509
510	#tree ul {
511	text-align: left;
512	margin: 0;
513	padding: 0;
514	}
515
516	#tree li {
517	margin: 0 0 0 15px;
518	padding: 0;
519	list-style-type: none;
520	}
521
522	#tree .symbols {
523	float: left;
524	width: 12px;
525	height: 1em;
526	padding-left: 4px;
527	background-position: 0 100%;
528	background-repeat: no-repeat;
529	}
530
531	/* Search styles ------------------------------------------------------------- */
532
533	input.writein {
534	padding-left: 0.5em;
535	border: 1px solid #CCCCCC;
536	font-family: 'Courier New';
537	background: #FFFFF3;
538	}
539
540	#search form {
541	margin-left: 2em;
542	}
543
544	#search table {
545	margin: 1em 1em 0 2em;
546	padding: 1em 2em 1em 2em;
547	background: #F6F6F6;
548	border: 1px dotted #999999;
549	}
550
551	#search tr {
552	text-align: center;
553	}
554
555	#search td {
556	font-size: 80%;
557	text-align: left;
558	}
559
560	#search td * {
561	vertical-align: middle;
562	}
563
564	#search p {
565	font-size: 66%;
566	margin: 0 3em 2em 3em;
567	}
568
569	/* Help styles --------------------------------------------------------------- */
570
571	div.toc {
572	padding: 0 1em 0 1em;
573	margin: 1em;
574	background: #F0F0FF;
575	border: 1px dotted #9999FF;
576	width: 19em;
577	}
578
579	div.right {
580	float: right;
581	width: 22em;
582	}
583
584	ol.toc {
585	list-style-type: upper-roman;
586	}
587
588	ol.toc ol {
589	padding-left: 3em;
590	margin-left: 0;
591	list-style-type: lower-alpha;
592	}
593
594	dl.variables dt { font-size: 80%; }
595	dl.variables dd { margin-bottom: 0.5em; }
596
597	</style>
598	<style type="text/css" media="print">
599	#navbar_title {
600	background-color: #FFFFFF;
601	}
602
603	#main_navbar td {
604	background: #FFFFFF;
605	border-top: 0.25em solid #FFFFFF;
606	border-bottom: 0.25em solid #FFFFFF;
607	}
608
609	#main_navbar td#selected {
610	background: #FFFFFF;
611	border-top: 0.25em solid #333399;
612	border-bottom: 0.25em solid #FFFFFF;
613	}
614
615	#main_navbar td#flexible {
616	background: #FFFFFF;
617	border-top: 0.25em solid #FFFFFF;
618	border-bottom: 0.25em solid #FFFFFF;
619	}
620
621	#secondary_navbar {
622	display: none;
623	}
624
625	</style>
626
627
628	<script type="text/javascript">
629	function setTitle() {
630	parent.document.title="imdisp.pro (SAXO Documentation)";
631	}
632	</script>
633	</head>
634
635	<body onload="setTitle();">
636
637	<div id="navbar_title">
638	<h1>SAXO Documentation</h1>
639	</div>
640
641
642	<div id="main_navbar">
643
644	<table cellspacing="0">
645	<tr>
646
647	<td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td>
648
649
650
651	<td >Directory</td>
652
653
654
655	<td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
656
657
658
659	<td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
660
661
662
663	<td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
664
665
666	<td id="selected">File</td>
667
668
669	<td >Source</td>
670
671
672
673	<td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
674
675
676	<td >Etc</td>
677
678	<td id="flexible">Developer documentation</td>
679	</tr>
680	</table>
681
682	</div>
683
684	<div id="secondary_navbar">
685
686	<a href="image_viewer.html?format=raw"><<prev file</a> \| <a href="saveimage.html?format=raw">next file >></a>    <a href="imdisp.html?format=raw" target="_TOP">view single page</a> \| <a href="./../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| routine    details: <a href="#routine_details">routine</a>
687
688	</div>
689
690
691	<div id="container">
692
693	<h1 class="directory"><a href="directory-overview.html?format=raw">Picture/</a></h1>
694	<h2 class="pro_file">imdisp.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702	Display an image on the current graphics device.
703	IMDISP is an advanced replacement for TV and TVSCL.
704
705	- Supports WIN, MAC, X, CGM, PCL, PRINTER, PS, and Z graphics devices,
706	- Image is automatically byte-scaled (can be disabled),
707	- Custom byte-scaling of Pseudo color images via the RANGE keyword,
708	- Pseudo (indexed) color and True color images are handled automatically,
709	- 8-bit and 24-bit graphics devices are handled automatically,
710	- Decomposed color settings are handled automatically,
711	- Image is automatically sized to fit the display (can be disabled),
712	- The !P.MULTI system variable is honored for multiple image display,
713	- Image can be positioned via the POSITION keyword,
714	- Color table splitting via the BOTTOM and NCOLORS keywords,
715	- Image aspect ratio customization via the ASPECT keyword,
716	- Resized images can be resampled (default) or interpolated,
717	- Top down image display via the ORDER keyword (!ORDER is ignored),
718	- Selectable display channel (R/G/B) via the CHANNEL keyword,
719	- Background can be set to a specified color via the BACKGROUND keyword,
720	- Screen can be erased prior to image display via the ERASE keyword,
721	- Plot axes can be drawn on the image via the AXIS keyword,
722	- Photographic negative images can be displayed via the NEGATIVE keyword.
723	</div>
724
725
726
727
728
729
730
731
732
733	<div id="routine_details">
734
735
736	<div class="routine_details" id="_imdisp">
737
738	<h2><a class="top" href="#container">top</a>imdisp <span class="categories">
739	Picture
740	</span></h2>
741
742	<p class="header">
743	imdisp<span class="result">, <a href="#_imdisp_param_IMAGE">IMAGE</a></span>, <a href="#_imdisp_keyword_RANGE">RANGE</a>=<span class="result">vector</span>, <a href="#_imdisp_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_imdisp_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_imdisp_keyword_MARGIN">MARGIN</a>=<span class="result">MARGIN</span>, <a href="#_imdisp_keyword_INTERP">INTERP</a>=<span class="result">INTERP</span>, <a href="#_imdisp_keyword_DITHER">DITHER</a>=<span class="result">DITHER</span>, <a href="#_imdisp_keyword_ASPECT">ASPECT</a>=<span class="result">ASPECT</span>, <a href="#_imdisp_keyword_POSITION">POSITION</a>=<span class="result">POSITION</span>, <a href="#_imdisp_keyword_OUT_POS">OUT_POS</a>=<span class="result">OUT_POS</span>, <a href="#_imdisp_keyword_NOSCALE">NOSCALE</a>=<span class="result">NOSCALE</span>, <a href="#_imdisp_keyword_NORESIZE">NORESIZE</a>=<span class="result">NORESIZE</span>, <a href="#_imdisp_keyword_ORDER">ORDER</a>=<span class="result">ORDER</span>, <a href="#_imdisp_keyword_USEPOS">USEPOS</a>=<span class="result">USEPOS</span>, <a href="#_imdisp_keyword_CHANNEL">CHANNEL</a>=<span class="result">CHANNEL</span>, <a href="#_imdisp_keyword_BACKGROUND">BACKGROUND</a>=<span class="result">BACKGROUND</span>, <a href="#_imdisp_keyword_ERASE">ERASE</a>=<span class="result">ERASE</span>, <a href="#_imdisp_keyword_AXIS">AXIS</a>=<span class="result">AXIS</span>, <a href="#_imdisp_keyword_NEGATIVE">NEGATIVE</a>=<span class="result">NEGATIVE</span>, <a href="#_imdisp_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
744
745	<div class="comments">
746	</div>
747
748
749
750
751	<h3>Parameters</h3>
752
753
754	<h4 id="_imdisp_param_IMAGE">IMAGE
755	<span class="attr">in</span>
756
757
758	<span class="attr">required</span>
759
760
761
762
763	</h4>
764
765	<div class="comments">
766	Array containing image data.
767	Pseudo (indexed) color images must have 2 dimensions.
768	True color images must have 3 dimensions, in either
769	[3, NX, NY], [NX, 3, NY], or [NX, NY, 3] form.
770	</div>
771
772
773
774
775
776
777	<h3>Keywords</h3>
778
779	<h4 id="_imdisp_keyword_RANGE">RANGE
780
781
782
783
784
785	<span class="attr">type:</span> <span class="value">vector</span>
786	<span class="attr">default:</span> <span class="value">min and max array values</span>
787
788	</h4>
789
790	<div class="comments">
791	For Pseudo Color images only, a vector with two elements
792	specifying the minimum and maximum values of the image
793	array to be considered when the image is byte-scaled
794	This keyword is ignored for True Color images,
795	or if the NOSCALE keyword is set.
796	</div>
797
798	<h4 id="_imdisp_keyword_BOTTOM">BOTTOM
799
800
801
802
803
804
805	<span class="attr">default:</span> <span class="value">0</span>
806
807	</h4>
808
809	<div class="comments">
810	Bottom value in the color table to be used
811	for the byte-scaled image.
812	This keyword is ignored if the NOSCALE keyword is set.
813	</div>
814
815	<h4 id="_imdisp_keyword_NCOLORS">NCOLORS
816
817
818
819
820
821
822	<span class="attr">default:</span> <span class="value">!D.TABLE_SIZE - BOTTOM</span>
823
824	</h4>
825
826	<div class="comments">
827	Number of colors in the color table to be used
828	for the byte-scaled image
829	This keyword is ignored if the NOSCALE keyword is set.
830	</div>
831
832	<h4 id="_imdisp_keyword_MARGIN">MARGIN
833
834
835
836
837
838
839	<span class="attr">default:</span> <span class="value">0.1 or 0.025 if !P.MULTI is set to display multiple images</span>
840
841	</h4>
842
843	<div class="comments">
844	A scalar value specifying the margin to be maintained
845	around the image in normal coordinates
846	</div>
847
848	<h4 id="_imdisp_keyword_INTERP">INTERP
849
850
851
852
853
854
855	<span class="attr">default:</span> <span class="value">nearest neighbor sampling</span>
856
857	</h4>
858
859	<div class="comments">
860	If set, the resized image will be interpolated using
861	bilinear interpolation
862	</div>
863
864	<h4 id="_imdisp_keyword_DITHER">DITHER
865
866
867
868
869
870
871	<span class="attr">default:</span> <span class="value">no dithering</span>
872
873	</h4>
874
875	<div class="comments">
876	If set, true color images will be dithered when displayed
877	on an 8-bit graphics device
878	</div>
879
880	<h4 id="_imdisp_keyword_ASPECT">ASPECT
881
882
883
884
885
886
887	<span class="attr">default:</span> <span class="value">maintain native aspect ratio</span>
888
889	</h4>
890
891	<div class="comments">
892	A scalar value specifying the aspect ratio (height/width)
893	for the displayed image
894	</div>
895
896	<h4 id="_imdisp_keyword_POSITION">POSITION
897
898
899
900
901
902
903	<span class="attr">default:</span> <span class="value"> [0.0,0.0,1.0,1.0]</span>
904
905	</h4>
906
907	<div class="comments">
908	On input, a 4-element vector specifying the position
909	of the displayed image in the form [X0,Y0,X1,Y1] in
910	in normal coordinates
911	See the examples below to display an image where only the
912	offset and size are known (e.g. MAP_IMAGE output).
913	</div>
914
915	<h4 id="_imdisp_keyword_OUT_POS">OUT_POS
916
917
918
919
920
921
922
923
924	</h4>
925
926	<div class="comments">
927	On output, a 4-element vector specifying the position
928	actually used to display the image.
929	</div>
930
931	<h4 id="_imdisp_keyword_NOSCALE">NOSCALE
932
933
934
935
936
937
938	<span class="attr">default:</span> <span class="value">to byte-scale the image</span>
939
940	</h4>
941
942	<div class="comments">
943	If set, the image will not be byte-scaled.
944	</div>
945
946	<h4 id="_imdisp_keyword_NORESIZE">NORESIZE
947
948
949
950
951
952
953	<span class="attr">default:</span> <span class="value">To resize the image to fit the display</span>
954
955	</h4>
956
957	<div class="comments">
958	If set, the image will not be resized.
959	</div>
960
961	<h4 id="_imdisp_keyword_ORDER">ORDER
962
963
964
965
966
967
968	<span class="attr">default:</span> <span class="value">To display the image from the bottom up</span>
969
970	</h4>
971
972	<div class="comments">
973	If set, the image is displayed from the top down
974	Note that the system variable !ORDER is always ignored.
975	</div>
976
977	<h4 id="_imdisp_keyword_USEPOS">USEPOS
978
979
980
981
982
983
984	<span class="attr">default:</span> <span class="value">To honor ASPECT and MARGIN when POSITION vector is supplied</span>
985
986	</h4>
987
988	<div class="comments">
989	If set, the image will be sized to exactly fit a supplied
990	POSITION vector, over-riding ASPECT and MARGIN.
991	</div>
992
993	<h4 id="_imdisp_keyword_CHANNEL">CHANNEL
994
995
996
997
998
999
1000
1001
1002	</h4>
1003
1004	<div class="comments">
1005	Display channel (Red, Green, or Blue) to be written.
1006	0 => All channels (the default)
1007	1 => Red channel
1008	2 => Green channel
1009	3 => Blue channel
1010	This keyword is only recognized by graphics devices which
1011	support 24-bit decomposed color (WIN, MAC, X). It is ignored
1012	by all other graphics devices. However True color (RGB)
1013	images can be displayed on any device supported by IMDISP.
1014	</div>
1015
1016	<h4 id="_imdisp_keyword_BACKGROUND">BACKGROUND
1017
1018
1019
1020
1021
1022
1023
1024
1025	</h4>
1026
1027	<div class="comments">
1028	If set to a positive integer, the background will be filled
1029	with the color defined by BACKGROUND.
1030	</div>
1031
1032	<h4 id="_imdisp_keyword_ERASE">ERASE
1033
1034
1035
1036
1037
1038
1039
1040
1041	</h4>
1042
1043	<div class="comments">
1044	If set, the screen contents will be erased. Note that if
1045	!P.MULTI is set to display multiple images, the screen is
1046	always erased when the first image is displayed.
1047	</div>
1048
1049	<h4 id="_imdisp_keyword_AXIS">AXIS
1050
1051
1052
1053
1054
1055
1056
1057
1058	</h4>
1059
1060	<div class="comments">
1061	If set, plot axes will be drawn on the image. The default
1062	x and y axis ranges are determined by the size of the image.
1063	When the AXIS keyword is set, IMDISP accepts any keywords
1064	supported by PLOT (e.g. TITLE, COLOR, CHARSIZE etc.).
1065	</div>
1066
1067	<h4 id="_imdisp_keyword_NEGATIVE">NEGATIVE
1068
1069
1070
1071
1072
1073
1074
1075
1076	</h4>
1077
1078	<div class="comments">
1079	If set, a photographic negative of the image is displayed.
1080	The values of BOTTOM and NCOLORS are honored. This keyword
1081	allows True color images scanned from color negatives to be
1082	displayed. It also allows Pseudo color images to be displayed
1083	as negatives without reversing the color table. This keyword
1084	is ignored if the NOSCALE keyword is set.
1085	</div>
1086
1087	<h4 id="_imdisp_keyword__EXTRA">_EXTRA
1088
1089
1090
1091
1092
1093
1094
1095
1096	</h4>
1097
1098	<div class="comments"></div>
1099
1100
1101
1102	<h3>Examples</h3><div class="preformat">
1103
1104	;- Load test data
1105
1106	openr, lun, filepath('ctscan.dat', subdir='examples/data'), /get_lun
1107	ctscan = bytarr(256, 256)
1108	readu, lun, ctscan
1109	free_lun, lun
1110	openr, lun, filepath('hurric.dat', subdir='examples/data'), /get_lun
1111	hurric = bytarr(440, 330)
1112	readu, lun, hurric
1113	free_lun, lun
1114	read_jpeg, filepath('rose.jpg', subdir='examples/data'), rose
1115	help, ctscan, hurric, rose
1116
1117	;- Display single images
1118
1119	!p.multi = 0
1120	loadct, 0
1121	imdisp, hurric, /erase
1122	wait, 3.0
1123	imdisp, rose, /interp, /erase
1124	wait, 3.0
1125
1126	;- Display multiple images without color table splitting
1127	;- (works on 24-bit displays only; top 2 images are garbled on 8-bit displays)
1128
1129	!p.multi = [0, 1, 3, 0, 0]
1130	loadct, 0
1131	imdisp, ctscan, margin=0.02
1132	loadct, 13
1133	imdisp, hurric, margin=0.02
1134	imdisp, rose, margin=0.02
1135	wait, 3.0
1136
1137	;- Display multiple images with color table splitting
1138	;- (works on 8-bit or 24-bit displays)
1139
1140	!p.multi = [0, 1, 3, 0, 0]
1141	loadct, 0, ncolors=64, bottom=0
1142	imdisp, ctscan, margin=0.02, ncolors=64, bottom=0
1143	loadct, 13, ncolors=64, bottom=64
1144	imdisp, hurric, margin=0.02, ncolors=64, bottom=64
1145	imdisp, rose, margin=0.02, ncolors=64, bottom=128
1146	wait, 3.0
1147
1148	;- Display an image at a specific position, over-riding aspect and margin
1149
1150	!p.multi = 0
1151	loadct, 0
1152	imdisp, hurric, position=[0.0, 0.0, 1.0, 0.5], /usepos, /erase
1153	wait, 3.0
1154
1155	;- Display an image with axis overlay
1156
1157	!p.multi = 0
1158	loadct, 0
1159	imdisp, rose, /axis, /erase
1160	wait, 3.0
1161
1162	;- Display an image with contour plot overlay
1163
1164	!p.multi = 0
1165	loadct, 0
1166	imdisp, hurric, out_pos=out_pos, /erase
1167	contour, smooth(hurric, 10, /edge), /noerase, position=out_pos, $
1168	xstyle=1, ystyle=1, levels=findgen(5)*40.0, /follow
1169	wait, 3.0
1170
1171	;- Display a small image with correct resizing
1172
1173	!p.multi = 0
1174	loadct, 0
1175	data = (dist(8))[1:7, 1:7]
1176	imdisp, data, /erase
1177	wait, 3.0
1178	imdisp, data, /interp
1179	wait, 3.0
1180
1181	;- Display a true color image without and with interpolation
1182
1183	!p.multi = 0
1184	imdisp, rose, /erase
1185	wait, 3.0
1186	imdisp, rose, /interp
1187	wait, 3.0
1188
1189	;- Display a true color image as a photographic negative
1190
1191	imdisp, rose, /negative, /erase
1192	wait, 3.0
1193
1194	;- Display a true color image on PostScript output
1195	;- (note that color table is handled automatically)
1196
1197	current_device = !d.name
1198	set_plot, 'PS'
1199	device, /color, bits_per_pixel=8, filename='imdisp_true.ps'
1200	imdisp, rose, /axis, title='PostScript True Color Output'
1201	device, /close
1202	set_plot, current_device
1203
1204	;- Display a pseudo color image on PostScript output
1205
1206	current_device = !d.name
1207	set_plot, 'PS'
1208	device, /color, bits_per_pixel=8, filename='imdisp_pseudo.ps'
1209	loadct, 0
1210	imdisp, hurric, /axis, title='PostScript Pseudo Color Output'
1211	device, /close
1212	set_plot, current_device
1213
1214	;- Display an image where only the offset and size are known
1215
1216	;- Read world elevation data
1217	file = filepath('worldelv.dat', subdir='examples/data')
1218	openr, lun, file, /get_lun
1219	data = bytarr(360, 360)
1220	readu, lun, data
1221	free_lun, lun
1222	;- Reorganize array so it spans 180W to 180E
1223	world = data
1224	world[0:179, ] = data[180:, *]
1225	world[180:, ] = data[0:179, *]
1226	;- Create remapped image
1227	map_set, /orthographic, /isotropic, /noborder
1228	remap = map_image(world, x0, y0, xsize, ysize, compress=1)
1229	;- Convert offset and size to position vector
1230	pos = fltarr(4)
1231	pos[0] = x0 / float(!d.x_vsize)
1232	pos[1] = y0 / float(!d.y_vsize)
1233	pos[2] = (x0 + xsize) / float(!d.x_vsize)
1234	pos[3] = (y0 + ysize) / float(!d.y_vsize)
1235	;- Display the image
1236	loadct, 0
1237	imdisp, remap, pos=pos, /usepos
1238	map_continents
1239	map_grid
1240	</div>
1241	<h3>Version history</h3>
1242
1243	<h4>Version</h4><div class="preformat"> $Id: imdisp.pro 157 2006-08-21 09:01:50Z navarro $
1244	</div>
1245	<h4>History</h4><div class="preformat"> Liam.Gumley@ssec.wisc.edu
1246	http://cimss.ssec.wisc.edu/~gumley
1247
1248	Copyright (C) 1999, 2000 Liam E. Gumley
1249
1250	This program is free software; you can redistribute it and/or
1251	modify it under the terms of the GNU General Public License
1252	as published by the Free Software Foundation; either version 2
1253	of the License, or (at your option) any later version.
1254
1255	This program is distributed in the hope that it will be useful,
1256	but WITHOUT ANY WARRANTY; without even the implied warranty of
1257	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1258	GNU General Public License for more details.
1259
1260	You should have received a copy of the GNU General Public License
1261	along with this program; if not, write to the Free Software
1262	Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1263	</div>
1264
1265
1266	<h3>Known issues</h3>
1267
1268
1269
1270	<h4>Restrictions</h4><div class="preformat">
1271	The image is displayed on the current graphics device.
1272
1273
1274	Requires IDL 5.0 or higher (square bracket array syntax).
1275	</div>
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285	<h3>Statistics</h3>
1286	<table class="statistics">
1287	<tr><td>McCabe cyclic</td><td> 76</td></tr>
1288	<tr><td>McCabe essential</td><td> 1</td></tr>
1289	<tr><td>McCabe modular design</td><td> 1</td></tr>
1290	</table>
1291
1292
1293	</div>
1294
1295	</div>
1296
1297
1298
1299	<div id="tagline">Produced by IDLdoc 2.0.</div>
1300
1301	</div>
1302
1303	</body>
1304	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: