IVE Programming Interfaces

The IVE environment provides six programming interfaces in FORTRAN and C for developing applications to extend IVE's capabilities. The interfaces have changed (generally in a backwardly compatible fashion) over time. The documentation links below all refer to IVE versions installed at UCSF. The example programs listed are all included in the EXAMPLE subdirectory of the IVE distribution. That same directory includes a makefile. For the IVE 3.3 version, the makefile is for IRIX only and if used as a model you should replace the ../ in the IWLLIBS and and IWINCL macro definitions with the path to the directory where IVE is installed. For the IVE 4 version, follow the instructions at the start of the makefile to adjust it for your system.

Manipulating IVE image data: IM library

Image data is stored in a standard format and can be manipulated with the IM functions. Depending on how a program is linked, the IM functions can also transparently work with image data files and display windows.

• Function Reference
  • IVE 3.3 Reference Guide
  • IVE 4 Reference Guide
• Examples
  • Creating a data file: IVE 3.3 C source code and IVE 4 C source code

Interacting with image display windows: IW library

In addition to the IM routines which work with both files and display windows, the IW routines provide operations that can only be applied to image windows.

• Function reference
  • IVE 3 Help File (text; only the C interface is documented)
  • IVE 3.3 Reference Guide
  • IVE 4 Reference Guide
• Object library description
  • IVE 3.3 Guide
• Examples
  • Inverting the lookup table: IVE 3.3 C source code and IVE 4 C source code
  • Resetting the lookup table for pseudo color display: IVE 3.3 C source code and IVE 4 C source code

Creating graphical user interfaces: WM library

• Function reference
  • IVE 3 Help File (text; only the C interface is documented)
  • IVE 3.3 Reference Guide (only the C interface is documented)
  • IVE 4 Reference Guide
• Examples
  • Common user interface elements: IVE 3.3 C source code and IVE 4 C source code
  • Displaying multiple lines of scrolled text: IVE 3.3 C source code and IVE 4 C source code
  • Arrow buttons: IVE 3.3 C source code and IVE 4 C source code
  • Effects of WMSetOverlayUse and different pulldown forms: IVE 3.3. C source code and IVE 4 C source code
  • Handling image window mouse events: IVE 3.3 C source code and IVE 4 C source code
  • Hanling mouse motion in the image window: IVE 3.3 C source code and IVE 4 C source code

Rapid development of interactive applications: IP framework

The IP framework supplies a skeleton image processing program using the IM, IW, and WM libraries which the programmer can customize. Because the skeleton program can handle all of the I/O and many aspects of the user interface, using the IP framework can speed up development.

• Function reference
  • Reference for IVE 3.3 (text)
  • Reference for IVE 4
• Examples
  • Straightforward 2D processing application which creates a binary image marking the edge of objects above a threshold: IVE 3.3 C source code, IVE 4 C source code, and IVE 4 Fortran source code
  • Copy a rectangular subset of one data file into another: IVE 3.3 C source code and IVE 4 C source code

Wrapping command-line applications with a graphical interface: IOMENU utility

The IOMENU utility facilitates writing a graphical user interface wrapper for a command-application.

• Documentation
  • IVE 3.3 Reference
  • IVE 4 Reference
• Examples
  • Interface for the ffilter application: IVE 3.3 C source code, IVE 3.3 Fortran source code, IVE 4 C source code, and IVE 4 Fortran source code

Utilities for implementing libraries: IVE library

To assist with the development of IVE 4, a set of routines were written to handle shared memory and encapsulate some operating system differences. A reference guide exists but is likely only of interest if you are maintaining the other Priism libraries.

Object Library

IVE 3.3 includes a library used by some applications for modeling the structures in data. That library is described at http://msg.ucsf.edu/IVE/IVE3.3_HTML/IWGrObj.html. To ease porting applications from IVE 3.3, IVE 4.2.3 and later include a version of the object library; the documentation for that library is at http://msg.ucsf.edu/IVE/IVE4_HTML/IWGrObj.html.

modified November 2, 2007