1IIS(3) User Contributed Perl Documentation IIS(3)
2
6 PDL::Graphics::IIS - Display PDL images on IIS devices
7 (saoimage/ximtool)
8
10 use PDL::Graphics::IIS;
11 saoimage ( -geometry => '800x800' );
12 iis rvals(100,100);
13
15 This module provides an interface to any image display 'device' which
16 support the 'IIS protocol' - viz the SAOimage and Ximtool X-windows
17 programs, the old SunView imtool program and presumably even the
18 original IIS CRT itself if they aren't all in museums!
19 These programs should be familiar to astronomers - they are used by the
21 common IRAF system. The programs and their HTML documentation can be
22 obtained from the following URLs:
23 SAOimage: http://tdc-www.harvard.edu/software/saoimage.html
25 Ximtool: http://iraf.noao.edu/iraf/web/projects/x11iraf/x11iraf.html
26 Non-astronomers may find they quite nifty for displaying 2D data.
28 The Perl variable $stdimage is exported from the module and controls
30 the frame buffer configuration currently in use. The default value is
31 "imt1024" which specifies a "1024x1024" frame buffer. Other values
32 supported by the module are:
33 imt512, imt800, imt1024, imt1600, imt2048, and imt4096.
35 If you have a $HOME/.imtoolrc you can use it to specify other frame
37 buffer names and configurations in exactly the same way you can in
38 IRAF. Here is a sample file:
39 -------------------snip-------------------------
41 # Format: configno nframes width height
42 1 2 512 512 # imt1|imt512
43 2 2 800 800 # imt2|imt800
44 3 2 1024 1024 # imt3|imt1024
45 4 1 1600 1600 # imt4|imt1600
46 5 1 2048 2048 # imt5|imt2048
47 6 1 4096 4096 # imt6|imt4096
48 7 1 8192 8192 # imt7|imt8192
49 8 1 1024 4096 # imt8|imt1x4
50 9 2 1144 880 # imt9|imtfs full screen (1152x900 minus frame)
51 10 2 1144 764 # imt10|imtfs35 full screen at 35mm film aspect ratio
52 -------------------snip-------------------------
53 (Note: some versions of SAOimage may not even work if this file is not
55 present. If you get funny error messages about 'imtoolrc' try copying
56 the above to $HOME/.imtoolrc or /usr/local/lib/imtoolrc)
57 The Perl variable $iisframe is also exported from the module and
59 controls which display frame number to use in programs such as Ximtool
60 which supports multiple frames. This allows you to do useful things
61 such as blink between images.
62 The module communicates with the IIS device down FIFO pipes (special
64 UNIX files) - unlike IRAF this module does a pretty decent job of
65 intelligently guessing which file names to use for the pipes and will
66 prompt for their creating if absent. Also if SAOimage or Ximtool are
67 started from within Perl using the module this will guarantee correct
68 file names!
69
71 iis
72 Displays an image on a IIS device (e.g. SAOimage/Ximtool)
73 iis $image, [ { MIN => $min, MAX => $max,
75 TITLE => 'pretty picture',
76 FRAME => 2 } ]
77 iis $image, [$min,$max]
78 (image(m,n),[\%options]) or (image(m,n),[min(),max()])
80 Displays image on a IIS device. If min() or max() are omitted they are
82 autoscaled. A good demonstration of PDL broadcasting can be had by
83 giving iis() a data *cube* - iis() will be repeatedly called for each
84 plane of the cube resulting in a poor man's movie!
85 If supplied, "TITLE" is used to label the frame, if no title is
87 supplied, either the "OBJECT" value stored in the image header or a
88 default string is used (the title is restricted to a maximum length of
89 32 characters).
90 To specify which frame to draw to, either use the package variable
92 $iisframe, or the "FRAME" option.
93 iiscur
95 Return cursor position from an IIS device (e.g. SAOimage/Ximtool)
96 ($x,$y) = iiscur($ch)
98 This function puts up an interactive cursor on the IIS device and
100 returns the "($x,$y)" position and the character typed ($ch) by the
101 user.
102 iiscirc
104 Draws a circle on a IIS device (e.g. SAOimage/Ximtool)
105 (x(),y(),radius(),colour())
107 iiscirc $x, $y, [$radius, $colour]
109 Draws circles on the IIS device with specified points and colours.
111 Because this module uses PDL::PP broadcasting you can supply lists of
112 points via 1D arrays, etc.
113 An amusing PDL idiom is:
115 pdl> iiscirc iiscur
117 Note the colours are the same as IRAF, viz:
119 201 = cursor color (white)
121 202 = black
122 203 = white
123 204 = red
124 205 = green
125 206 = blue
126 207 = yellow
127 208 = cyan
128 209 = magenta
129 210 = coral
130 211 = maroon
131 212 = orange
132 213 = khaki
133 214 = orchid
134 215 = turquoise
135 216 = violet
136 217 = wheat
137 saoimage
139 Starts the SAOimage external program
140 saoimage[(command line options)]
142 Starts up the SAOimage external program. Default FIFO devices are
144 chosen so as to be compatible with other IIS module functions. If no
145 suitable FIFOs are found it will offer to create them.
146 e.g.:
148 pdl> saoimage
150 pdl> saoimage( -geometry => '800x800' )
151 ximtool
153 Starts the Ximtool external program
154 ximtool[(command line options)]
156 Starts up the Ximtool external program. Default FIFO devices are chosen
158 so as to be compatible with other IIS module functions. If no suitable
159 FIFOs are found it will offer to create them.
160 e.g.
162 pdl> ximtool
164 pdl> ximtool (-maxColors => 64)
165
167 None known
168
170 Copyright (C) Karl Glazebrook 1997. All rights reserved. There is no
171 warranty. You are allowed to redistribute this software / documentation
172 under certain conditions. For details, see the file COPYING in the PDL
173 distribution. If this file is separated from the PDL distribution, the
174 copyright notice should be included in the file.
175perl v5.38.0 2023-07-21 IIS(3)