• Introduction
• Built-in Arrays
• Built-in Commands and Functions
  • File
  • Edit
  • Options
  • Process
  • Analyze
  • Special
  • Stacks
  • Windows
  • Miscellaneous Commands
  • Miscellaneous Functions
  • Math Functions
  • Paste Control
  • String Functions
  • Serial I/O
  • Multiple Arguments

• NIH Image Manual

Introduction [Contents]

The documentation provided here assumes the reader has some Pascal programming experience. If this is not the case, you will probably need to read an introductory Pascal text book such as "Programming in Pascal" by Peter Grogono, or "Oh! Pascal" by Doug Cooper and Michael Clancy. There is also an "alternative" macro reference manual available from zippy.nimh.nih.gov/pub/nih-image/documents/macro_notes.hqx

Here is an example macro file containing one macro and a function called by that macro. You can try the macro by copying the indented text to the Clipboard, pasting it into a blank NIH Image text window, selecting "Load Macros from Window" from the Special menu, and then selecting "Do Exponentiation... [P]" from the Special menu.

{Example macro file.}
{Comments go between curly braces.}

var
   x,y,z: integer; {Global variables}


function Power(x, n: real): real;
{raise x to the nth power}
begin
    power := exp(ln(x) * n);
end;


macro 'Do Exponentiation... [P]';
var
    base, ex: real;
begin
    base := GetNumber('Base:', 2);
    ex := GetNumber('Exponent:', 5);
    PutMessage(power(base, ex):6:3);
end;

Global variables (optional) are defined at the beginning of the file before any functions, procedures or macros. Text within curly braces ({ }) is treated as a comment. Macro files cannot be larger than 32K.

The text in quotes following the keyword Macro is passed unchanged to the Macintosh Menu Manager, becoming a new command at the bottom of the Special menu. Macros may be assigned to keys by enclosing the key character in brackets. For example, you can execute the "Do Exponentiation..." macro by pressing the "P" key. Use "F1", "F2", etc. to assign macros to function keys. A few characters ( ';', '^', '!','<', '/', '(' ) have special meaning to the Menu Manager, and should normally be avoided. You can use / to assign a command key equivalent to a macro, e.g., 'Test Macro /6'. Use '(-' as the name of an empty macro to create a dividing line in the Special menu.

Functions and procedures may not be nested inside other functions and procedures, or inside macros. However, unlike Pascal, variables declared in a calling procedure or macro are made available to a called procedure. Function and procedure names must be unique in the first twelve characters.

Key Words

Operators

Types

Both integer and real variables are stored internally in extended precision real format, which has a range of 1.9 x 10-495 to 1.1 x 10 4932 and 19-20 digits precision. Real numbers are automatically converted (by rounding) to integer without warning as needed. Strings have a maximum length of 255 characters and string comparisons are case insensitive. Variable names must be unique within the first twelve characters.

Built-in Arrays [Contents]

Scion[1]   8-bit DAC(A)         read/write
Scion[2]   8-bit DAC(B)         read/write
Scion[3]   8-bit Control Reg 1  read only
Scion[4]   4 digital out bits   read/write

  Name            Index Range    Value Range      Permission

results arrays   1 - Max Meas.   real            read/write
Histogram        0 - 255         pos. integer    read only
RedLUT           0 - 255         0 - 255         read/write
GreenLUT         0 - 255         0 - 255         read/write
BlueLUT          0 - 255         0 - 255         read/write
LineBuffer       0 - 4095        0 - 255         read/write
xCoordinates     1 - 10000       real            read only
yCoordinates     1 - 10000       real            read only
Scion            1 - 4           0 - 255         varies
PlotData         0 - 4095        real            read only

Built-in Commands and Functions [Contents]

File Menu [Contents]

Edit Menu [Contents]

Options Menu [Contents]

Process Menu [Contents]

Analyze Menu [Contents]

Special Menu [Contents]

Stacks Menu [Contents]

Windows Menu [Contents]

Miscellaneous Macro Commands [Contents]

Miscellaneous Functions [Contents]

Math Functions [Contents]

Paste Control Related Commands [Contents]

String Functions [Contents]

Serial I/O [Contents]

Multiple Arguments [Contents]