Context Navigation

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

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

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

Download in other formats: