Macros


Contents Summary

Detailed Contents
1. Introduction
2. Starting DigImage
3. Basic Operation
4. Sample Session
5. Command Files
6. Movies
7. Coordinate Systems
8. Warnings, Errors and Crashes
9. Utilities
10. Macros
11. Other Considerations
12. Updates
Appendix A: Menus
Index


10 Macros

A number of DigImage macros (command files) are supplied. The purpose of these is two-fold: to provide a useful library of macros, and to act as a set of worked examples illustrating many of the features of the command file language. These macros may be invoked by any of the normal methods for starting a command file (e.g. !P macro_name), provided there is not a command file by the same name in the current directory. This is possible since if a command file is requested which is not in the current directory, and a full path specification was not given, then DigImage will search the %DigImage%\Macros directory for that file.

The following macros are supplied with DigImage:

Macro fileDescription
BackMovi.CMD The example of movie processing used in section 6.3 Corrects a movie for variations in background illumination.
Bisect.CMD Can be used to find the root of an equation using the bisection method. On entry !!0 and !!1 contain the initial guesses, !!2 the tolerance and !0 the equation (expressed in terms of X). On exit, !!P0 contains the root and !!P1 the function at this point.
BlckFilt.CMD Applies [;FMB Black (noise) filter] to buffer !!0. May use in conjunction with the DoAll macro.
CheckRef.CMD Scans through a range of buffers, checking to see which has the largest RMS error for the reference points.
ColourVt.CMD Produce a single full colour picture from video tape. This macro is less general than TrueCol.CMD.
CombMovi.CMD Similar to ProcMovi.CMD, but may be used to combine multiple source movies into a single destination movie, or to extract some other form of data from the source movies. The command file MeanMovi.CMD provides an example of it use.
ContFill.CMD Draw and fill contours at regular spacing on buffer. May use in conjunction with DoAll.CMD macro.
Contour.CMD Contours a series of buffers at specific contour level. Worked example in the DigImage Overview.
DoAll.CMD Applies a specified macro to each of the buffers in turn.
DyeCont.CMD Macro for acquiring, enhancing and contouring a time series of dye images. Worked example in the DigImage Overview.
EraseAll.CMD Erases all the buffers.
EvenLine.CMD Applies the even line averaging interlace filter to a range of buffers.
Extract.CMD Extracts a single image from a movie. See section 6.3
ExtractN.CMD Extracts a sequence of images from a movie. See section 6.3
FiltAll.CMD Apply specified filter to all buffers.
Filter.CMD Applies [;FL Fast low pass filter] to a range of buffers.
GrabList.CMD Grabs images at times specified in a data file.
Insert.CMD Inserts a single image in a movie. See section 6.3
InsertN.CMD Inserts a sequence of images in a movie. See section 6.3
IntrLace.CMD Applies the odd line averaging interlace filter to buffers !!1 to !!2. This macro is called by DyeCont.CMD and is one of the worked examples in the DigImage Overview.
IntScale.CMD Adds an intensity scale, complete with key values, to the current buffer.
Island.CMD Applies the [;CI Island filter] to buffer !!0 and a specified threshold. May be used in conjunction with DoAll.CMD macro.
Laplace5.CMD Implement a Laplace like filter using a 5x5 convolution. This filter is suitable for use with the DoAll.CMD macro.
Laplace7.CMD Implement a Laplace like filter using a 7x7 convolution. This filter is suitable for use with the DoAll.CMD macro.
ListCMD.CMD Lists the system macros: i.e. this file.
LoadSeq.CMD Loads a sequence of buffers with a numeric extension (such as those saved by SaveSeq.CMD).
LowPass.CMD Applies the fast low pass convolution filter to a range of buffers.
Mask.CMD Produces a contour mask for a series of buffers.
MeanMovi.CMD Sample use of CombMovi.CMD. This command file can be used to create an ensemble mean movie from multiple source movies.
Movi2Raw.CMD Converts a .MOV movie file to a sequence of raw image files of the form base_name.xxx where xxx is a three digit number.
Movi2Seq.CMD Converts a .MOV movie file to a sequence of compressed image files of the form base_name.xxx where xxx is a three digit number.
Multiply.CMD Multiply a range of buffers by a constant. May be nested.
OddLines.CMD Applies the odd line averaging interlace filter to a range of buffers.
ProcMovi.CMD Provides a framework for processing movies. See section 6.3
SaveSeq.CMD Saves a sequence of buffers in files with a numeric extension.
Streak.CMD Creates real time streak photos of particles.
Streak.CMD Creates real time streak photos of particles.
Streak2.CMD Similar to Streak.CMD but with interactive adjustment of threshold and streak length.
Subtract.CMD Subtract a constant from a range of buffers. May be nested.
TimeList.CMD Reads in a list of positive times into !!b... The number read is returned in !!a.
TrueCol.CMD Processes a video tape to produce true colour images.
VTRGrab.CMD Grab a sequence of buffers from the VTR. Worked example in the DigImage Overview.
VTRTimed.CMD Grab a sequence of !!a images whose times are given by !!b, !!c, ...
YesRange.CMD Specifies a range of buffers for a buffer number/yes buffer list.

This list may be generated from within DigImage through the macro ListCMD.CMD. Further user-defined macros may be added to the system by simply copying them the %DigImage%\Macros directory. While a description may be added to ListCMD.CMD for each, it is probably more convenient to add !P ListUser.CMD to ListCMD.CMD and add an appropriate description there. This will facilitate updating DigImage where ListCMD.CMD may have been changed.

Goto next document (Considerations)


Links

SYSTEM OVERVIEW

Contents
Index

OTHER

DigImage documentation page
DigImage home page
Stuart Dalziel's home page


Stuart Dalziel, last page update: 21 June 1999