1IIS(3)                User Contributed Perl Documentation               IIS(3)
2
3
4

NAME

6       PDL::Graphics::IIS - Display PDL images on IIS devices (saoimage/xim‐
7       tool)
8

SYNOPSIS

10        use PDL::Graphics::IIS;
11        saoimage ( -geometry => '800x800' );
12        iis rvals(100,100);
13

DESCRIPTION

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 origi‐
18       nal IIS CRT itself if they aren't all in museums!
19
20       These programs should be familiar to astronomer's - they are used by
21       the common IRAF system. The programs and their HTML documentation can
22       be obtained from the following URLs:
23
24        SAOimage: http://tdc-www.harvard.edu/software/saoimage.html
25        Ximtool:  http://iraf.noao.edu/iraf/web/projects/x11iraf/x11iraf.html
26
27       Non-astronomer's may find they quite nifty for displaying 2D data.
28
29       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 sup‐
32       ported by the module are:
33
34        imt512, imt800, imt1024, imt1600, imt2048, and imt4096.
35
36       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
40        -------------------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
54       (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
58       The Perl variable $iisframe is also exported from the module and con‐
59       trols 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
63       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

FUNCTIONS

71       iis
72
73       Displays an image on a IIS device (e.g. SAOimage/Ximtool)
74
75        iis $image, [ { MIN => $min, MAX => $max,
76                        TITLE => 'pretty picture',
77                        FRAME => 2 } ]
78        iis $image, [$min,$max]
79
80        (image(m,n),[\%options]) or (image(m,n),[min(),max()])
81
82       Displays image on a IIS device. If "min()" or "max()" are omitted they
83       are autoscaled. A good demonstration of PDL threading can be had by
84       giving "iis()" a data *cube* - "iis()" will be repeatedly called for
85       each plane of the cube resulting in a poor man's movie!
86
87       If supplied, "TITLE" is used to label the frame, if no title is sup‐
88       plied, either the "OBJECT" value stored in the image header or a
89       default string is used (the title is restricted to a maximum length of
90       32 characters).
91
92       To specify which frame to draw to, either use the package variable
93       $iisframe, or the "FRAME" option.
94
95       iiscur
96
97       Return cursor position from an IIS device (e.g. SAOimage/Ximtool)
98
99        ($x,$y) = iiscur($ch)
100
101       This function puts up an interactive cursor on the IIS device and
102       returns the "($x,$y)" position and the character typed ($ch) by the
103       user.
104
105       iiscirc
106
107       Draws a circle on a IIS device (e.g. SAOimage/Ximtool)
108
109        (x(),y(),radius(),colour())
110
111        iiscirc $x, $y, [$radius, $colour]
112
113       Draws circles on the IIS device with specied points and colours.
114       Because this module uses PDL::PP threading you can supply lists of
115       points via 1D arrays, etc.
116
117       An amusing PDL idiom is:
118
119        perldl> iiscirc iiscur
120
121       Note the colours are the same as IRAF, viz:
122
123        201 = cursor color (white)
124        202 = black
125        203 = white
126        204 = red
127        205 = green
128        206 = blue
129        207 = yellow
130        208 = cyan
131        209 = magenta
132        210 = coral
133        211 = maroon
134        212 = orange
135        213 = khaki
136        214 = orchid
137        215 = turquoise
138        216 = violet
139        217 = wheat
140
141       saoimage
142
143       Starts the SAOimage external program
144
145        saoimage[(command line options)]
146
147       Starts up the SAOimage external program. Default FIFO devices are cho‐
148       sen so as to be compatible with other IIS module functions. If no suit‐
149       able FIFOs are found it will offer to create them.
150
151       e.g.:
152
153        perldl> saoimage
154        perldl> saoimage( -geometry => '800x800' )
155
156       ximtool
157
158       Starts the Ximtool external program
159
160        ximtool[(command line options)]
161
162       Starts up the Ximtool external program. Default FIFO devices are chosen
163       so as to be compatible with other IIS module functions. If no suitable
164       FIFOs are found it will offer to create them.
165
166       e.g.
167
168        perldl> ximtool
169        perldl> ximtool (-maxColors => 64)
170

BUGS

172       None known
173

AUTHOR

175       Copyright (C) Karl Glazebrook 1997.  All rights reserved. There is no
176       warranty. You are allowed to redistribute this software / documentation
177       under certain conditions. For details, see the file COPYING in the PDL
178       distribution. If this file is separated from the PDL distribution, the
179       copyright notice should be included in the file.
180
181
182
183perl v5.8.8                       2006-12-02                            IIS(3)
Impressum