.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "IIS 3pm"
.TH IIS 3pm 2024-02-05 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
PDL::Graphics::IIS \- Display PDL images on IIS devices (saoimage/ximtool)
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& use PDL::Graphics::IIS;
\& saoimage ( \-geometry => \*(Aq800x800\*(Aq );
\& iis rvals(100,100);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides an interface to any image display 'device' which support the
\&'IIS protocol' \- viz the SAOimage and Ximtool X\-windows programs, the
old SunView imtool program and presumably even the original IIS CRT itself
if they aren't all in museums!
.PP
These programs should be familiar to astronomers \- they are used by
the common IRAF system. The programs and their HTML documentation
can be obtained from the following URLs:
.PP
.Vb 2
\& SAOimage: http://tdc\-www.harvard.edu/software/saoimage.html
\& Ximtool:  http://iraf.noao.edu/iraf/web/projects/x11iraf/x11iraf.html
.Ve
.PP
Non-astronomers may find they quite nifty for displaying 2D data.
.PP
The Perl variable \f(CW$stdimage\fR is exported from the module and controls
the frame buffer configuration currently in use. The default value
is \f(CW\*(C`imt1024\*(C'\fR which specifies a \f(CW\*(C`1024x1024\*(C'\fR frame buffer. Other
values supported by the module are:
.PP
.Vb 1
\& imt512, imt800, imt1024, imt1600, imt2048, and imt4096.
.Ve
.PP
If you have a \fR\f(CI$HOME\fR\fI/.imtoolrc\fR you can use it to specify other frame
buffer names and configurations in exactly the same way you can in
IRAF. Here is a sample file:
.PP
.Vb 10
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-snip\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& # Format:  configno nframes width height
\&  1  2  512  512         # imt1|imt512
\&  2  2  800  800         # imt2|imt800
\&  3  2 1024 1024         # imt3|imt1024
\&  4  1 1600 1600         # imt4|imt1600
\&  5  1 2048 2048         # imt5|imt2048
\&  6  1 4096 4096         # imt6|imt4096
\&  7  1 8192 8192         # imt7|imt8192
\&  8  1 1024 4096         # imt8|imt1x4
\&  9  2 1144  880         # imt9|imtfs    full screen (1152x900 minus frame)
\& 10  2 1144  764         # imt10|imtfs35 full screen at 35mm film aspect ratio
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-snip\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.Ve
.PP
(Note: some versions of SAOimage may not even work if this file is not
present. If you get funny error messages about 'imtoolrc' try copying
the above to \fR\f(CI$HOME\fR\fI/.imtoolrc\fR or \fI/usr/local/lib/imtoolrc\fR)
.PP
The Perl variable \f(CW$iisframe\fR is also exported from the module and controls
which display frame number to use in programs such as Ximtool which supports
multiple frames. This allows you to do useful things such as blink between
images.
.PP
The module communicates with the IIS device down FIFO pipes (special UNIX
files) \- unlike IRAF this module does a pretty decent job of intelligently
guessing which file names to use for the pipes and will prompt for their
creating if absent. Also if SAOimage or Ximtool are started from within Perl
using the module this will guarantee correct file names!
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.SS iis
.IX Subsection "iis"
Displays an image on a IIS device (e.g. SAOimage/Ximtool)
.PP
.Vb 4
\& iis $image, [ { MIN => $min, MAX => $max,
\&                 TITLE => \*(Aqpretty picture\*(Aq,
\&                 FRAME => 2 } ]
\& iis $image, [$min,$max]
.Ve
.PP
.Vb 1
\& (image(m,n),[\e%options]) or (image(m,n),[min(),max()])
.Ve
.PP
Displays image on a IIS device. If \f(CWmin()\fR or \f(CWmax()\fR are omitted they
are autoscaled. A good demonstration of PDL broadcasting can be had
by giving \f(CWiis()\fR a data *cube* \- \f(CWiis()\fR will be repeatedly called
for each plane of the cube resulting in a poor man's movie!
.PP
If supplied, \f(CW\*(C`TITLE\*(C'\fR is used to label the frame, if no title is
supplied, either the \f(CW\*(C`OBJECT\*(C'\fR value stored in the image header or a
default string is used (the title is restricted to a maximum
length of 32 characters).
.PP
To specify which frame to draw to, either use
the package variable \f(CW$iisframe\fR, or the \f(CW\*(C`FRAME\*(C'\fR option.
.SS iiscur
.IX Subsection "iiscur"
Return cursor position from an IIS device (e.g. SAOimage/Ximtool)
.PP
.Vb 1
\& ($x,$y) = iiscur($ch)
.Ve
.PP
This function puts up an interactive cursor on the IIS device and returns
the \f(CW\*(C`($x,$y)\*(C'\fR position and the character typed (\f(CW$ch\fR)
by the user.
.SS iiscirc
.IX Subsection "iiscirc"
Draws a circle on a IIS device (e.g. SAOimage/Ximtool)
.PP
.Vb 1
\& (x(),y(),radius(),colour())
.Ve
.PP
.Vb 1
\& iiscirc $x, $y, [$radius, $colour]
.Ve
.PP
Draws circles on the IIS device with specified points and colours. Because
this module uses 
PDL::PP broadcasting you can supply lists of points via
1D arrays, etc.
.PP
An amusing PDL idiom is:
.PP
.Vb 1
\& pdl> iiscirc iiscur
.Ve
.PP
Note the colours are the same as IRAF, viz:
.PP
.Vb 10
\& 201 = cursor color (white)
\& 202 = black
\& 203 = white
\& 204 = red
\& 205 = green
\& 206 = blue
\& 207 = yellow
\& 208 = cyan
\& 209 = magenta
\& 210 = coral
\& 211 = maroon
\& 212 = orange
\& 213 = khaki
\& 214 = orchid
\& 215 = turquoise
\& 216 = violet
\& 217 = wheat
.Ve
.SS saoimage
.IX Subsection "saoimage"
Starts the SAOimage external program
.PP
.Vb 1
\& saoimage[(command line options)]
.Ve
.PP
Starts up the SAOimage external program. Default FIFO devices are chosen
so as to be compatible with other IIS module functions. If no suitable
FIFOs are found it will offer to create them.
.PP
e.g.:
.PP
.Vb 2
\& pdl> saoimage
\& pdl> saoimage( \-geometry => \*(Aq800x800\*(Aq )
.Ve
.SS ximtool
.IX Subsection "ximtool"
Starts the Ximtool external program
.PP
.Vb 1
\& ximtool[(command line options)]
.Ve
.PP
Starts up the Ximtool external program. Default FIFO devices are chosen
so as to be compatible with other IIS module functions. If no suitable
FIFOs are found it will offer to create them.
.PP
e.g.
.PP
.Vb 2
\& pdl> ximtool
\& pdl> ximtool (\-maxColors => 64)
.Ve
.SH BUGS
.IX Header "BUGS"
None known
.SH AUTHOR
.IX Header "AUTHOR"
Copyright (C) Karl Glazebrook 1997.
All rights reserved. There is no warranty. You are allowed
to redistribute this software / documentation under certain
conditions. For details, see the file COPYING in the PDL
distribution. If this file is separated from the PDL distribution,
the copyright notice should be included in the file.