[ A ][ B ][ C ][ D ][ E ][ F ][ G ][ H ][ I ][ J ][ K ][ L ][ M ]
[ N ][ O ][ P ][ Q ][ R ][ S ][ T ][ U ][ V ][ W ][ X ][ Y ][ Z ]
A [ Top ]
Returns the absolute value of n.
Returns the inverse cosine (in radians) of n.
Returns the inverse sine (in radians) of n.
Calculates the inverse tangent (arctangent) of n. Returns a value in the range -PI/2 through PI/2.
Calculates the inverse tangent of y/x and returns an angle in the range -PI to PI, using the signs of the arguments to determine the quadrant. Multiply the result by 180/PI to convert to degrees.
If boolean is true, the display is refreshed each time lineTo(), drawLine(), drawString(), etc. are called, otherwise, the display is refreshed only when updateDisplay() is called or when the macro terminates.
B [ Top ]
Emits an audible beep.
Returns the bit depth of the active image: 8, 16, 24 (RGB) or 32 (float).
C [ Top ]
Uses the calibration function of the active image to convert a raw pixel value to a density calibrated value. The argument must be an integer in the range 0-255 (for 8-bit images) or 0-65535 (for 16-bit images). Returns the same value if the active image does not have a calibration function.
call("class.method", arg1, arg2, ...)
Calls a public static method in a Java class, passing an arbitrary number of string arguments, and returning a string. Refer to the CallJavaDemo macro and the ImpProps plugin for examples. Note that the call() function does not work when ImageJ is running as an unsigned applet.
changeValues(v1, v2, v3)
Changes pixels in the image or selection that have a value in the range v1-v2 to v3. For example, changeValues(0,5,5) changes all pixels less than 5 to 5, and changeValues(0x0000ff,0x0000ff,0xff0000) changes all blue pixels in an RGB image to red.
Returns the Unicode value of the character at the specified index in string. Index values can range from 0 to lengthOf(string). Use the fromCharCode() function to convert one or more Unicode characters to a string.
Closes the active image. This function has the advantage of not closing the "Log" or "Results" window when you meant to close the active image.
Returns the cosine of an angle (in radians).
D [ Top ]
Converts the number n into a string using the specified number of decimal places. Note that d2s stands for "double to string". This function will probably be replaced by one with a better name.
Creates a dialog box with the specified title. Call Dialog.addString(), Dialog.addNumber(), etc. to add components to the dialog. Call Dialog.show() to display the dialog and Dialog.getString(), Dialog.getNumber(), etc. to retrieve the values entered by the user. Refer to the DialogDemo macro for an example.
Dialog.addMessage(string) - Adds a message to the dialog. The message can be broken into multiple lines by inserting new line characters ("\n") into the string.doCommand("Command")
Dialog.addString("Label", "Initial text") - Adds a text field to the dialog, using the specified label and initial text.
Dialog.addString("Label", "Initial text", columns) - Adds a text field to the dialog, where columns specifies the field width in characters.
Dialog.addNumber("Label", default) - Adds a numeric field to the dialog, using the specified label and default value.
Dialog.addNumber("Label", default, decimalPlaces, columns, units) - Adds a numeric field, using the specified label and default value. DecimalPlaces specifies the number of digits to right of decimal point, columns specifies the the field width in characters and units is a string that is displayed to the right of the field.
Dialog.addCheckbox("Label", default) - Adds a checkbox to the dialog, using the specified label and default state (true or false).
Dialog.addCheckboxGroup(rows, columns, labels, defaults) - Adds a rowsxcolumns grid of checkboxes to the dialog, using the specified labels and default states (example). Requires 1.41c.
Dialog.addChoice("Label", items) - Adds a popup menu to the dialog, where items is a string array containing the menu items.
Dialog.addChoice("Label", items, default) - Adds a popup menu, where items is a string array containing the choices and default is the default choice.
Dialog.show() - Displays the dialog and waits until the user clicks "OK" or "Cancel". The macro terminates if the user clicks "Cancel".
Dialog.getString() - Returns a string containing the contents of the next text field.
Dialog.getNumber() - Returns the contents of the next numeric field.
Dialog.getCheckbox() - Returns the state (true or false) of the next checkbox.
Dialog.getChoice() - Returns the selected item (a string) from the next popup menu.
Runs an ImageJ menu command in a separate thread and returns immediately. As an example, doCommand("Start Animation") starts animating the current stack in a separate thread and the macro continues to execute. Use run("Start Animation") and the macro hangs until the user stops the animation.
Equivalent to clicking on the current image at (x,y) with the wand tool. Note that some objects, especially one pixel wide lines, may not be reliably traced unless they have been thresholded (highlighted in red) using setThreshold.
drawLine(x1, y1, x2, y2)
Draws a line between (x1, y1) and (x2, y2). Use setColor() to specify the color of the line and setLineWidth() to vary the line width.
drawOval(x, y, width, height)
Draws the outline of an oval using the current color and line width. See also: fillOval, setColor, setLineWidth, autoUpdate.
drawRect(x, y, width, height)
Draws the outline of a rectangle using the current color and line width. See also: fillRect, setColor, setLineWidth, autoUpdate.
drawString("text", x, y)
Draws text at the specified location. Call setFont() to specify the font. Call setJustification() to have the text centered or right justified. Call getStringWidth() to get the width of the text in pixels. Refer to the TextDemo macro for examples.
Writes the contents of the symbol table, the tokenized macro code and the variable stack to the "Log" window.
E [ Top ]
Returns true (1) if string ends with suffix. See also: startsWith, indexOf, substring, matches.
Evaluates (runs) one or more lines of macro code. See also: EvalDemo macro and runMacro function.
exec(string or strings)
Executes a native command and returns the output of that command as a string. Also opens Web pages in the default browser and documents in other applications (e.g., Excel). Refer to the ExecExamples macro for examples. Requires 1.39c.
exit() or exit("error message")
Terminates execution of the macro and, optionally, displays an error message.
Returns the exponential number e (i.e., 2.718...) raised to the power of n.
Ext (Macro Extension) Functions
These are functions that have been added to the macro language by plugins using the MacroExtension interface. As an example, the Image5D_Extensions plugin adds functions that work with the Image5D plugins, such as Ext.setDisplayMode("color") and Ext.setChannel(ch).
F [ Top ]
These functions allow you to get information about a file, read or write a text file, create a directory, or to delete, rename or move a file or directory. The FileDemo macro demonstrates how to use them. See also: getDirectory and getFileList.
File.append(string, path) - Appends string to the end of the specified file. Requires 1.41j.fill()
File.close(f) - Closes the specified file, which must have been opened using File.open().
File.dateLastModified(path) - Returns the date and time the specified file was last modified.
File.delete(path) - Deletes the specified file or directory. With v1.41e or later, returns "1" (true) if the file or directory was successfully deleted. If the file is a directory, it must be empty. The file must be in the user's home directory, the ImageJ directory or the temp directory.
File.directory - The directory path of the last file opened using open(), saveAs(), File.open() or File.openAsString(). Requires 1.38q.
File.exists(path) - Returns "1" (true) if the specified file exists.
File.getName(path) - Returns the last name in path's name sequence.
File.getParent(path) - Returns the parent of the file specified by path.
File.isDirectory(path) - Returns "1" (true) if the specified file is a directory.
File.lastModified(path) - Returns the time the specified file was last modified as the number of milliseconds since January 1, 1970.
File.length(path) - Returns the length in bytes of the specified file.
File.makeDirectory(path) - Creates a directory.
File.name - The name of the last file opened using open(), saveAs(), File.open() or File.openAsString(). Requires 1.38q.
File.open(path) - Creates a new text file and returns a file variable that refers to it. To write to the file, pass the file variable to the print function. Displays a file save dialog box if path is an empty string. The file is closed when the macro exits. Currently, only one file can be open at a time. For an example, refer to the SaveTextFileDemo macro.
File.openAsString(path) - Opens a text file and returns the contents as a string. Displays a file open dialog box if path is an empty string. Use lines=split(str,"\n") to convert the string to an array of lines.
File.openAsRawString(path) - Opens a file and returns the first 5,000 bytes as a string. Returns up to 10 megabytes if the name ends with ".txt". Refer to the First10Bytes and ZapGremlins macros for examples. Requires 1.39f.
File.openUrlAsString(url) - Opens a URL and returns the contents as a string. Returns an emptly string if the host or file cannot be found. With v1.41i and later, returns "<Error: message>" if there any error, including host or file not found.
File.openDialog(title) - Displays a file open dialog and returns the path to the file choosen by the user (example). The macro exits if the user cancels the dialog. Requires 1.39d.
File.rename(path1, path2) - Renames, or moves, a file or directory. Returns "1" (true) if successful. Requires 1.38b.
File.saveString(string, path) - Saves string as a file. Requires 1.41j.
File.separator - Returns the file name separator character ("/" or "\").
Fills the image or selection with the current drawing color.
fillOval(x, y, width, height)
Fills an oval bounded by the specified rectangle with the current drawing color. See also: drawOval, setColor, autoUpdate.
fillRect(x, y, width, height)
Fills the specified rectangle with the current drawing color. See also: drawRect, setColor, autoUpdate.
These functions do curve fitting. The CurveFittingDemo macro demonstrates how to use them. Requires 1.41k.Fit.doFit(equation, xpoints, ypoints) - Fits the specified equation to the points defined by xpoints, ypoints. Equation can be either the equation name or an index. The equation names are shown in the drop down menu in the Analyze>Tools>Curve Fitting window.floodFill(x, y)
Fit.rSquared - Returns R^2=1-SSE/SSD, where SSE is the sum of the squares of the errors and SSD is the sum of the squares of the deviations about the mean.
Fit.p(index) - Returns the specified parameter.
Fit.nParams - Returns the number of parameters.
Fit.f(x) - Returns the y value at x.
Fit.nEquations - Returns the number of equations.
Fit.getEquation(index, name, formula) - Gets the name and formula of the specified equation.
Fit.plot - Plots the current curve fit.
Fills, with the foreground color, pixels that are connected to, and the same color as, the pixel at (x, y). With 1.37e or later, does 8-connected filling if there is an optional string argument containing "8", for example floodFill(x, y, "8-connected"). This function is used to implement the flood fill (paint bucket) macro tool.
Returns the largest value that is not greater than n and is equal to an integer. See also: round.
This function takes one or more Unicode values and returns a string.
G [ Top ]
Returns the string argument passed to macros called by runMacro(macro, arg), eval(macro), IJ.runMacro(macro, arg) or IJ.runMacroFile(path, arg).
Displays a dialog box containing the specified message and "Yes", "No" and "Cancel" buttons. Returns true (1) if the user clicks "Yes", returns false (0) if the user clicks "No" and exits the macro if the user clicks "Cancel".
getBoundingRect(x, y, width, height)
Replace by getSelectionBounds.
getCursorLoc(x, y, z, modifiers)
Returns the cursor location in pixels and the mouse event modifier flags. The z coordinate is zero for 2D images. For stacks, it is one less than the slice number. For examples, see the GetCursorLocDemo and the GetCursorLocDemoTool macros.
getDateAndTime(year, month, dayOfWeek, dayOfMonth, hour, minute, second, msec)
Returns the current date and time. For an example, refer to the GetDateAndTime macro. See also: getTime.
getDimensions(width, height, channels, slices, frames)
Returns the dimensions of the current image. Requires 1.38s.
Displays a "choose directory" dialog and returns the selected directory, or returns the path to a specified directory, such as "plugins", "home", etc. The returned path ends with a file separator, either "\" (Windows) or "/". Returns an empty string if the specified directory is not found or aborts the macro if the user cancels the "choose directory" dialog box. For examples, see the GetDirectoryDemo and ListFilesRecursively macros. See also: getFileList and the File functions.getDirectory("Choose a Directory") - Displays a file open dialog, using the argument as a title, and returns the path to the directory selected by the user.getFileList(directory)
getDirectory("plugins") - Returns the path to the plugins directory.
getDirectory("macros") - Returns the path to the macros directory.
getDirectory("image") - Returns the path to the directory that the active image was loaded from.
getDirectory("startup") - Returns the path to the directory that ImageJ was launched from (usually the ImageJ directory).
getDirectory("home") - Returns the path to users home directory.
getDirectory("temp") - Returns the path to the temporary directory (/tmp on Linux and Mac OS X).
Returns an array containing the names of the files in the specified directory path. The names of subdirectories have a "/" appended. For an example, see the ListFilesRecursively macro.
Returns the height in pixels of the current image.
getHistogram(values, counts, nBins[, histMin, histMax])
Returns the histogram of the current image or selection. Values is an array that will contain the pixel values for each of the histogram counts (or the bin starts for 16 and 32 bit images), or set this argument to 0. Counts is an array that will contain the histogram counts. nBins is the number of bins that will be used. It must be 256 for 8 bit and RGB image, or an integer greater than zero for 16 and 32 bit images. With 16-bit images, the Values argument is ignored if nBins is 65536. With 16-bit and 32-bit images, and ImageJ 1.35a and later, the histogram range can be specified using optional histMin and histMax arguments. See also: getStatistics, HistogramLister, HistogramPlotter, StackHistogramLister and CustomHistogram.
Returns the unique ID (a negative number) of the active image. Use the selectImage(id), isOpen(id) and isActive(id) functions to activate an image or to determine if it is open or active.
Returns a string containing the text that would be displayed by the Image>Show Info command. To retrieve the contents of a text window, use getInfo("window.contents"). For an example, see the ListDicomTags macros. See also: getMetadata.
If the front window is a text window, returns the contents of that window. If the front window is an image, returns a string containing the text that would be displayed by Image>Show Info. Note that getImageInfo() is a more reliable way to retrieve information about an image. Use split(getInfo(),'\n') to break the string returned by this function into separate lines. Replaces the getInfo() function. Requires 1.38m.
Returns the TIFF image description tag, or an empty string if this is not a TIFF image or the image description is not available. Requires 1.39t.
Returns the subtitle of the current image. This is the line of information displayed above the image and below the title bar. Requires 1.38m.
Return the label of the current stack slice. This is the string that appears in parentheses in the subtitle, the line of information above the image. Returns an empty string if the current image is not a stack or the current slice does not have a label. Requires 1.38m.
Returns the Java property associated with the specified key (e.g., "java.version", "os.name", "user.home", "user.dir", etc.). Returns an empty string if there is no value associated with the key. See also: getList("java.properties"). Requires 1.38m.
getLine(x1, y1, x2, y2, lineWidth)
Returns the starting coordinates, ending coordinates and width of the current straight line selection. The coordinates and line width are in pixels. Sets x1 = -1 if there is no line selection. Refer to the GetLineDemo macro for an example. See also: makeLine.
Returns a list (array) of non-image window titles. For an example, see the DisplayWindowTitles macro. Requires 1.38m.
Returns a list (array) of Java property keys. For an example, see the DisplayJavaProperties macro. See also: getInfo(key). Requires 1.38m.
getLocationAndSize(x, y, width, height)
Returns the location and size, in screen coordinates, of the active image window. Use getWidth and getHeight to get the width and height, in image coordinates, of the active image. See also: setLocation,
getLut(reds, greens, blues)
Returns three arrays containing the red, green and blue intensity values from the current lookup table. See the LookupTables macros for examples.
Returns the metadata (a string) from the "Info" property of the current image. With DICOM images, this is the information (tags) in the DICOM header. See also: setMetadata. Requires 1.40b.
Returns the current slice label. The first line of the this label (up to 60 characters) is display as part of the image subtitle. With DICOM stacks, returns the metadata from the DICOM header. See also: setMetadata. Requires 1.40b.
Returns the minimum and maximum displayed pixel values (display range). See the DisplayRangeMacros for examples.
Displays a dialog box and returns the number entered by the user. The first argument is the prompting message and the second is the value initially displayed in the dialog. Exits the macro if the user clicks on "Cancel" in the dialog. Returns defaultValue if the user enters an invalid number. See also: Dialog.create.
Returns the value of the pixel at (x,y). Note that pixels in RGB images contain red, green and blue components that need to be extracted using shifting and masking. See the Color Picker Tool macro for an example that shows how to do this.
getPixelSize(unit, pixelWidth, pixelHeight)
Returns the unit of length (as a string) and the pixel dimensions. For an example, see the ShowImageInfo macro. See also: getVoxelSize.
Runs Analyze>Plot Profile (without displaying the plot) and returns the intensity values as an array. For an example, see the GetProfileExample macro.
getRawStatistics(nPixels, mean, min, max, std, histogram)
This function is similar to getStatistics except that the values returned are uncalibrated and the histogram of 16-bit images has a bin width of one and is returned as a max+1 element array. For examples, refer to the ShowStatistics macro set. See also: calibrate.
Returns a measurement from the ImageJ results table or NaN if the specified column is not found. The first argument specifies a column in the table. It must be a "Results" window column label, such as "Area", "Mean" or "Circ.". The second argument specifies the row, where 0<=row<nResults. nResults is a predefined variable that contains the current measurement count. (Actually, it's a built-in function with the "()" optional.) With ImageJ 1.34g and later, you can omit the second argument and have the row default to nResults-1 (the last row in the results table). See also: nResults, setResult, isNaN, getResultLabel.
Returns the label of the specified row in the results table, or an empty string if Display Label is not checked in Analalyze>Set Measurements.
getSelectionBounds(x, y, width, height)
Returns the smallest rectangle that can completely contain the current selection. x and y are the pixel coordinates of the upper left corner of the rectangle. width and height are the width and height of the rectangle in pixels. If there is no selection, returns (0, 0, ImageWidth, ImageHeight). See also: selectionType and setSelectionLocation.
Returns two arrays containing the X and Y coordinates of the points that define the current selection. See the SelectionCoordinates macro for an example. See also: selectionType, getSelectionBounds.
Returns the number of the currently displayed stack image, an integer between 1 and nSlices. Returns 1 if the active image is not a stack. See also: setSlice.
getStatistics(area, mean, min, max, std, histogram)
Returns the area, average pixel value, minimum pixel value, maximum pixel value, standard deviation of the pixel values and histogram of the active image or selection. The histogram is returned as a 256 element array. For 8-bit and RGB images, the histogram bin width is one. For 16-bit and 32-bit images, the bin width is (max-min)/256. For examples, refer to the ShowStatistics macro set. Note that trailing arguments can be omitted. For example, you can use getStatistics(area), getStatistics(area, mean) or getStatistics(area, mean, min, max). See also: getRawStatistics
Displays a dialog box and returns the string entered by the user. The first argument is the prompting message and the second is the initial string value. Exits the macro if the user clicks on "Cancel" or enters an empty string. See also: Dialog.create.
Returns the width in pixels of the specified string. See also: setFont, drawString. Requires v1.41d.
Returns the lower and upper threshold levels. Both variables are set to -1 if the active image is not thresholded. See also: setThreshold, getThreshold, resetThreshold.
Returns the current time in milliseconds. The granularity of the time varies considerably from one platform to the next. On Windows NT, 2K, XP it is about 10ms. On other Windows versions it can be as poor as 50ms. On many Unix platforms, including Mac OS X, it actually is 1ms. See also: getDateAndTime.
Returns the title of the current image.
getVoxelSize(width, height, depth, unit)
Returns the voxel size and unit of length ("pixel", "mm", etc.) of the current image or stack. See also: getPixelSize, setVoxelSize.
Returns the ImageJ version number as a string (e.g., "1.34s"). See also: requires.
Returns the width in pixels of the current image.
Returns the magnification of the active image, a number in the range 0.03125 to 32.0 (3.1% to 3200%).
I [ Top ]
imageCalculator(operator, img1, img2)
Runs the Process>Image Calculator tool, where operator ("add","subtract","multiply","divide", "and", "or", "xor", "min", "max", "average", "difference" or "copy") specifies the operation, and img1 and img2 specify the operands. img1 and img2 can be either an image title (a string) or an image ID (an integer). The operator string can include up to three modifiers: "create" (e.g., "add create") causes the result to be stored in a new window, "32-bit" causes the result to be 32-bit floating-point and "stack" causes the entire stack to be processed. See the ImageCalculatorDemo macros for examples.
Returns the index within string of the first occurrence of substring. See also: lastIndexOf, startsWith, endsWith, substring, toLowerCase, replace, matches.
indexOf(string, substring, fromIndex)
Returns the index within string of the first occurrence of substring, with the search starting at fromIndex.
Returns true if ImageJ is running as an applet. Requires v1.39p.
Returns true if the macro interpreter is running in batch mode. Requires v1.39p.
is("Caps Lock Set")
Returns true if the caps lock key is set. Always return false on some platforms. Requires v1.42e.
Returns true if the current image is a a multi-channel stack that uses the CompositeImage class. Requires v1.39r.
Returns true if the current image is using an inverting lookup table.
Returns true if the current image is a hyperstack. Requires v1.39k.
Returns true if the current image is locked.
Returns true if the current image is a virtual stack. Requires v1.39q.
Returns true if the image with the specified ID is active.
Returns true if the specified key is pressed, where key must be "shift", "alt" or "space". See also: setKeyDown.
Returns true if the value of the number n is NaN (Not-a-Number). A common way to create a NaN is to divide zero by zero. This function is required because (n==NaN) is always false. Note that the numeric constant NaN is predefined in the macro language.
Returns true if the image with the specified ID is open.
Returns true if the window with the specified title is open.
L [ Top ]
Returns the index within string of the rightmost occurrence of substring. See also: indexOf, startsWith, endsWith, substring.
Returns the length of a string or array.
Draws a line from current location to (x,y) .
These functions work with a list of key/value pairs. The ListDemo macro demonstrates how to use them. Requires 1.41f.List.set(key, value) - Adds a key/value pair to the list.log(n)
List.get(key) - Returns the value associated with key, or an empty string if the key is not found.
List.size() - Returns the size of the list.
List.clear() - Resets the list.
List.setList(list) - Loads the key/value pairs in list.
List.getList() - Returns the list as a string.
Returns the natural logarithm (base e) of n. Note that log10(n) = log(n)/log(10).
M [ Top ]
makeLine(x1, y1, x2, y2)
Creates a new straight line selection. The origin (0,0) is assumed to be the upper left corner of the image. Coordinates are in pixels. With ImageJ 1.35b and letter, you can create segmented line selections by specifying more than two coordinate pairs, for example makeLine(25,34,44,19,69,30,71,56).
makeLine(x1, y1, x2, y2, lineWidth)
Creates a straight line selection with the specified width. Requires 1.38u. See also: getLine.
makeOval(x, y, width, height)
Creates an elliptical selection, where (x,y) define the upper left corner of the bounding rectangle of the ellipse.
Creates a point selection at the specified location. Create a multi-point selection by using makeSelection("point",xpoints,ypoints). Use setKeyDown("shift"); makePoint(x, y); to add a point to an existing point selection.
makePolygon(x1, y1, x2, y2, x3, y3, ...)
Creates a polygonal selection. At least three coordinate pairs must be specified, but not more than 200. As an example, makePolygon(20,48,59,13,101,40,75,77,38,70) creates a polygon selection with five sides.
makeRectangle(x, y, width, height)
Creates a rectangular selection. The x and y arguments are the coordinates (in pixels) of the upper left corner of the selection. The origin (0,0) of the coordinate system is the upper left corner of the image.
makeSelection(type, xcoord, ycoord)
Creates a selection from a list of XY coordinates. The first argument should be "polygon", "freehand", "polyline", "freeline", "angle" or "point". In ImageJ 1.32g or later, it can also be the numeric value returned by selectionType. The xcoord and ycoord arguments are numeric arrays that contain the X and Y coordinates. See the MakeSelectionDemo macro for examples.
Returns true if string matches the specified regular expression. See also: startsWith, endsWith, indexOf, replace. Requires v1.39r.
Returns the greater of two values.
Returns the smaller of two values.
Sets the current drawing location. The origin is always assumed to be the upper left corner of the image.
N [ Top ]
Returns a new array containing size elements. You can also create arrays by listing the elements, for example newArray(1,4,7) or newArray("a","b","c"). For more examples, see the Arrays macro.
The ImageJ macro language does not directly support 2D arrays. As a work around, either create a blank image and use setPixel() and getPixel(), or create a 1D array using a=newArray(xmax*ymax) and do your own indexing (e.g., value=a[x+y*xmax]).
newImage(title, type, width, height, depth)
Opens a new image or stack using the name title. The string type should contain "8-bit", "16-bit", "32-bit" or "RGB". In addition, it can contain "white", "black" or "ramp" (the default is "white"). As an example, use "16-bit ramp" to create a 16-bit image containing a grayscale ramp. Width and height specify the width and height of the image in pixels. Depth specifies the number of stack slices.
Defines a menu that will be added to the toolbar when the menu tool named macroName is installed. Menu tools are macros with names ending in "Menu Tool". StringArray is an array containing the menu commands. Returns a copy of stringArray. For an example, refer to the Menus toolset. Requires v1.38b or later.
Returns number of open images. The parentheses "()" are optional.
Returns the current measurement counter value. The parentheses "()" are optional.
Returns the number of images in the current stack. Returns 1 if the current image is not a stack. The parentheses "()" are optional. See also: getSliceNumber,
O [ Top ]
Opens and displays a tiff, dicom, fits, pgm, jpeg, bmp, gif, lut, roi, or text file. Displays an error message and aborts the macro if the specified file is not in one of the supported formats, or if the file is not found. Displays a file open dialog box if path is an empty string or if there is no argument. Use the File>Open command with the command recorder running to generate calls to this function. With 1.41k or later, opens images specified by a URL, for example open("http://rsb.info.nih.gov/ij/images/clown.gif").
P [ Top ]
Converts the string argument to a number and returns it. Returns NaN (Not a Number) if the string cannot be converted into a number. Use the isNaN() function to test for NaN. For examples, see ParseFloatIntExamples.
Converts string to an integer and returns it. Returns NaN if the string cannot be converted into a integer.
Converts string to an integer and returns it. The optional second argument (radix) specifies the base of the number contained in the string. The radix must be an integer between 2 and 36. For radixes above 10, the letters of the alphabet indicate numerals greater than 9. Set radix to 16 to parse hexadecimal numbers. Returns NaN if the string cannot be converted into a integer. For examples, see ParseFloatIntExamples.
Plot.create("Title", "X-axis Label", "Y-axis Label", xValues, yValues)
Generates a plot using the specified title, axis labels and X and Y coordinate arrays. If only one array is specified it is assumed to contain the Y values and a 0..n-1 sequence is used as the X values. It is also permissible to specify no arrays and use Plot.setLimits() and Plot.add() to generate the plot. Use Plot.show() to display the plot in a window or it will be displayed automatically when the macro exits. For examples, check out the ExamplePlots macro file.
Plot.setLimits(xMin, xMax, yMin, yMax)
Sets the range of the x-axis and y-axis of plots created using Plot.create(). Must be called immediately after Plot.create().
Specifies the width of the line used to draw a curve. Points (circle, box, etc.) are also drawn larger if a line width greater than one is specified. Note that the curve specified in Plot.create() is the last one drawn before the plot is dispayed or updated.
Specifies the color used in subsequent calls to Plot.add() or Plot.addText(). The argument can be "black", "blue", "cyan", "darkGray", "gray", "green", "lightGray", "magenta", "orange", "pink", "red", "white" or "yellow". Note that the curve specified in Plot.create() is drawn last.
Plot.add("circles", xValues, yValues)
Adds a curve, set of points or error bars to a plot created using Plot.create(). If only one array is specified it is assumed to contain the Y values and a 0..n-1 sequence is used as the X values. The first argument can be "line", "circles", "boxes", "triangles", "crosses", "dots", "x" or "error bars".
Plot.addText("A line of text", x, y)
Adds text to the plot at the specified location, where (0,0) is the upper left corner of the the plot frame and (1,1) is the lower right corner. Call Plot.setJustification() to have the text centered or right justified.
Specifies the justification used by Plot.addText(). The argument can be "left", "right" or "center". The default is "left".
Displays the plot generated by Plot.create(), Plot.add(), etc. in a window. This function is automatically called when a macro exits.
Draws the plot generated by Plot.create(), Plot.add(), etc. in an existing plot window. Equivalent to Plot.show() if no plot window is open.
Returns the values displayed by clicking on "List" in a plot or histogram window (example). Requires 1.41k.
Returns the value of base raised to the power of exponent.
Outputs a string to the "Log" window. Numeric arguments are automatically converted to strings. Starting with ImageJ v1.34b, print() accepts multiple arguments. For example, you can use print(x,y,width, height) instead of print(x+" "+y+" "+width+" "+height). If the first argument is a file handle returned by File.open(path), then the second is saved in the refered file (see SaveTextFileDemo).
Numeric expressions are automatically converted to strings using four decimal places, or use the d2s function to specify the decimal places. For example, print(2/3) outputs "0.6667" but print(d2s(2/3,1)) outputs "0.7".
Starting with ImageJ 1.37j, print() accepts commands such as "\\Clear", "\\Update:<text>" and "\\Update<n>:<text>" (for nprint("\\Clear") erases the Log window, print("\\Update:new text") replaces the last line with "new text" and print("\\Update8:new 8th line") replaces the 8th line with "new 8th line". Refer to the LogWindowTricks macro for an example.
Starting with ImageJ 1.38m, the second argument to print(arg1, arg2) is appended to a text window or table if the first argument is a window title in brackets, for example print("[My Window]", "Hello, world"). With text windows, newline characters ("\n") are not automatically appended and text that starts with "\\Update:" replaces the entire contents of the window. Refer to the PrintToTextWindow, Clock and ProgressBar macros for examples.
The second argument to print(arg1, arg2) is appended to a table (e.g., ResultsTable) if the first argument is the title of the table in brackets. Use the Plugins>New command to open a blank table. Any command that can be sent to the "Log" window ("\\Clear", "\\Update:<text>" , etc.) can also be sent to a table. Refer to the SineCosineTable and TableTricks macros for examples.
R [ Top ]
Returns a random number between 0 and 1.
Changes the title of the active image to the string name.
replace(string, old, new)
Returns the new string that results from replacing all occurrences of old in string with new, where old and new are single character strings. If old or new are longer than one character, each substring of string that matches the regular expression old is replaced with new. See also: matches.
Display a message and aborts the macro if the ImageJ version is less than the one specified. See also: getVersion.
Restores the backup image created by the snapshot function. Note that reset() and run("Undo") are basically the same, so only one run() call can be reset.
With 16-bit and 32-bit images, resets the minimum and maximum displayed pixel values (display range) to be the same as the current image's minimum and maximum pixel values. With 8-bit images, sets the display range to 0-255. With RGB images, does nothing. See the DisplayRangeMacros for examples.
Disables thresholding. See also: setThreshold, setAutoThreshold, getThreshold.
Switches back to the previously selected tool. Useful for creating a tool macro that performs an action, such as opening a file, when the user clicks on the tool icon.
Restores Edit/Options submenu settings saved by the saveSettings() function.
Runs an ROI Manager command, where cmd must be "Add", "Add & Draw", "Update", "Delete", "Deselect", "Measure", "Draw", "Fill", "Label", "Combine", "Split", "Sort", "Reset" or "Multi Measure". The ROI Manager is opened if it is not already open. Use roiManager("reset") to delete all items on the list. Use setOption("Show All", boolean) to enable/disable "Show All" mode. For examples, refer to the RoiManagerMacros, RoiManagerAddParticles and ROI Manager Stack Demo macros.
Runs an ROI Manager I/O command, where cmd is "Open", "Save or "Rename", and name is a file path or name. The "Save" option ignores selections and saves all the ROIs as a ZIP archive. With ImageJ 1.38o and later, it displays a file save dialog if name is "". The "Rename" option requires v1.37h or later. With v1.37i or later, you can get the selection name using call("ij.plugin.frame.RoiManager.getName", index). The ROI Manager is opened if it is not already open.
Returns the number of items in the ROI Manager list.
Returns the index of the currently selected item on the ROI Manager list, or -1 if the list is empty, no items are selected, or more than one item is selected.
Selects an item in the ROI Manager list, where index must be greater than or equal zero and less than the value returned by roiManager("count"). Use roiManager("deselect") to deselect all items on the list. For an example, refer to the ROI Manager Stack Demo macro.
Returns the closest integer to n. See also: floor.
Executes an ImageJ menu command. The optional second argument contains values that are automatically entered into dialog boxes (must be GenericDialog or OpenDialog). Use the Command Recorder (Plugins>Macros>Record) to generate run() function calls. Use string concatentation to pass a variable as an argument. For examples, see the ArgumentPassingDemo macro.
Runs the specified macro file, which is assumed to be in the Image macros folder. A full file path may also be used. The ".txt" extension is optional. Returns any string argument returned by the macro. May have an optional second string argument that is passed to macro. For an example, see the CalculateMean macro. See also: eval and getArgument.
S [ Top ]
Saves an image, lookup table, selection or text window to the specified file path. The path must end in ".tif", ".jpg", ".gif", ".zip", ".raw", ".avi", ".bmp", ".fits", ".png", ".pgm", ".lut", ".roi" or ".txt".
Saves the active image, lookup table, selection, measurement results, selection XY coordinates or text window to the specified file path. The format argument must be "tiff", "jpeg", "gif", "zip", "raw", "avi", "bmp", "fits", "png", "pgm", "text image", "lut", "selection", "measurements", "xy Coordinates" or "text". Use saveAs(format) to have a "Save As" dialog displayed.
Saves most Edit/Options submenu settings so they can be restored later by calling restoreSettings().
Returns the screen height in pixels. See also: getLocationAndSize, setLocation.
Returns the screen width in pixels.
Returns the name of the current selection, or an empty string if the selection does not have a name. Aborts the macro if there is no selection. See also: setSelectionName and selectionType.
Returns the selection type, where 0=rectangle, 1=oval, 2=polygon, 3=freehand, 4=traced, 5=straight line, 6=segmented line, 7=freehand line, 8=angle, 9=composite and 10=point. Returns -1 if there is no selection. For an example, see the ShowImageInfo macro.
Activates the image with the specified ID (a negative number). If id is greater than zero, activates the idth image listed in the Window menu. With ImageJ 1.33n and later, id can be an image title (a string).
Activates the image window with the title "name". Also activates non-image windows in v1.30n or later.
Sets the threshold levels based on an analysis of the histogram of the current image or selection. Equivalent to clicking on "Auto" in the Image>Adjust>Threshold window. See also: setThreshold, getThreshold, resetThreshold.
setBackgroundColor(r, g, b)
Sets the background color, where r, g, and b are >= 0 and <= 255.
If arg is true, the interpreter enters batch mode and images are not displayed, allowing the macro to run up to 20 times faster. If arg is false, exits batch mode and displays the active image in a window. ImageJ exits batch mode when the macro terminates if there is no setBatchMode(false) call. Note that a macro should not call setBatchMode(true) more than once.
With ImageJ 1.37j or later, set arg to "exit and display" to exit batch mode and display all open batch mode images. Here are five example batch mode macros: BatchModeTest, BatchMeasure, BatchSetScale, ReplaceRedWithMagenta.
setColor(r, g, b)
Sets the drawing color, where r, g, and b are >= 0 and <= 255. With 16 and 32 bit images, sets the color to 0 if r=g=b=0. With 16 and 32 bit images, use setColor(1,0,0) to make the drawing color the same is the minimum displayed pixel value. SetColor() is faster than setForegroundColor(), and it does not change the system wide foreground color or repaint the color picker tool icon, but it cannot be used to specify the color used by commands called from macros, for example run("Fill").
Sets the drawing color. For 8 bit images, 0<=value<=255. For 16 bit images, 0<=value<=65535. For RGB images, use hex constants (e.g., 0xff0000 for red). This function does not change the foreground color used by run("Draw") and run("Fill").
setFont(name, size[, style])
The first argument is the font name. It should be "SansSerif", "Serif" or "Monospaced". The second argument is the point size of the font. The optional third argument is a string containing "bold" or "italic", or both. With ImageJ 1.37e or later, the third argument can also contain the keyword "antialiased". For examples, run the TextDemo macro.
setForegroundColor(r, g, b)
Sets the foreground color, where r, g, and b are >= 0 and <= 255. See also: setColor.
Specifies the justification used by drawString() and Plot.addText(). The argument can be "left", "right" or "center". The default is "left".
Simulates pressing the shift, alt or space keys, where keys is a string containing some combination of "shift", "alt" or "space". Any key not specified is set "up". Use setKeyDown("none") to set all keys in the "up" position. With ImageJ 1.38e or later, call setKeyDown("esc") to abort the currently running macro or plugin. For examples, see the CompositeSelections, DoWandDemo and AbortMacroActionTool macros. See also: isKeyDown.
Specifies the line width (in pixels) used by drawLine(), lineTo(), drawRect() and drawOval().
Moves the active image window to a new location. With v1.39e or later, moves the active window. See also: getLocationAndSize, screenWidth, screenHeight.
setLocation(x, y, width, height)
Moves and resizes the active image window. The new location of the top-left corner is specified by x and y, and the new size by width and height. Requires v1.39e.
setLut(reds, greens, blues)
Creates a new lookup table and assigns it to the current image. Three input arrays are required, each containing 256 intensity values. See the LookupTables macros for examples.
Assigns the metadata in string to the "Info" image property of the current image. This metadata is displayed by Image>Show Info and saved as part of the TIFF header. See also: getMetadata. Requires v1.40b.
Sets string as the label of the current image or stack slice. The first 60 characters, or up to the first newline, of the label are displayed as part of the image subtitle. The labels are saved as part of the TIFF header. See also: getMetadata. Requires v1.40b.
Sets the minimum and maximum displayed pixel values (display range). See the DisplayRangeMacros for examples.
setMinAndMax(min, max, channels)
Sets the display range of specified channels in an RGB image, where 4=red, 2=green, 1=blue, 6=red+green, etc. Note that the pixel data is altered since RGB images, unlike composite color images, do not have a LUT for each channel. Requires v1.42d.
Enables or disables an ImageJ option, where option is one of the following options and boolean is either true or false.
"DisablePopupMenu" enables/disables the the menu displayed when you right click on an image. "Show All" enables/disables the ROI Manager's "Show All" mode. "Changes" sets/resets the 'changes' flag of the current image. Set "DebugMode" true to put ImageJ in debug mode.
"OpenUsingPlugins", added in v1.38f, controls whether standard file types (TIFF, JPEG, GIF, etc.) are opened by external plugins or by ImageJ (example).
"QueueMacros", added in v1.38g, controls whether macros invoked using keyboard shortcuts run sequentially on the event dispatch thread (EDT) or in separate, possibly concurrent, threads (example). In "QueueMacros" mode, screen updates, which also run on the EDT, are delayed until the macro finishes. Note that "QueueMacros" does not work with macros using function key shortcuts in ImageJ 1.41g and earlier.
"DisableUndo", added in v1.38h, enables/disables the Edit>Undo command. Note that a setOption("DisableUndo",true) call without a corresponding setOption("DisableUndo",false) will cause Edit>Undo to not work as expected until ImageJ is restarted.
"Display Label", "Limit to Threshold", "Area", "Mean" and "Std", added in v1.41, enable/disable the corresponding Analyze>Set Measurements options.
Sets the transfer mode used by the Edit>Paste command, where 'mode' is "Copy", "Blend", "Average", "Difference", "Transparent", "AND", "OR", "XOR", "Add", "Subtract", "Multiply", or "Divide". In v1.37a or later, 'mode' can also be "Min" or "Max".
setPixel(x, y, value)
Stores value at location (x,y) of the current image. The screen is updated when the macro exits or call updateDisplay() to have it updated immediately.
setResult("Column", row, value)
Adds an entry to the ImageJ results table or modifies an existing entry. The first argument specifies a column in the table. If the specified column does not exist, it is added. The second argument specifies the row, where 0<=row<=nResults. (nResults is a predefined variable.) A row is added to the table if row=nResults. The third argument is the value to be added or modified. Call setResult("Label", row, string) to set the row label. Call updateResults() to display the updated table in the "Results" window. For examples, see the SineCosineTable and ConvexitySolidarity macros.
setRGBWeights(redWeight, greenWeight, blueWeight)
Sets the weighting factors used by the Analyze>Measure, Image>Type>8-bit and Analyze>Histogram commands when they convert RGB pixels values to grayscale. The sum of the weights must be 1.0. Use (1/3,1/3,1/3) for equal weighting of red, green and blue. The weighting factors in effect when the macro started are restored when it terminates. For examples, see the MeasureRGB, ExtractRGBChannels and RGB_Histogram macros.
Moves the current selection to (x,y), where x and y are the pixel coordinates of the upper left corner of the selection's bounding rectangle. The RoiManagerMoveSelections macro uses this function to move all the ROI Manager selections a specified distance. See also: getSelectionBounds.
Sets the name of the current selection to the specified name. Aborts the macro if there is no selection. See also: selectionName and selectionType.
Displays the nth slice of the active stack. Does nothing if the active image is not a stack. For an example, see the MeasureStack macros. See also: getSliceNumber, nSlices.
Sets the lower and upper threshold levels. The values are uncalibrated except for 16-bit images (e.g., unsigned 16-bit images). Starting with v1.34g, there is an optional third argument that can be "red", "black & white", "over/under" or "no color". See also: setAutoThreshold, getThreshold, resetThreshold.
Switches to the specified tool, where name is "rectangle", "elliptical", "brush", "polygon", "freehand", "line", "polyline", "freeline", "angle", "point", "wand", "text", "zoom", "hand" or "dropper". Refer to the SetToolDemo macro for an example. Requires 1.39l.
Switches to the specified tool, where 0=rectangle, 1=oval, 2=polygon, 3=freehand, 4=straight line, 5=polyline, 6=freeline, 7=point, 8=wand, 9=text, 10=spare, 11=zoom, 12=hand, 13=dropper, 14=angle, 15...21=spare. See also: toolID.
Call this function before drawing on an image to allow the user the option of later restoring the original image using Edit/Undo. Note that setupUndo() may not work as intended with macros that call the run() function. For an example, see the DrawingTools tool set.
setVoxelSize(width, height, depth, unit)
Defines the voxel dimensions and unit of length ("pixel", "mm", etc.) for the current image or stack. The depth argument is ignored if the current image is not a stack. See also: getVoxelSize.
Sets the Z coordinate used by getPixel(), setPixel() and changeValues(). The argument must be in the range 0 to n-1, where n is the number of images in the stack. For an examples, see the Z Profile Plotter Tool.
Displays "message" in a dialog box.
Displays "message" in a dialog box using "title" as the the dialog box title.
Displays "message" in a dialog box with "OK" and "Cancel" buttons. "Title" (optional) is the dialog box title. The macro exits if the user clicks "Cancel" button.
Updates the ImageJ progress bar, where 0.0progress<=1.0. The progress bar is not displayed if the time between the first and second calls to this function is less than 30 milliseconds. It is erased when the macro terminates or progress is >=1.0.
Displays a message in the ImageJ status bar.
Returns the sine of an angle (in radians).
Creates a backup copy of the current image that can be later restored using the reset function. For examples, see the ImageRotator and BouncingBar macros.
Breaks a string into an array of substrings. Delimiters is a string containing one or more delimiter characters. The default delimiter set " \t\n\r" (space, tab, newline, return) is used if delimiters is an empty string or split is called with only one argument. Returns a one element array if no delimiter is found.
Returns the square root of n. Returns NaN if n is less than zero.
Stack (hyperstack) Functions
These functions allow you to get and set the position (channel, slice and frame) of a hyperstack (a 4D or 5D stack). The HyperStackDemo demonstrates how to create a hyperstack and how to work with it using these functions Requires 1.39l.
Stack.isHyperstack - Returns true if the current image is a hyperstack.startsWith(string, prefix)
Stack.getDimensions(width, height, channels, slices, frames) Returns the dimensions of the current image.
Stack.setDimensions(channels, slices, frames) - Sets the 3rd, 4th and 5th dimensions of the current stack.
Stack.setChannel(n) - Displays channel n .
Stack.setSlice(n) - Displays slice n .
Stack.setFrame(n) - Displays frame n .
Stack.getPosition(channel, slice, frame) - Returns the current position.
Stack.setPosition(channel, slice, frame) - Sets the position.
Stack.getFrameRate() - Returns the frame rate (FPS).
Stack.setFrameRate(fps) - Sets the frame rate.
Stack.setDisplayMode(mode) - Sets the display mode, where mode is "composite", "color" or "grayscale". Requires a multi-channel stack and v1.40a or later.
Stack.getDisplayMode(mode) - Sets the string mode to the current display mode. Requires v1.40a.
Stack.setActiveChannels(string) - Sets the active channels in a composite color image, where string is a list of ones and zeros that specify the channels to activate. For example, "101" activates channels 1 and 3. Requires v1.41b.
Stack.swap(n1, n2) - Swaps the two specified stack images, where n1 and n2 are integers greater than 0 and less than or equal to nSlices. Requires v1.40c.
Returns true (1) if string starts with prefix. See also: endsWith, indexOf, substring, toLowerCase, matches.
These functions do string buffering and copy strings to and from the system clipboard. The CopyResultsToClipboard macro demonstrates their use. Requires 1.38r.String.resetBuffer - Resets (clears) the buffer.substring(string, index1, index2)
String.append(str) - Appends str to the buffer.
String.buffer - Returns the contents of the buffer.
String.copy(str) - Copies str to the clipboard.
String.copyResults - Copies the Results table to the clipboard.
String.paste - Returns the contents of the clipboard.
Returns a new string that is a substring of string. The substring begins at index1 and extends to the character at index2 - 1. See also: indexOf, startsWith, endsWith, replace.
Returns a substring of string that begins at index and extends to the end of string. Requires v1.41i.
T [ Top ]
Returns the tangent of an angle (in radians).
Returns a binary string representation of number.
Returns a hexadecimal string representation of number.
Returns a new string that is a copy of string with all the characters converted to lower case.
Returns the ID of the currently selected tool. See also: setTool.
Returns a decimal string representation of number. See also: toBinary, toHex, parseFloat and parseInt.
Converts number into a string, using the specified number of decimal places. Requires v1.39r.
Returns a new string that is a copy of string with all the characters converted to upper case.
U [ Top ]
Redraws the active image.
Call this function to update the "Results" window after the results table has been modified by calls to the setResult() function.
W [ Top ]
Delays (sleeps) for n milliseconds.
Halts the macro and displays string in a dialog box. The macro proceeds when the user clicks "OK". Unlike showMessage, the dialog box is not modal, so the user can, for example, create a selection or adjust the threshold while the dialog is open. To display a multi-line message, add newline characters ("\n") to string. This function is based on Michael Schmid's Wait_For_User plugin. Example: WaitForUserDemo. Requires v1.39r.
This is a two argument version of waitForUser, where title is the dialog box title and message is the text dispayed in the dialog.
Outputs a string to the "Results" window. Numeric arguments are automatically converted to strings.