The Image Window Library (IWL) consists of a set of function calls that allow you to communicate with IVE's Image Windows (Monitors) from your application program. The Monitor program displays multiwave, multitime, volumetric image data as a stack of sections, which can be traversed using mouse or key events or thru a calling application. Multiple waves can be displayed together, overlayed in different colors, or one at a time in pseudocolor. The Monitor also draws graphics on top of images to aid in segmenting, region selection, or any kind of marking that contributes to image understanding. There can be multiple Monitors running at any one time and applications can communicate with any or all of them. For just about everything that the monitor can do, there is a function call that returns the current setting, and for many things there is a function call to change the setting. The IW Lib, IM Lib and the WM Lib work together to make programs interactive with the monitor. Most header information is accessed thru IM calls; events such as keypress, mouse and display change are registered with WM calls. Then information such as mouse position, current display section, wave, wid etc are returned through IWL...
C programs using the IWL need to include IWInclude.h.
Release Notes |
Initialization and Shutdown |
Window Attributes |
Image Display |
Image Info |
Graphics |
Mouse, Keys and Events |
Query
Shared Memory |
Utility Functions |
Matrix and Vector Operations |
Alphabetical List of Functions
New functions or changes which break backward compatibility made since the end of 1998:
Of the following functions, IWAttach may be of use to many applications in order to explicitly initialize communications with the image windows. The remaining functions are only useful to applications that need to create or destroy the infrastructure for the image windows.
The following set of calls modify or return the current settings for the various attributes of an image window.
These calls effect the display of images in the window.
The image file header contains all sorts of information about the data. Most of the window header parallels the image header and so data info is available thru the IM calls. These calls reference information applicable only to image windows and not files.
The following graphics calls let you put graphics into the monitor window. A list of the graphics is maintained so that you only need to tell the monitor once about the graphic and it will be displayed whenever the users returns to a section it is supposed to be displayed in. All of the IWGrAdd calls draw 2D objects only. For all of the IWGrAdd calls, there are four versions:
The version without a D at the end is the window coordinate version. This means that regardless of the zoom of your underlying image, your graphics will remain a fixed size and will be displayed no matter which section you change to. For window graphics, you will most likely need to scale your x and y range to fit in the windows range which is by default, 0 -512.
2D graphics also are drawn to all sections, but are in data coordinates, so when the image is zoomed up or down, the graphics will zoom along with it.
3D graphics are only drawn to the specified z section. If there are multiple waves or times in the image window, the graphic will be shown in this z section for all waves and times.
5D graphics let you specify a z, wave and time so that the graphic will only show up in one z, one wave and one time section. 2D and 3D graphics are actually a subset of 5D graphics in that if you enter a -1 in the z parameter, the graphic will be drawn in all z's, similarly if you enter -1 for wave, the graphic would be shown in the specified section in all waves, and the same for time.
Once graphics are added, they need to be displayed. They will either be displayed the first time the image is redrawn or by using a call to draw the graphic on top of the image.
When the graphics are no longer needed, they need to be removed.
Use these calls to control which window the 5D model graphics are drawn into. The model graphics do not use the above IWGr calls.
Use when fast graphics are needed for things like rubberbanding or roaming graphic objects. Instead of redrawing the image and graphics, the graphic can just be drawn into the overlay buffer.
Events are generally registered using WMMenu calls: WMAddEventHandler and WMAddDisplayChangeEvent.
Explicitly initializes communications with image windows.
int IWAttach(void);
integer function iwattach()
IWAttach performs the necessary steps to enable an application to communicate with the image windows. IWAttach returns IW_SUCCESS (1) if it could establish the communication channel. IWAttach returns IW_ERROR (-1) if it could not establish the communication channel. One possible cause for a failure is that no application had previously called IWStart to create the infrastructure necessary to communicate with image windows.
Many applications do not need to call IWAttach because a successful attempt to open an image window with IMOpen or IWAttachWin implicitly enables the communication channel. As a corollary, any IW function that expects a stream number as an argument can be safely called: either the stream number has been attached to an image window or the stream is not attached to an image window and the function will simply return. Of the remaining IW functions, the following may be safely called whether or not the communication channel to the image windows has been enabled:
Creates the components needed for communication with the image windows.
int IWStart(int left, int bottom, int width, int height);
integer function iwstart(left, bottom, width, height)
integer left, bottom, width, height
Allocates and initializes the resources necessary to create image windows and communicate with them. The four arguments, left, bottom, width, and height, are a relic: the only effect they have is on the behavior of IWRtScrnGeom. Traditionally, applications have passed zero for left and bottom, 1280 for width, and 1024 for height.
Calling IWStart while the user already has an image windows session will have disastrous consequences for both the old and new sessions unless the environment variable IVE_SHMDIR has been set differently in both sessions. A common practice (which unfortunately involves a race condition) is to call IWAttach to check if an image windows session has already been started, and if one has not been started, to then call IWStart.
Returns IW_SUCCESS (1) if the components necessary for creating and communicating with image windows could be created; otherwise, returns IW_ERROR (-1).
Destroys any open image windows and the infrastructure necessary to communicate with the image windows.
int IWStop(void);
integer function iwstop()
Does not currently destroy all the resources allocated by IWStart. As a workaround, applications have been using something like the C code shown below after calling IWStop:
#include<stdio.h>
#include<stdlib.h>
char* login_name = getenv("LOGNAME");
char filename[256];
char command[300];
if (login_name != 0) {
(void) sprintf(
command, "rm -rf \"%s\"/.ive_\"%s\"_*", filename, login_name
);
} else {
(void) sprintf(command, "rm -rf \"%s\"/.ive_*", filename);
}
system(command);
Always returns IW_SUCCESS (1).
Enables or disables image display buffering.
int IWAlBufImg(int istream, int iflag);
integer function iwalbufimg(istream, iflag)
integer istream, iflag
If iflag is zero, instructs the image window attached to istream to not buffer displayed images. If iflag is non-zero, instructs the image window attached to istream to buffer displayed images. Unless configured otherwise by the user, displayed images are buffered by default.
Returns IW_SUCCESS (1) if istream is attached to an image window, otherwise, returns IW_ERROR (-1).
Requests that the next redraw should clear the window background.
int IWAlClrBkg(int istream, int iflag);
integer function iwalclrbkg(istream, iflag)
integer istream, iflag
If iflag is not zero, requests that the next redraw for the image window attached to istream should clear the window's background as well. If iflag is zero, requests that the next redraw for the image window should not clear the window's background.
Returns IW_SUCCESS (1) if istream is attached to an image window, otherwise, returns IW_ERROR (-1).
Changes whether an image window uses true color or pseudocolor to display images
int IWAlColormode(int istream, int mode);
integer function iwalcolormode(istream, mode)
integer istream, mode
If mode is IW_PSEUDO (1), causes the image window attached to istream to display images composed of one wavelength rendered in pseudocolor. If mode is IW_TRUE_COLOR (0), causes the image window attached to istream to display images which can be composed of one or to three wavelengths with each wavelength rendered in a different color.
Returns IW_SUCCESS (1) if istream is attached to an image window and the workstation's graphics support the given mode; otherwise, returns IW_ERROR (-1).
Changes the names of the graphics colors associated with all windows.
int IWAlColorNames(char *colors[IW_NUM_COLORS]);
There are only IW_NUM_COLORS (12) graphic colors available at any one time, but they can be changed by modifying the RGB values with IWAlLut. Each of the colors has a name associated with it to make it easier for end users to select a color. Use IWAlColorNames to change the names associated with all the graphic colors. The new color names, colors, is an array of null-terminated strings.
IWAlColorNames ignores any characters in a color name after the first IW_COLOR_NAME_LEN (12) characters.
Returns IW_SUCCESS (1) if the color names were modified; returns IW_ERROR (-1) if the shared memory storage for the color names could not be located.
Changes the way complex-valued images are displayed.
int IWAlComplexDis(int istream, int iflag);
integer function iwalcomplexdis(istream, iflag)
integer istream, iflag
Changes how the image window attached to istream converts complex-valued data to render it as an image. iflag specifies the new conversion method and may be one of the following values:
Returns IW_SUCCESS if istream is attached to an image window which currently contains complex-valued data; otherwise, returns IW_ERROR.
Changes the mouse pointer symbol used in an image window.
int IWAlCursor(int istream, int shape);
integer function iwalcursor(istream, shape)
integer istream, shape
If shape is one, makes the mouse pointer a small red bar for the image window attached to istream. Typically this is done to hide the normal cursor when an application draws a custom cursor using the image window graphics calls. If shape is not one, changes the mouse pointer to its normal crosshair shape for the image window attached to istream.
If istream is attached to an image window, returns IW_SUCCESS (1); otherwise, returns IW_ERROR (-1).
Changes the interval between repetitions automatically generated for key and mouse button events.
int IWAlDisDelay(int istream, int delay);
integer function iwaldisdelay(istream, delay)
integer istream, delay
Pressing and holding a key in an image window will generate multiple key press events if the button is held down long enough. IWAlDisDelay sets the interval between sending each subsequent event to be delay microseconds. Until changed, the value for the delay is one microsecond.
If istream is attached to an image window, IWAlDisDelay returns IW_SUCCESS (1); otherwise, returns IW_ERROR (-1).
Enables or disables image display.
int IWAlDisImg(int istream, int iflag);
integer function iwaldisimg(istream, iflag)
integer istream, iflag
If iflag is zero, instructs the image window attached to istream to not display images (overlayed graphics are still drawn). If iflag is non-zero, instructs the image window to display images. Unless configured otherwise by the user, images are displayed by default.
If istream is attached to an image window, returns IW_SUCCESS (1); otherwise returns IW_ERROR (-1).
Sets the horizontal and vertical offsets applied when displaying a given wave.
int IWAlDisOffset(int istream, int iwave, int ipixel[2]);
integer function iwaldisoffset(istream, iwave, ipixel)
integer istream, iwave, ipixel(2)
The positioning of images within an image window's image display area depends on four parameters: the image window's size, the size of the data's x and y dimensions, the number of rows and columns of images displayed simultaneously, and wave-dependent horizontal and vertical offsets in x and y. For the wave with index iwave in the window attached to istream, IWAlDisOffset sets the current values for that wave's horizontal and vertical offsets. IWAlDisOffset gets the horizontal offset from the first element of ipixel and gets the vertical offset from the second element of ipixel; both values are assumed to be in units of data pixels. Valid values of the wave index, iwave, range from zero to the number of waves in the window minus one.
Returns IW_SUCCESS (1) if istream is attached to a window and that window has the specified wave, iwave; otherwise, returns IW_ERROR (-1).
Changes the currently displayed section (specified by its z, wave, and time indices).
int IWAlDisSec_ZWT(int istream, int iz, int iw, int it);
integer function iwaldissec_zwt(istream, iz, iw, it)
integer istream, iz, iw, it
Changes the currently displayed Z section (iz), wavelength (iw), and time-point (it). If the current sections in different waves are synchronized (see IWRtDisSyncMode and IWAlDisSyncMode), then the current section in other wavelengths will also be changed (enforcement of synchronization was added in the August 2000 release).
Returns IW_SUCCESS (1) if istream is attached to an image window and iz, iw, and it are valid z, wave, and time, respectively, indices for that image window. Otherwise, returns IW_ERROR (-1).
Changes the currently displayed section (specified by its index in the list of sections).
int IWAlDisSec(int istream, int isec);
integer function iwaldissec(istream, isec)
integer istream, isec
Sets isec to be the current section displayed in the window attached to istream. If the current sections in different waves are synchronized (see IWRtDisSyncMode and different waves are synchronized (see IWRtDisSyncMode and IWAlDisSyncMode), then the current section in other wavelengths will also be changed (enforcement of synchronization was added in the August 2000 release). If the image window displays multiple images in a matrix, the current section is the section show in the first image in the matrix.
It is usually more convenient to use IWAlDisSec_ZWT.
Returns IW_SUCCESS (1) if istream is attached to an image window and isec is a valid section index for that image window; otherwise, returns IW_ERROR (-1).
Enables or disables synchronized display of data with multiple waves.
int IWAlDisSyncmode(int istream, int mode);
integer function iwaldissyncmode(istream, mode)
integer istream, mode
An image window maintains the concept of a current section for each wave and can enforce a relationship between the current sections in different waves. For the image window attached to istream, IWAlDisSyncMode changes the relationship enforced between the current sections in different waves. The new policy is set by mode which may be one of the following:
Unless configured otherwise by the user, the default behavior for image windows is IW_APPLY_SYNC.
Returns IW_SUCCESS (1) if istream is attached to an image window; otherwise, returns IW_ERROR (-1).
Changes the decorations added to an image display window.
int IWAlDisWinBdr(int istream, int borderSettings);
integer function iwaldiswinbdr(istream, borderSettings)
integer istream, borderSettings
The parameter borderSettings sets what type of decorations are present. Valid values are:
If istream is attached to an image window and borderSettings is one of the allowed values shown above, returns IW_SUCCESS (1); otherwise returns IW_ERROR (-1).
Changes which menus and tool bars are shown with an image window.
int IWAlDisWinTool(int istream, int toolSettings);
integer function iwaldiswintool(istream, toolSettings)
integer istream, toolSettings
The argument toolSettings sets what type of menus and tool bars are present for the display window attached to istream. Valid values for toolSettings are a bitwise or (or simple sum in FORTRAN) of one or more of the following:
If istream is attached to an image window and toolSettings is one of the values shown above, returns IW_SUCCESS (1); otherwise, returns IW_ERROR (-1).
Changes the byte ordering and floating-point representation assumed for an image file.
int IWAlFileFormat(int istream, int iflag);
integer function iwalfileformat(istream, iflag)
integer istream, iflag
Two different formats for image data files are supported: one in which multi-byte quantities are written in big-endian format and one in which they are written in little-endian format. Both formats use IEEE floating point representation. By default, the library automatically detects the format of the file when reading it and will apply any necessary byte swapping. When writing files, the default is to always write them in the big-endian format. If you wish to override these defaults, use IWAlFileFormat to alter how subsequent reads and writes will be performed. Setting iflag to a non-zero value will force the file to be interpreted in the small-endian format; setting it to zero forces the use of the big-endian format.
Prior to the June 1999 release of Priism, the two formats supported were a big-endian one which used the IEEE representation for floating-point values and a little-endian one which used a VAX representation for floating-point values. Library support for the VAX format was dropped in the June 1999 release and replaced with the little-endian format with IEEE floating-point values.
If istrream is attached to an image window, IWAlFileFormat returns IW_SUCCESS (1); otherwise, returns IW_ERROR.
Changes the name of the file associated with a wave in an image window.
int IWAlFilename(int istream, int iwave, char *filename);
integer function iwalfilename(istream, iwave, filename)
integer istream, iwave
character filename(*)
Changes the name of the file associated with wave, iwave, in the image window referenced by istream to be filename.
Returns IW_SUCCESS if istream is attached to an image window and iwave is a valid wave index for that window; otherwise, returns IW_ERROR.
Changes the graphic colors associated with each wavelength.
int IWAlGrColors(int istream, int icolor[IW_MAX_WAVE]);
integer function iwalgrcolors(istream, icolor)
integer istream, icolor(5)
Sets the graphic color for the ith wave to the ith element of icolor where i ranges from zero to IW_MAX_WAVE - 1.
Returns IW_ERROR (-1) if istream is not valid or any of elements of icolor are not in the range from 0 to IW_NUM_COLORS - 1; otherwise, returns IW_SUCCESS (1).
Enables or disables display of graphics on an image window.
int IWAlGrDis(int istream, int iflag);
integer function iwalgrdis(istream, iflag)
integer istream, iflag
If iflag is not zero, enables display of graphics in the image window attached to istream. If iflag is zero, disables display of graphics in the image window attached to istream.
Returns IW_SUCCESS (1) if istream is attached to an image window; otherwise, returns IW_ERROR (-1).
Allows the graphics from more than one section to be drawn when a single image is drawn.
int IWAlGrDisRange(int istream, int range[4]);
integer function iwalgrdisrange(istream, range)
integer istream, range(4)
Sets the range for drawing graphics in istream. range has four elements:
If istream is attached to an image window, returns IW_SUCCESS (1); otherwise, returns IW_ERROR (-1).
Sets the image display colors for each channel ("wavelength") in the image window.
int IWAlImgColor(int istream, int icolor[IW_MAX_WAVE]);
integer function iwalimgcolor(istream, icolor)
integer istream, icolor(5)
The image display color for each wavelength is given in icolor. Valid values of icolor are: IW_RED (1), IW_GREEN (2), IW_BLUE (4), IW_WHITE (7), IW_BLACK (0), IW_YELLOW (3), IW_PINK (5), or IW_CYAN (6).
If istream is attached to an image window and icolor is one of the valid options listed above, IWAlImgColor returns IW_SUCCESS; otherwise, returns IW_ERROR.
Enables or disables interpolation of zoomed up images.
int IWAlInterp(int istream, int iflag);
integer function iwalinterp(istream, iflag)
integer istream, iflag
Sets how the image window attached to istream displays images when the zoom factor is greater than one. If iflag is 0, the zoomed images will not be interpolated; if iflag is not 0, the zoomed images will be interpolated. Unless configured otherwise by the user, the default is not to interpolate images when the zoom factor is greater than one.
Returns IW_SUCCESS (1) if istream is attached to an image window; otherwise, returns IW_ERROR (-1).
Changes the RGB lookup tables (LUTs) used by all image windows.
void IWAlLut(int ired[], int igreen[], int iblue[]);
subroutine iwallut(ired, igreen, iblue)
integer ired(*), igreen(*), iblue(*)
Copies ired to the red component of the image windows' color table, igreen to the green component of the image windows' color table and iblue to the blue component of the image windows' color table. ired, igreen, and iblue must have at least imin + IWRtLutSize() + IW_NUM_COLORS elements where imin is the position of the first color used for pseudocolor image display. Use IWRtSclMinMax to determine the value of imin.
Changes the number of horizontally and vertically displayed images within a single window.
int IWAlMulDis(int istream, int imdx, int imdy);
integer function iwalmuldis(istream, imdx, imdy)
integer istream, imdx, imdy
Changes the number of horizontally (imdx) and vertically (imdy) displayed images.
By default, imdx and imdy are one.
Returns IW_SUCCESS (1) if istream is attached to an image window and imdx and imdy are both positive; otherwise, returns IW_ERROR (-1).
Sets whether data is copied when written to an image window.
int IWAlNoCopy(int istream, int iflag);
integer function iwalnocopy(istream, iflag)
integer istream, iflag
Functions that write entire images to image windows will either copy the data that is passed to them or assume control (including responsibility of deallocation) of the block of memory passed to them avoiding the overhead of a copy. The former is the default; the latter requires that the image be allocated in shared memory with IWAlcSHM.
Call IWAlNoCopy with iflag set to a non-zero value to bypass copying when writing images to istream. Call IWAlNoCopy with iflag set to zero to cause a copy to be performed when a write is done.
Returns IW_SUCCESS (1) if istream is attached to an image window; otherwise, returns IW_ERROR (-1).
int IWAlOffsetGroup(int istream, int flags[]);
integer function iwaloffsetgroup(istream, flags)
integer istream
integer flags(*)
Changes the colors used for drawing in the overlay planes.
int IWAlOVColors(int red[], int green[], int blue[]);
integer function iwalovcolors(red, green, blue)
integer red(*), green(*), blue(*)
Copies ired to the red component of the overlay color table, igreen to the green component of the overlay color table, and iblue to the blue component of the overlay color table. ired, igreen, and iblue must have at least IWRtNumOVColors() elements.
Always returns IW_SUCCESS (1).
Shifts the position of the mouse pointer to a specified location in an image window.
int IWAlPointerPos(int istream, int winpos[2]);
integer function iwalpointerpos(istream, winpos)
integer istream, winpos(2)
Moves the mouse pointer to the location winpos[0] screen pixels to the right and winpos[1] screen pixels up from the lower left hand corner of the image display area in the image window attached to istream.
Returns IW_SUCCESS if successful.
Returns IW_SUCCESS (1) if istream is attached to an image window and the coordinates in winpos fall within the bounds of that image window's image display area; otherwise, returns IW_ERROR (-1).
Changes the color map number of graphics displayed when the window is in pseudocolor mode.
int IWAlPsdGrColor(int istream, int icolor);
integer function iwalpsdgrcolor(istream, icolor)
integer istream, icolor
Valid values of icolor are between 0 and (IW_NUM_COLORS-1). By default, graphics will be displayed with a color map number of IW_RED.
Returns IW_SUCCESS if istream is attached to an image window and icolor is valid; otherwise, returns IW_ERROR.
Changes the intensity scaling values for a particular wavelength.
int IWAlScl(int istream, int iwave, float scale[4]);
integer function iwalscl(istream, iwave, scale)
integer istream, iwave
real scale(4)
IWRtScl sets wave scaling parameters for the wave iwave (valid values of iwave range from zero to the number of wavelengths in the image window minus one) in the image window attached to istream. The scaling parameters are read from scale as follows:
Returns IW_SUCCESS (1) if istream is attached to an image window and iwave is greater than or equal to zero and less than IW_MAX_WAVE (5); otherwise, returns IW_ERROR (-1).
Enables or disables display of the distance scale bar.
int IWAlSclBar(int istream, int iflag);
integer function iwalsclbar(istream, iflag)
integer istream, iflag
Calling IWAlSclBar with iflag equal to zero turns off display of the scale bar in the window attached to istream. Calling IWAlSclBar with iflag equal to one or two turns on display of the scale bar; if iflag is two, the image window will also show a label indicating the length of the scale bar.
Returns IW_ERROR (-1) if istream is not valid; otherwise, returns IW_SUCCESS (1).
Sets the maximum number of sections in a scratch window.
int IWAlScratchSize(int istream, int size);
integer function iwalscratchsize(istream, size)
integer istream, size
For the scratch window attached to istream, sets the maximum number of z sections that can be held to size
Returns IW_SUCCESS if successful.
Returns IW_ERROR if an error occurs; this can happen if istream is not valid or is not attached to a scratch window.
Changes the properties of the distance scale bar.
int IWAlSclBarAttr(int istream, int icolor, int direction, float length, int thickness, int position[2]);
integer function iwalsclbarattr(istream, icolor,
direction, length, thickness, position)
integer istream
integer icolor, direction, thickness, position(2)
real length
Changes the properties of the scale bar in the image window attached to istream. icolor sets the graphics color index used to display the scale bar. direction sets the orientation of the scale bar: if direction is one, the scale bar is vertical; if direction is zero, the scale bar is horizontal. length sets the length of the scale bar. The units of the length are the same as are used to express the pixel spacing for the data displayed in the image window: the usual convention uses microns, position sets the x and y coordinates of the lower left corner of the scale bar; the coordinates are measured in units of screen pixels and are relative to the lower left corner of the image display area. ithick sets the thickness, in screen pixels, of the scale bar.
Returns IW_ERROR if istream is not attached to an image window; otherwise, returns IW_SUCCESS.
Changes the algorithm used to scale images for display.
int IWAlSclAlgorithm(int istream, int iflag);
integer function iwalsclalgorithm(istream, iflag)
integer istream, iflag
Changes the scaling algorithm used by the image window attached to istream. iflag is a code for the new algorithm and may be one of the following:
For a fuller description of these algorithms, see IWScaleImage. This call was added in the October 1998 release.
Returns IW_SUCCESS (1) if istream is attached to an image window and iflag is one of the allowed values listed above; otherwise, returns IW_ERROR (-1).
Changes the minimum, maximum, and mean values stored for a section.
int IWAlSecMMM(int istream, int isec, float minimum, float maximum, float mean);
integer function iwalsecmmm(istream, isec, minimum, maximum, mean)
integer istream, isec
real minimum, maximum, mean
Image windows are capable of storing a minimum, maximum, and mean value to be associated with a particular section. For the image window attached to istream, IWAlSecMMM changes the minimum associated with the section, isec, to be minimum, the maximum associated with that section to be maximum, and the mean associated with that section to be mean. Valid values of isec range from 0 to the number of sections in the image window minus one.
Returns IW_SUCCESS (1) if istream is attached to an image window and isec is a valid section index for that window; otherwise, returns IW_ERROR (-1).
Changes the intensity scaling values of a particular section.
int IWAlSecScl(int istream, int isec, float *scale);
integer function iwalsecscl(istream, isec, scale)
integer istream, isec
real scale(4)
Same as IWAlScl except that scale is applied to the section, isec, rather than an entire wave.
Returns IW_SUCCESS (1) if istream is attached to an image window and isec is a valid section index for that image window; otherwise, returns IW_ERROR (-1).
Changes the recommended threshold level for a particular section.
int IWAlSecThreshold(int istream, int isec, float threshold);
integer function iwalsecthreshold(istream, isec, threshold)
integer istream, isec
real threshold
Sets the recommended intensity threshold for the section index, isec, to be threshold. Use IWRtSecThreshold to retrieve the threshold setting and IWClrSecThreshold to clear it. To set the recommended threshold for an entire wave, use IWAlThreshold.
IWAlSecThreshold was added to the IW library in February 2002.
Returns IW_SUCCESS (1) if istream is attached to an image window and isec is valid for that window; otherwise, returns IW_ERROR (-1).
Changes the direction and increment used when stepping through sections in an image window.
int IWAlStepAttr(int istream, int attributes[2]);
integer function iwalstepattr(istream, attributes)
integer istream, attributes(2)
The behavior of IWNextImage, IWPrevImage, IWLastImage, and IWFirstImage depends upon the current step direction. IWAlStepAttr sets the step direction and step size for the image window attached to istream. The value of the first element of iattr controls the step direction; it may be one of the following:
The second element of iattr is the step size. Unless configured otherwise by the user, the default is to step one section at a time along the z dimension.
Returns IW_SUCCESS (1) if istream is attached to a window and the second element of iattr is one of the allowed values; otherwise, returns IW_ERROR (-1).
Sets the swap file name used by the memory manager.
int IWAlSWFile(int istream, char *file);
integer function iwalswfile(istream, file)
integer istream
character file(*)
If necessary, the IW library memory manager will swap out image data from an image window to a file specific to that image window. By default, the file will be a temporary one created as necessary and deleted when the user closes the image window. Use IWAlSWFile to change the name of the swap file for the image window attached to istream. For well-defined behavior, IWAlSWFile should be called before any image data is written to the image window.
If istream is attached to an image window and the length of file is within the limits the library can handle, IWAlSWFile returns IW_SUCCESS (1); otherwise, returns IW_ERROR (-1).
Changes the recommended threshold level for a particular wave.
int IWAlThreshold(int istream, int wave, float threshold);
integer function iwalthreshold(istream, wave, threshold)
integer istream, wave
real threshold
Sets the recommended intensity threshold for the wave index, wave, to be threshold. Use IWRtThreshold to retrieve the threshold setting and IWClrThreshold to clear it. To set the recommended threshold for a single section, use IWAlSecThreshold.
IWAlThreshold was added to the IW library in February 2002.
Returns IW_SUCCESS (1) if istream is attached to an image window and wave is a valid wave index for that image window; otherwise, returns IW_ERROR (-1).
Shows or hides a single wavelength in a window.
int IWAlWaveMap(int istream, int iwave, int iflag);
integer function iwalwavemap(istream, iwave, iflag)
integer istream, iwave, iflag
If iflag is not zero, hides the wave with index iwave in the image window attached to istream and then forces the image window to redraw. If istream is not attached to a window or iwave is not already mapped, IWAlWaveMap returns IW_ERROR (-1); otherwise, returns IW_SUCCESS (1).
If iflag is zero, shows the wave with index iwave in the image window attached to istream and then forces the image window to redraw. If istream is not attached to a window, iwave is not a valid wave for the window, or the display color for the wave is IW_BLACK, IWAlWaveMap returns IW_ERROR (-1); otherwise, returns IW_SUCCESS (1).
Changes the screen location and size of a window.
int IWAlWinPos(int istream, int xstart, int ystart, int width, int height);
integer function iwalwinpos(istream, xstart, ystart, width, height)
integer istream
integer xstart, ystart, width, height
Moves the image window attached to istream so that its lower left corner is xstart pixel to the right and ystart pixels above the lower left corner of the screen and changes the image window to be be width screen pixels wide and height screen pixels high.
Returns IW_SUCCESS (1) if istream is attached to an image window and width and height are non-negative; otherwise, returns IW_ERROR (-1).
Changes zoom factor for a window.
int IWAlZoom(int istream, float zoom);
integer function iwalzoom(istream, zoom)
integer istream
real zoom
Sets the zoom factor to be zoom for the window attached to istream.
Returns IW_SUCCESS if successful.
Returns IW_ERROR if istream is not attached to a window or zoom is less than 0.03125 or greater than 32.
Changes the minimum, maximum, and mean values stored for a section specified by its z, wave, and time indices.
int IWAlZWTMMM(int istream, int iz, int iw, int it, float dmin, float dmax, float dmean);
integer function iwalzwtmmm(istream, iz, iw, it, dmin, dmax, dmean)
integer istream, iz, iw, it
real dmin, dmax, dmean
Is the same as IWAlSecMMM, but the section is specified by its z index, iz, wave index, iw, and time index, it rather than the section's position in the stack.
Returns IW_SUCCESS (1) if istream is attached to an image window and iz, iw, and it are valid indices for that window; otherwise, returns IW_ERROR (-1).
Clears the recommended threshold level for a particular section.
int IWClrSecThreshold(int istream, int isec);
integer function iwclrsecthreshold(istream, isec)
integer istream, isec
Clears the recommended threshold level, if any, for the section, sec. Until IWAlSecThreshold is called for the section, IWRtSecThreshold will return IW_ERROR.
IWClrSecThreshold was added to the IW library in February 2002.
Returns IW_SUCCESS (1) if istream is attached to an image window and isec is a valid section index for that window; otherwise, returns IW_ERROR (-1).
Clears the recommended threshold level for a particular wave.
int IWClrThreshold(int istream, int wave);
integer function iwclrthreshold(istream, wave)
integer istream, wave
Clears the recommended threshold level, if any, for the wave index, wave. Until IWAlThreshold is called for the wave, IWRtThreshold will return IW_ERROR.
IWClrThreshold was added to the IW library in February 2002.
Returns IW_SUCCESS (1) if istream is attached to an image window and wave is a valid wave index for that window; otherwise, returns IW_ERROR (-1).
int IWGrAddBox(int istream, float x, float y, float
width, float height, int ith, int ipat, int
icolor);
int IWGrAddBox2D(int istream, float x, float y,
float width, float height, int ith, int ipat,
int icolor);
int IWGrAddBox3D(int istream, float x, float y,
float z, float width, float height, int ith,
int ipat, int icolor);
int IWGrAddBox5D(int istream, float x, float y,
float z, int wave, int time, float width, float
height, int ith, int ipat, int icolor);
integer function iwgraddbox(istream, x, y,
width, height, ith, ipat, icolor)
integer function iwgraddbox2d(istream, x, y,
width, height, ith, ipat, icolor)
integer function iwgraddbox3d(istream, x, y, z,
width, height, ith, ipat, icolor)
integer function iwgraddbox5d(istream, x, y, z,
wave, time, width, height, ith, ipat,
icolor)
integer istream, ith, ipat, icolor, wave, time
real x, y, z, width, height
In the image window attached to istream, draws a rectangle parallel to the xy plane. x and y are the coordinates of the bottom left corner of the rectangle, width is the x (horizontal) dimension of the rectangle, and height is the y (vertical) dimension of the rectangle. IWGrAddBox assumes that the location and dimensions are in window coordinates; IWGrAddBox2D, IWGrAddBox3D, and IWGrAddBox5D assume the location and dimensions are in data coordinates. A rectangle added by IWGrAddBox or IWGrAddBox2D is not associated with a particular section and will appear in all sections. A rectangle added by IWGrAddBox3D is associated with a particular z coordinate (z) but will appear across all waves and time points. A rectangle added by IWGrAddBox5D has a z coordinate (z), wave index (wave), and time index (time) associated with it. You can use -1 for z, wave, or time if you do not want a particular coordinate assigned to the rectangle for the z, wave, or time dimension, respectively. When a coordinate is not assigned for a dimension, the rectangle appears across all sections in that dimension.
icolor sets the color index for the color of the added rectangle. Valid values for icolor range from zero to IW_NUM_COLORS-1 (11); out-of-range values for icolor are coerced to zero. ith sets the thickness, in screen pixels, of the lines used to draw the rectangles boundaries. ipat is currently ignored; for compatibility with future versions where ipat will set the style of line used, always set ipat to one.
Returns a non-negative value which is the ID of the added graphic if successful; use that ID with the functions that manipulate individual graphics or list of graphics. Returns IW_ERROR (-1) if istream is not attached to an image window.
int IWGrAddCir(int istream, float cx, float cy,
float rad, int ith, int icolor);
int IWGrAddCir2D(int istream, float cx, float cy,
float rad, int ith, int icolor);
int IWGrAddCir3D(int istream, float cx, float cy,
float cz, float rad, int ith, int icolor);
int IWGrAddCir5D(int istream, float cx, float cy,
float cz, int wave, int time, float rad, int
ith, int icolor);
integer function iwgraddcir(istream, cx, cy,
rad,ith, icolor)
integer function iwgraddcir2d(istream, cx, cy,
rad, ith, icolor)
integer function iwgraddcir3d(istream, cx, cy,
cz, rad, ith, icolor)
integer function iwgraddcir5d(istream, cx, cy,
cz, wave, time, rad, ith, icolor)
integer istream, ith, icolor, wave, time
real cx, cy, cz, rad
In the image window attached to istream, draws a circle parallel to the xy plane. cx, cy, and cz are the coordinates for the center of the circle, and rad is the radius. IWGrAddCir assumes that the center coordinates and radius are in window coordinates; IWGrAddCir2D, IWGrAddCir3D, and IWGrAddCir5D assume the center coordinates and radius are in data coordinates. A circle added by IWGrAddCir or IWGrAddCir2D is not associated with a particular section and will appear in all sections. A circle added by IWGrAddCir3D is associated with a particular z coordinate (cz) but will appear across all waves and time points. A circle added by IWGrAddCir5D has a z coordinate (cz), wave index (wave), and time index (time) associated with it. You can use -1 for cz, wave, or time if you do not want a particular coordinate assigned to the circle's center for the z, wave, or time dimension, respectively. When a coordinate is not assigned for a dimension, the circle appears across all sections in that dimension.
icolor sets the color index for the color of the added circle. Valid values for icolor range from zero to IW_NUM_COLORS-1 (11); out-of-range values for icolor are coerced to zero. ith sets the thickness of the circle's boundary. if ith is one, the boundary is one screen pixel thick; if ith is not one, the thickness is in the same units as the radius (screen pixels for IWGrAddCir and data pixels for IWGrAddCir2D, IWGrAddCir3D, and IWGrAddCir5D).
Returns a non-negative value which is the ID of the added graphic if successful; use that ID with the functions that manipulate individual graphics or list of graphics. Returns IW_ERROR (-1) if istream is not attached to an image window.
int IWGrAddLn(int istream, float x1, float y1,
float x2, float y2, int ith, int ipat, int icolor);
int IWGrAddLn2D(int istream, float x1, float y1,
float x2, float y2, int ith, int ipat, int icolor);
int IWGrAddLn3D(int istream, float x1, float y1,
float z1, float x2, float y2, float z2, int
ith, int ipat, int icolor);
int IWGrAddLn5D(int istream, float x1, float y1,
float z1, float x2, float y2, float z2, int
wave, int time, int ith, int ipat, int icolor);
integer function iwgraddln(istream, x1, y1, x2,
y2, ith, ipat, icolor)
integer function iwgraddln2d(istream, x1, y1,
x2, y2, ith, ipat, icolor)
integer function iwgraddln3d(istream, x1, y1,
z1, x2, y2, z2, ith, ipat,
icolor)
integer function iwgraddln5d(istream, x1, y1,
z1, x2, y2, z2, wave, time,
ith, ipat, icolor)
integer istream, wave, time, ith, ipat, icolor
real x1, y1, z1, x2, y2, z2
In the image window attached to istream, draws a single line segment between two specified points. x1, y1, and z1 are the coordinates for the first endpoint, and x2, y2, and z2 are the coordinates for the second endpoint. IWGrAddLn assumes that the endpoints' coordinates are in window coordinates; IWGrAddLn2D, IWGrAddLn3D, and IWGrAddLn5D assume the endpoints' coordinates are in data coordinates. A line segment added by IWGrAddLn or IWGrAddLn2D is not associated with a particular section and will appear in all sections. A line segment added by IWGrAddLn3D is not associated with any wave or time point and appears across all waves and time points. You can use -1 for z1 and z2, wave, or time if you do not want a particular coordinate assigned to the point for the z, wave, or time dimension, respectively. When a coordinate is not assigned for a dimension, the point appears across all sections in that dimension.
ith sets the thickness of the line segment in screen pixels. ipat is currently ignored; for compatibility with future versions where ipat will set the style of line used, always set ipat to one. icolor sets the color index for the color of the added line segment. Valid values for icolor range from zero to IW_NUM_COLORS-1 (11); out-of-range values for icolor are coerced to zero.
Image windows assume that z1 and z2 are the same, so calls to IWGrAddLn3D or IWGrAddLn5D which use different values for z1 and z2 will not be handled as expected.
Returns a non-negative value which is the ID of the added graphic if successful; use that ID with the functions that manipulate individual graphics or list of graphics. Returns IW_ERROR (-1) if istream is not attached to an image window or storage for the coordinates could not be allocated.
int IWGrAddLns(int istream, IW_POINT_2D_PTR plist, int
np, int ith, int ipat,int icolor);
int IWGrAddLns2D(int istream, IW_POINT_2D_PTR plist, int
np,int ith, int ipat, int icolor);
int IWGrAddLns3D(int istream, IW_POINT_PTR plist, int
np, int ith, int ipat, int icolor);
int IWGrAddLns5D(int istream, IW_POINT_PTR plist, int
np, int iwave, int itime, int ith, int ipat,
int icolor);
integer function iwgraddlns(istream, plist2d, np,
ith, ipat, icolor)
integer function iwgraddlns2d(istream, plist2d, np,
ith, ipat, icolor)
integer function iwgraddlns3d(istream, plist3d, np,
ith, ipat, icolor)
integer function iwgraddlns5d(istream, plist3d, np,
wave, time, ith, ipat, icolor)
integer istream, np, ith, ipat, icolor,
wave, time
real plist2d(2 * np), plist3d(3 * np)
In the image window attached to istream, draws np-1 connected line segments from np points: the first line segment joins the first two points, the second line segment joins the second and third points, and so on. For IWGrAddLns and IWGrAddLns2D only the x and y coordinates are specified: the points are not associated with any section and will appear in all sections. For C, the 2D coordinates are described by a IW_POINT_2D structure which has two fields: x for the x coordinate and y for the y coordinate. The list of points, plist, for IWGrAddLns and IWGrAddLns2D is then an array of IW_POINT_2D structures. For Fortran, the coordinates are passed in plist2d, a 1D array with 2 * np elements; the x coordinate of the ith point is the 2*i-1 element of plist2d and the y coordinate of the ith point is the 2*i element of plist. For IWGrAddLns3D and IWGrAddLns5D, the x, y, and z coordinates are specified. For C, the 3D coordinates are described by a IW_POINT structure which has three fields: x for the x coordinate, y for the y coordinate, and z for the z coordinate. The list of points, plist, for IWGrAddLns3D and IWGrAddLns5D is then an array of IW_POINT structures. For Fortran, the coordinates are passed in plist3d, a 1D array with 3 * np elements; for the ith point, the x coordinate of the is the 3*i-2 element of plist3d, the y coordinate is the 3*i-1 element of plist3d, and the z coordinate is the 3*i element of plist3d.
IWGrAddLns assumes that the point coordinates are in window coordinates; IWGrAddLns2D, IWGrAddLns3D, and IWGrAddLns5D assume that the point coordinates are in data coordinates. The line segments added by IWGrAddLns3D will appear across all waves and time points. The segments added by IWGrAddLns5D are associated with a particular wave, whose index is wave, and time point, whose index is time. You can use -1 for the z coordinate, wave, or time if you do not want a particular coordinate assigned for the z, wave, or time dimension, respectively. When a coordinate is not assigned for a dimension, the line segments appear across all sections in that dimension.
ith sets the thickness of the line segment in screen pixels. ipat is currently ignored; for compatibility with future versions where ipat will set the style of line used, always set ipat to one. icolor sets the color index for the color of the added line segment. Valid values for icolor range from zero to IW_NUM_COLORS-1 (11); out-of-range values for icolor are coerced to zero.
Image windows assume that all the points have the same z coordinate so calls to IWGrAddLns3D or IWGrAddLns5D which have points with different z values will not be handled as expected.
Returns a non-negative value which is the ID of the added graphic if successful; use that ID with the functions that manipulate individual graphics or list of graphics. Returns IW_ERROR (-1) if istream is not attached to an image window or the attempt to allocated space for the coordinates failed.
int IWGrAddMultLns(int istream, IW_POINT_2D_PTR plist,
int np, int ith,int ipat, int icolor);
int IWGrAddMultLns2D(int istream,IW_POINT_2D_PTR plist,int
np,int ith,int ipat,int icolor);
int IWGrAddMultLns3D(int istream, IW_POINT_PTR plist,
int np, int ith, int ipat, int icolor);
int IWGrAddMultLns5D(int istream,IW_POINT_PTR plist, int
np, int iwave, int itime, int ith, int ipat,
int icolor);
integer function iwgraddmultlns(istream, plist2d, np,
ith, ipat, icolor)
integer function iwgraddmultlns2d(istream, plist2d,
np, ith, ipat, icolor)
integer function iwgraddmultlns3d(istream, plist3d,
np, ith, ipat, icolor)
integer function iwgraddmultlns5d(istream, plist3d,
np, wave, time, ith, ipat, icolor)
integer istream, np, ith, ipat, icolor, wave, time
real plist2d(2 * np), plist3d(3 * np)
In the image window attached to istream, draws np/2 line segments from np points: the first line segment joins the first two points, the second line segment joins the third and fourth points, and so on. Unlike the IWGrAddLns family of functions, the segments are not guaranteed to be connected. For IWGrAddMultLns and IWGrAddMultLns2D only the x and y coordinates are specified: the points are not associated with any section and will appear in all sections. For C, the 2D coordinates are described by a IW_POINT_2D structure which has two fields: x for the x coordinate and y for the y coordinate. The list of points, plist, for IWGrAddMultLns and IWGrAddMultLns2D is then an array of IW_POINT_2D structures. For Fortran, the coordinates are passed in plist2d, a 1D array with 2 * np elements; the x coordinate of the ith point is the 2*i-1 element of plist2d and the y coordinate of the ith point is the 2*i element of plist2d. For IWGrAddMultLns3D and IWGrAddMultLns5D, the x, y, and z coordinates are specified. For C, the 3D coordinates are described by a IW_POINT structure which has three fields: x for the x coordinate, y for the y coordinate, and z for the z coordinate. The list of points, plist, for IWGrAddMultLns3D and IWGrAddMultLns5D is then an array of IW_POINT structures. For Fortran, the coordinates are passed in plist3d, a 1D array with 3 * np elements; for the ith point, the x coordinate of the is the 3*i-2 element of plist3d, the y coordinate is the 3*i-1 element of plist3d, and the z coordinate is the 3*i element of plist3d.
IWGrAddMultLns assumes that the point coordinates are in window coordinates; IWGrAddMultLns2D, IWGrAddMultLns3D, and IWGrAddMultLns5D assume that the point coordinates are in data coordinates. The line segments added by IWGrAddMultLns3D will appear across all waves and time points. The segments added by IWGrAddMultLns5D are associated with a particular wave, whose index is wave, and time point, whose index is time. You can use -1 for the z coordinate, wave, or time if you do not want a particular coordinate assigned for the z, wave, or time dimension, respectively. When a coordinate is not assigned for a dimension, the line segments appear across all sections in that dimension.
ith sets the thickness of the line segment in screen pixels. ipat is currently ignored; for compatibility with future versions where ipat will set the style of line used, always set ipat to one. icolor sets the color index for the color of the added line segment. Valid valu