java.lang.Object
ij.IJ
This class consists of static utility methods.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final charstatic final intstatic final intImage display modesstatic final intImage display modesstatic booleanUse setDebugMode(boolean) to enable/disable debug mode.static final charstatic FontSansSerif, plain, 10-point fontstatic FontSansSerif, plain, 12-point fontstatic FontSansSerif, plain, 14-point fontstatic final intImage display modesstatic booleanstatic final charstatic final StringDeprecated.static final StringImageJ website -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidaddEventListener(IJEventListener listener) static StringaddSeparator(String path) static booleanReturns true if the alt key is down.static StringAppends a string to the end of a file.static voidbeep()Emits an audio beep.static booleanReturns true if the control key is down.static ImagePluscreateHyperStack(String title, int width, int height, int channels, int slices, int frames, int bitdepth) Creates a new hyperstack.static ImagePluscreateImage(String title, int width, int height, int depth, int bitdepth) Creates a new image.static ImagePluscreateImage(String title, String type, int width, int height, int depth) Creates a new imagePlus.static ImagePluscreateImage(String title, String type, int width, int height, int channels, int slices, int frames) Creates a new hyperstack.static longReturns the amount of memory currently being used by ImageJ.static Stringd2s(double n) Converts a number to a formatted string using 2 digits to the right of the decimal point.static Stringd2s(double n, int decimalPlaces) Converts a number to a rounded formatted string.static Stringd2s(double x, int significantDigits, int maxDigits) Converts a number to a rounded formatted string.static voiddeleteRows(int row1, int row2) Deletes 'row1' through 'row2' of the "Results" window, where 'row1' and 'row2' must be in the range 0-Analyzer.getCounter()-1.static voidRuns a menu command on a separete thread, using the specified image.static voidRuns a menu command on a separete thread and returns immediately.static intdoWand(int x, int y) Equivalent to clicking on the current image at (x,y) with the wand tool.static intTraces the boundary of the area with pixel values within 'tolerance' of the value of the pixel at the starting location.static intThis version of doWand adds an ImagePlus argument.static voidDisplays a message in a dialog box titled "ImageJ".static voidDisplays a message in a dialog box with the specified title.static booleanReturns true if theEsckey was pressed since the last ImageJ command started to execute or since resetEscape() was called.static voidexit()Aborts any currently running JavaScript, or use IJ.error(string) to abort a JavaScript with a message.static StringReturns a string something like "64K of 256MB (25%)" that shows how much of the available memory is in use.static AppletReturns the Applet that created this ImageJ or null if running as an application.static ClassLoaderReturns the class loader ImageJ uses to run plugins or the system class loader if Menus.getPlugInsPath() returns null.static StringAlias for getDirectory().static StringgetDirectory(String title) Returns the path to the specified directory iftitleis "home" ("user.home"), "downloads", "startup", "imagej" (ImageJ directory), "plugins", "macros", "luts", "temp", "current", "default", "image" (directory active image was loaded from), "file" (directory most recently used to open or save a file), "cwd" (current working directory) or "preferences" (location of "IJ_Prefs.txt" file), otherwise displays a dialog and returns the path to the directory selected by the user.static StringReturns the last error message written by IJ.error() or null if there was no error since the last time this method was called.static StringgetFilePath(String dialogTitle) Displays an open file dialog and returns the path to the choosen file, or returns null if the dialog is canceled.static StringReturns the ImageJ version and build number as a String, for example "1.46n05", or 1.46n99 if there is no build number.static ImagePlusgetImage()Returns a reference to the active image, or displays an error message and aborts the plugin or macro if no images are open.static ImagePlusgetImage(Interpreter interpreter) The macro interpreter uses this method to call getImage().static ImageJReturns a reference to the "ImageJ" frame.static StringgetLog()Returns the contents of the Log window or null if the Log window is not open.static String[]getLuts()Returns, as an array of strings, a list of the LUTs in the Image/Lookup Tables menu.static doubleAllows the user to enter a number in a dialog box.static ImageProcessorReturns the active image or stack slice as an ImageProcessor, or displays an error message and aborts the plugin or macro if no images are open.static ObjectgetProperty(String key) Returns the object in IJ.properties associated with 'key', or null if 'key' is not found.static DimensionReturns the size, in pixels, of the primary display.static StringAllows the user to enter a string in a dialog box.static TextPanelReturns a reference to the "Results" window TextPanel.static StringReturns the name of the current tool.static doubleReturns a measurement result, where 'measurement' is "Area", "Mean", "StdDev", "Mode", "Min", "Max", "X", "Y", "XM", "YM", "Perim.", "BX", "BY", "Width", "Height", "Major", "Minor", "Angle", "Circ.", "Feret", "IntDen", "Median", "Skew", "Kurt", "%Area", "RawIntDen", "Ch", "Slice", "Frame", "FeretX", "FeretY", "FeretAngle", "MinFeret", "AR", "Round", "Solidity", "MinThr" or "MaxThr".static StringReturns the ImageJ version number as a string.static voidDisplays a stack trace.static booleanis64Bit()Returns true if ImageJ is running a 64-bit version of Java.static booleanisJava14()Always returns true.static booleanisJava15()Always returns true.static booleanisJava16()Returns true if ImageJ is running on a Java 1.6 or greater JVM.static booleanisJava17()Returns true if ImageJ is running on a Java 1.7 or greater JVM.static booleanisJava18()Returns true if ImageJ is running on a Java 1.8 or greater JVM.static booleanisJava19()Returns true if ImageJ is running on a Java 1.9 or greater JVM.static booleanisJava2()Always returns true.static booleanisLinux()Returns true if ImageJ is running on Linux.static booleanReturns true if this machine is a Macintosh.static booleanisMacOSX()Returns true if this machine is a Macintosh running OS X.static booleanisMacro()Returns true if a macro is running, or if the run(), open() or newImage() method is executing.static booleanReturns true if the "Results" window is open.static booleanisVista()Obsolete; always returns false.static booleanReturns true if this machine is running Windows.static intReturns the Java version (6, 7, 8, 9, 10, etc.).static voidstatic booleanReturns true if the run(), open() or newImage() method is executing.static voidmakeLine(double x1, double y1, double x2, double y2) Creates a straight line selection using floating point coordinates.static voidmakeLine(int x1, int y1, int x2, int y2) Creates a straight line selection.static voidmakeOval(double x, double y, double width, double height) Creates an subpixel resolution oval selection.static voidmakeOval(int x, int y, int width, int height) Creates an oval selection.static voidmakePoint(double x, double y) Creates a point selection using floating point coordinates.static voidmakePoint(int x, int y) Creates a point selection using integer coordinates..static voidmakeRectangle(double x, double y, double width, double height) Creates a subpixel resolution rectangular selection.static voidmakeRectangle(int x, int y, int width, int height) Creates a rectangular selection.static longReturns the maximum amount of memory available to ImageJ or zero if ImageJ is unable to determine this limit.static voidOpens a new image.static voidnoImage()Displays a "no images are open" dialog box.static voidnotifyEventListeners(int eventID) static voidopen()Displays a file open dialog box and then opens the tiff, dicom, fits, pgm, jpeg, bmp, gif, lut, roi, or text file selected by the user.static voidOpens and displays a tiff, dicom, fits, pgm, jpeg, bmp, gif, lut, roi, or text file.static voidOpens and displays the nth image in the specified tiff stack.static ByteBufferopenAsByteBuffer(String path) static StringopenAsString(String path) Opens a text file as a string.static ImagePlusOpens an image using a file open dialog and returns it as an ImagePlus object.static ImagePlusOpens the specified file as a tiff, bmp, dicom, fits, pgm, gif, jpeg or text image and returns an ImagePlus object if successful.static ImagePlusOpens the nth image of the specified tiff stack.static StringopenUrlAsString(String url) Opens a URL and returns the contents as a string.static ImagePlusopenVirtual(String path) Opens the specified tiff file as a virtual stack.static voidoutOfMemory(String name) Displays an "out of memory" message to the "Log" window.static OvalRoiOvalRoi(double x, double y, double width, double height) Creates an OvalRoi.static Stringpad(int n, int digits) Pad 'n' with leading zeros to the specified number of digits.static StringPad 's' with leading zeros to the specified number of digits.static voidprotectStatusBar(boolean protect) static voidCauses IJ.error() output to be temporarily redirected to the "Log" window.static voidredirectErrorMessages(boolean redirect) Set 'true' and IJ.error() output will be temporarily redirected to the "Log" window.static booleanReturns the state of the 'redirectErrorMessages' flag, which is set by File/Import/Image Sequence.static voidObsoletestatic voidremoveEventListener(IJEventListener listener) static voidrenameResults(String title) Renames a results window.static voidrenameResults(String oldTitle, String newTitle) Changes the name of a table window from 'oldTitle' to 'newTitle'.static voidstatic voidThis method sets theEsckey to the "up" position.static voidResets the minimum and maximum displayed pixel values of the current image to be the same as the min and max pixel values.static voidresetMinAndMax(ImagePlus img) Resets the minimum and maximum displayed pixel values of the specified image to be the same as the min and max pixel values.static voidDisables thresholding on the current image.static voidresetThreshold(ImagePlus img) Disables thresholding on the specified image.static RoiRoi(double x, double y, double width, double height) Creates an Roi.static voidRuns an ImageJ command using the specified image and options.static voidrun(Interpreter interpreter, String command, String options) The macro interpreter uses this method to run commands.static voidRuns an ImageJ command.static voidRuns an ImageJ command, with options that are passed to the GenericDialog and OpenDialog classes.static StringRuns the macro contained in the stringmacroon the current thread.static StringRuns the macro contained in the stringmacroon the current thread.static StringrunMacroFile(String name) Runs the specified macro file.static StringrunMacroFile(String name, String arg) Runs the specified macro or script file in the current thread.static ObjectRuns the specified plugin using the specified image.static ObjectRuns the specified plugin and returns a reference to it.static ObjectRuns the specified plugin and returns a reference to it.static voidSaves the specified image, lookup table or selection to the specified file path.static voidSaves the current image, lookup table, selection or text window to the specified file path.static voidstatic voidstatic booleansaveAsTiff(ImagePlus imp, String path) Saves the specified image in TIFF format.static StringsaveString(String string, String path) Saves a string as a file.static voidselectWindow(int id) For IDs less than zero, activates the image with the specified ID.static voidselectWindow(String title) Activates the window with the specified title.static voidsetAutoThreshold(ImagePlus imp, String method) Replaced by ImagePlus.setAutoThreshold().static voidsetBackgroundColor(int red, int green, int blue) Sets the background color.static voidsetColumnHeadings(String headings) Clears the "Results" window and sets the column headings to those in the tab-delimited 'headings' String.static voidsetDebugMode(boolean b) Enable/disable debug mode.static voidsetExceptionHandler(IJ.ExceptionHandler handler) Installs a custom exception handler that overrides the handleException() method.static voidsetForegroundColor(int red, int green, int blue) Sets the foreground color.static voidstatic voidsetKeyDown(int key) static voidsetKeyUp(int key) static voidsetMinAndMax(double min, double max) Sets the display range (minimum and maximum displayed pixel values) of the current image.static voidsetMinAndMax(double min, double max, int channels) Sets the minimum and maximum displayed pixel values on the specified RGB channels, where 4=red, 2=green and 1=blue.static voidsetMinAndMax(ImagePlus img, double min, double max) Sets the display range (minimum and maximum displayed pixel values) of the specified image.static voidsetPasteMode(String mode) Sets the transfer mode used by the Edit/Paste command, where mode is "Copy", "Blend", "Average", "Difference", "Transparent", "Transparent2", "AND", "OR", "XOR", "Add", "Subtract", "Multiply", or "Divide".static voidsetProperty(String key, Object value) Adds a key-value pair to IJ.properties.static voidsetRawThreshold(ImagePlus img, double lowerThreshold, double upperThreshold) This is a version of setThreshold() that uses raw (uncalibrated) values in the range 0-255 for 8-bit images and 0-65535 for 16-bit images and the "Red" LUT display mode.static voidsetRawThreshold(ImagePlus img, double lowerThreshold, double upperThreshold, String displayMode) This is a version of setThreshold() that always uses raw (uncalibrated) values in the range 0-255 for 8-bit images and 0-65535 for 16-bit images.static voidsetSlice(int slice) Switches to the specified stack slice, where 1invalid input: '<'='slice'invalid input: '<'=stack-size.static voidTextWindow calls this method with a null argument when the "Results" window is closed.static voidsetThreshold(double lowerThreshold, double upperThresold) Sets the lower and upper threshold levels and displays the image using red to highlight thresholded pixels.static voidsetThreshold(double lowerThreshold, double upperThreshold, String displayMode) Sets the lower and upper threshold levels and displays the image using the specifieddisplayMode("Red", "Black invalid input: '&' White", "Over/Under" or "No Update").static voidsetThreshold(ImagePlus img, double lowerThreshold, double upperThreshold) Sets the lower and upper threshold levels of the specified image.static voidsetThreshold(ImagePlus img, double lowerThreshold, double upperThreshold, String displayMode) Sets the lower and upper threshold levels of the specified image and updates the display using the specifieddisplayMode("Red", "Black invalid input: '&' White", "Over/Under" or "No Update").static voidsetTool(int id) Switches to the specified tool, where id = Toolbar.RECTANGLE (0), Toolbar.OVAL (1), etc.static booleanSwitches to the specified tool, where 'name' is "rect", "elliptical", "brush", etc.static intsetupDialog(ImagePlus imp, int flags) Displays a "Process all images?" dialog.static booleanReturns true if the shift key is down.static voidshowMessage(String msg) Displays a message in a dialog box titled "Message".static voidshowMessage(String title, String msg) Displays a message in a dialog box with the specified title.static booleanshowMessageWithCancel(String title, String msg) Displays a message in a dialog box with the specified title.static voidshowProgress(double progress) Updates the progress bar, where 0invalid input: '<'=progressinvalid input: '<'=1.0.static voidshowProgress(int currentIndex, int finalIndex) Updates the progress bar, where the length of the bar is set to (currentValue+1)/finalValueof the maximum bar length.static voidshowStatus(String s) Displays a message in the ImageJ status bar.static voidshowStatus(String message, String options) Displays a message in the status bar and flashes either the status bar or the active image.
See: http://wsr.imagej.net/macros/FlashingStatusMessages.txtstatic voidstatic voidstatic booleanReturns true if the space bar is down.static booleanstatic intstringToPasteMode(String mode) static voidTemporarily suppress "plugin not found" errors.static StringExperimentalstatic booleanversionLessThan(String version) Displays an error message and returns true if the ImageJ version is less than the one specified.static voidwait(int msecs) Delays 'msecs' milliseconds.static voidDeprecated.replaced by IJ.log(), ResultsTable.setResult() and TextWindow.append().
-
Field Details
-
font10
SansSerif, plain, 10-point font -
font12
SansSerif, plain, 12-point font -
font14
SansSerif, plain, 14-point font -
COMPOSITE
public static final int COMPOSITEImage display modes- See Also:
-
COLOR
public static final int COLORImage display modes- See Also:
-
GRAYSCALE
public static final int GRAYSCALEImage display modes- See Also:
-
URL
Deprecated.- See Also:
-
URL2
ImageJ website- See Also:
-
ALL_KEYS
public static final int ALL_KEYS- See Also:
-
debugMode
public static boolean debugModeUse setDebugMode(boolean) to enable/disable debug mode. -
hideProcessStackDialog
public static boolean hideProcessStackDialog -
micronSymbol
public static final char micronSymbol- See Also:
-
angstromSymbol
public static final char angstromSymbol- See Also:
-
degreeSymbol
public static final char degreeSymbol- See Also:
-
CANCELED
public static final int CANCELED- See Also:
-
-
Constructor Details
-
IJ
public IJ()
-
-
Method Details
-
getInstance
Returns a reference to the "ImageJ" frame. -
setDebugMode
public static void setDebugMode(boolean b) Enable/disable debug mode. -
runMacro
Runs the macro contained in the stringmacroon the current thread. Returns any string value returned by the macro, null if the macro does not return a value, or "[aborted]" if the macro was aborted due to an error. The equivalent macro function is eval(). -
runMacro
Runs the macro contained in the stringmacroon the current thread. The optional string argument can be retrieved in the called macro using the getArgument() macro function. Returns any string value returned by the macro, null if the macro does not return a value, or "[aborted]" if the macro was aborted due to an error. -
runMacroFile
Runs the specified macro or script file in the current thread. The file is assumed to be in the macros folder unlessnameis a full path. The optional string argument (arg) can be retrieved in the called macro or script using the getArgument() function. Returns any string value returned by the macro, or null. Scripts always return null. The equivalent macro function is runMacro(). -
runMacroFile
Runs the specified macro file. -
runPlugIn
Runs the specified plugin using the specified image. -
runPlugIn
Runs the specified plugin and returns a reference to it. -
runPlugIn
Runs the specified plugin and returns a reference to it. -
doCommand
Runs a menu command on a separete thread and returns immediately. -
doCommand
Runs a menu command on a separete thread, using the specified image. -
run
Runs an ImageJ command. Does not return until the command has finished executing. To avoid "image locked", errors, plugins that call this method should implement the PlugIn interface instead of PlugInFilter. -
run
Runs an ImageJ command, with options that are passed to the GenericDialog and OpenDialog classes. Does not return until the command has finished executing. To generate run() calls, start the recorder (Plugins/Macro/Record) and run commands from the ImageJ menu bar. -
run
The macro interpreter uses this method to run commands. -
run
Runs an ImageJ command using the specified image and options. To generate run() calls, start the recorder (Plugins/Macro/Record) and run commands from the ImageJ menu bar. -
macroRunning
public static boolean macroRunning()Returns true if the run(), open() or newImage() method is executing. -
isMacro
public static boolean isMacro()Returns true if a macro is running, or if the run(), open() or newImage() method is executing. -
getApplet
Returns the Applet that created this ImageJ or null if running as an application. -
showStatus
Displays a message in the ImageJ status bar. If 's' starts with '!', subsequent showStatus() calls in the current thread (without "!" in the message) are suppressed. -
showStatus
Displays a message in the status bar and flashes either the status bar or the active image.
See: http://wsr.imagej.net/macros/FlashingStatusMessages.txt -
write
Deprecated.replaced by IJ.log(), ResultsTable.setResult() and TextWindow.append(). There are examples at http://imagej.nih.gov/ij/plugins/sine-cosine.html -
log
-
getLog
Returns the contents of the Log window or null if the Log window is not open. -
setColumnHeadings
Clears the "Results" window and sets the column headings to those in the tab-delimited 'headings' String. Writes to System.out.println if the "ImageJ" frame is not present. -
isResultsWindow
public static boolean isResultsWindow()Returns true if the "Results" window is open. -
renameResults
Renames a results window. -
renameResults
Changes the name of a table window from 'oldTitle' to 'newTitle'. -
deleteRows
public static void deleteRows(int row1, int row2) Deletes 'row1' through 'row2' of the "Results" window, where 'row1' and 'row2' must be in the range 0-Analyzer.getCounter()-1. -
getValue
Returns a measurement result, where 'measurement' is "Area", "Mean", "StdDev", "Mode", "Min", "Max", "X", "Y", "XM", "YM", "Perim.", "BX", "BY", "Width", "Height", "Major", "Minor", "Angle", "Circ.", "Feret", "IntDen", "Median", "Skew", "Kurt", "%Area", "RawIntDen", "Ch", "Slice", "Frame", "FeretX", "FeretY", "FeretAngle", "MinFeret", "AR", "Round", "Solidity", "MinThr" or "MaxThr". Add " raw" to the argument to disable calibration, for example IJ.getValue("Mean raw"). Add " limit" to enable the "limit to threshold" option. -
getTextPanel
Returns a reference to the "Results" window TextPanel. Opens the "Results" window if it is currently not open. Returns null if the "ImageJ" window is not open. -
setTextPanel
TextWindow calls this method with a null argument when the "Results" window is closed. -
noImage
public static void noImage()Displays a "no images are open" dialog box. -
outOfMemory
Displays an "out of memory" message to the "Log" window. -
showProgress
public static void showProgress(double progress) Updates the progress bar, where 0invalid input: '<'=progressinvalid input: '<'=1.0. The progress bar is not shown in BatchMode and erased if progress>=1.0. The progress bar is updated only if more than 90 ms have passes since the last call. Does nothing if the ImageJ window is not present. -
showProgress
public static void showProgress(int currentIndex, int finalIndex) Updates the progress bar, where the length of the bar is set to (currentValue+1)/finalValueof the maximum bar length. The bar is erased ifcurrentValue>=finalValue. The bar is updated only if more than 90 ms have passed since the last call. Displays subordinate progress bars as dots if 'currentIndex' is negative (example: Plugins/Utilities/Benchmark). -
showMessage
Displays a message in a dialog box titled "Message". Writes the Java console if ImageJ is not present. -
showMessage
Displays a message in a dialog box with the specified title. Displays HTML formatted text if 'msg' starts with "". There are examples at "http://imagej.nih.gov/ij/macros/HtmlDialogDemo.txt". Writes to the Java console if ImageJ is not present. -
error
Displays a message in a dialog box titled "ImageJ". If a macro or JavaScript is running, it is aborted. Writes to the Java console if the ImageJ window is not present. -
error
Displays a message in a dialog box with the specified title. If a macro or JavaScript is running, it is aborted. Writes to the Java console if the ImageJ window is not present. -
exit
public static void exit()Aborts any currently running JavaScript, or use IJ.error(string) to abort a JavaScript with a message. -
getErrorMessage
Returns the last error message written by IJ.error() or null if there was no error since the last time this method was called.- See Also:
-
showMessageWithCancel
Displays a message in a dialog box with the specified title. Returns false if the user pressed "Cancel". -
getNumber
Allows the user to enter a number in a dialog box. Returns the value IJ.CANCELED (-2,147,483,648) if the user cancels the dialog box. Returns 'defaultValue' if the user enters an invalid number. -
getString
Allows the user to enter a string in a dialog box. Returns "" if the user cancels the dialog box. -
wait
public static void wait(int msecs) Delays 'msecs' milliseconds. -
beep
public static void beep()Emits an audio beep. -
freeMemory
Returns a string something like "64K of 256MB (25%)" that shows how much of the available memory is in use. This is the string displayed when the user clicks in the status bar. -
currentMemory
public static long currentMemory()Returns the amount of memory currently being used by ImageJ. -
maxMemory
public static long maxMemory()Returns the maximum amount of memory available to ImageJ or zero if ImageJ is unable to determine this limit. -
showTime
-
showTime
-
time
Experimental -
d2s
Converts a number to a formatted string using 2 digits to the right of the decimal point. -
d2s
Converts a number to a rounded formatted string. The 'decimalPlaces' argument specifies the number of digits to the right of the decimal point (0-9). Uses scientific notation if 'decimalPlaces is negative. -
d2s
Converts a number to a rounded formatted string. The 'significantDigits' argument specifies the minimum number of significant digits, which is also the preferred number of digits behind the decimal. Fewer decimals are shown if the number would have more than 'maxDigits'. Exponential notation is used if more than 'maxDigits' would be needed. -
pad
Pad 'n' with leading zeros to the specified number of digits. -
pad
Pad 's' with leading zeros to the specified number of digits. -
register
Obsolete -
spaceBarDown
public static boolean spaceBarDown()Returns true if the space bar is down. -
controlKeyDown
public static boolean controlKeyDown()Returns true if the control key is down. -
altKeyDown
public static boolean altKeyDown()Returns true if the alt key is down. -
shiftKeyDown
public static boolean shiftKeyDown()Returns true if the shift key is down. -
setKeyDown
public static void setKeyDown(int key) -
setKeyUp
public static void setKeyUp(int key) -
setInputEvent
-
isMacintosh
public static boolean isMacintosh()Returns true if this machine is a Macintosh. -
isMacOSX
public static boolean isMacOSX()Returns true if this machine is a Macintosh running OS X. -
isWindows
public static boolean isWindows()Returns true if this machine is running Windows. -
javaVersion
public static int javaVersion()Returns the Java version (6, 7, 8, 9, 10, etc.). -
isJava2
public static boolean isJava2()Always returns true. -
isJava14
public static boolean isJava14()Always returns true. -
isJava15
public static boolean isJava15()Always returns true. -
isJava16
public static boolean isJava16()Returns true if ImageJ is running on a Java 1.6 or greater JVM. -
isJava17
public static boolean isJava17()Returns true if ImageJ is running on a Java 1.7 or greater JVM. -
isJava18
public static boolean isJava18()Returns true if ImageJ is running on a Java 1.8 or greater JVM. -
isJava19
public static boolean isJava19()Returns true if ImageJ is running on a Java 1.9 or greater JVM. -
isLinux
public static boolean isLinux()Returns true if ImageJ is running on Linux. -
isVista
public static boolean isVista()Obsolete; always returns false. -
is64Bit
public static boolean is64Bit()Returns true if ImageJ is running a 64-bit version of Java. -
versionLessThan
Displays an error message and returns true if the ImageJ version is less than the one specified. -
setupDialog
Displays a "Process all images?" dialog. Returns 'flags'+PlugInFilter.DOES_STACKS if the user selects "Yes", 'flags' if the user selects "No" and PlugInFilter.DONE if the user selects "Cancel". -
makeRectangle
public static void makeRectangle(int x, int y, int width, int height) Creates a rectangular selection. Removes any existing selection if width or height are less than 1. -
makeRectangle
public static void makeRectangle(double x, double y, double width, double height) Creates a subpixel resolution rectangular selection. -
makeOval
public static void makeOval(int x, int y, int width, int height) Creates an oval selection. Removes any existing selection if width or height are less than 1. -
makeOval
public static void makeOval(double x, double y, double width, double height) Creates an subpixel resolution oval selection. -
makeLine
public static void makeLine(int x1, int y1, int x2, int y2) Creates a straight line selection. -
makeLine
public static void makeLine(double x1, double y1, double x2, double y2) Creates a straight line selection using floating point coordinates. -
makePoint
public static void makePoint(int x, int y) Creates a point selection using integer coordinates.. -
makePoint
public static void makePoint(double x, double y) Creates a point selection using floating point coordinates. -
Roi
Creates an Roi. -
OvalRoi
Creates an OvalRoi. -
setMinAndMax
public static void setMinAndMax(double min, double max) Sets the display range (minimum and maximum displayed pixel values) of the current image. -
setMinAndMax
Sets the display range (minimum and maximum displayed pixel values) of the specified image. -
setMinAndMax
public static void setMinAndMax(double min, double max, int channels) Sets the minimum and maximum displayed pixel values on the specified RGB channels, where 4=red, 2=green and 1=blue. -
resetMinAndMax
public static void resetMinAndMax()Resets the minimum and maximum displayed pixel values of the current image to be the same as the min and max pixel values. -
resetMinAndMax
Resets the minimum and maximum displayed pixel values of the specified image to be the same as the min and max pixel values. -
setThreshold
public static void setThreshold(double lowerThreshold, double upperThresold) Sets the lower and upper threshold levels and displays the image using red to highlight thresholded pixels. May not work correctly on 16 and 32 bit images unless the display range has been reset using IJ.resetMinAndMax(). -
setThreshold
Sets the lower and upper threshold levels and displays the image using the specifieddisplayMode("Red", "Black invalid input: '&' White", "Over/Under" or "No Update"). -
setThreshold
Sets the lower and upper threshold levels of the specified image. -
setThreshold
public static void setThreshold(ImagePlus img, double lowerThreshold, double upperThreshold, String displayMode) Sets the lower and upper threshold levels of the specified image and updates the display using the specifieddisplayMode("Red", "Black invalid input: '&' White", "Over/Under" or "No Update"). With calibrated images, 'lowerThreshold' and 'upperThreshold' must be density calibrated values. Use setRawThreshold() to set the threshold using raw (uncalibrated) values. -
setRawThreshold
This is a version of setThreshold() that uses raw (uncalibrated) values in the range 0-255 for 8-bit images and 0-65535 for 16-bit images and the "Red" LUT display mode. -
setRawThreshold
public static void setRawThreshold(ImagePlus img, double lowerThreshold, double upperThreshold, String displayMode) This is a version of setThreshold() that always uses raw (uncalibrated) values in the range 0-255 for 8-bit images and 0-65535 for 16-bit images. -
setAutoThreshold
Replaced by ImagePlus.setAutoThreshold(). -
resetThreshold
public static void resetThreshold()Disables thresholding on the current image. -
resetThreshold
Disables thresholding on the specified image. -
selectWindow
public static void selectWindow(int id) For IDs less than zero, activates the image with the specified ID. For IDs greater than zero, activates the Nth image. -
selectWindow
Activates the window with the specified title. -
setForegroundColor
public static void setForegroundColor(int red, int green, int blue) Sets the foreground color. -
setBackgroundColor
public static void setBackgroundColor(int red, int green, int blue) Sets the background color. -
setTool
public static void setTool(int id) Switches to the specified tool, where id = Toolbar.RECTANGLE (0), Toolbar.OVAL (1), etc. -
setTool
Switches to the specified tool, where 'name' is "rect", "elliptical", "brush", etc. Returns 'false' if the name is not recognized. -
getToolName
Returns the name of the current tool. -
doWand
public static int doWand(int x, int y) Equivalent to clicking on the current image at (x,y) with the wand tool. Returns the number of points in the resulting ROI. -
doWand
Traces the boundary of the area with pixel values within 'tolerance' of the value of the pixel at the starting location. 'tolerance' is in uncalibrated units. 'mode' can be "4-connected", "8-connected" or "Legacy". "Legacy" is for compatibility with previous versions of ImageJ; it is ignored if 'tolerance' > 0. -
doWand
This version of doWand adds an ImagePlus argument. -
setPasteMode
Sets the transfer mode used by the Edit/Paste command, where mode is "Copy", "Blend", "Average", "Difference", "Transparent", "Transparent2", "AND", "OR", "XOR", "Add", "Subtract", "Multiply", or "Divide". -
stringToPasteMode
-
getImage
Returns a reference to the active image, or displays an error message and aborts the plugin or macro if no images are open. -
getImage
The macro interpreter uses this method to call getImage(). -
getProcessor
Returns the active image or stack slice as an ImageProcessor, or displays an error message and aborts the plugin or macro if no images are open. -
setSlice
public static void setSlice(int slice) Switches to the specified stack slice, where 1invalid input: '<'='slice'invalid input: '<'=stack-size. -
getVersion
Returns the ImageJ version number as a string. -
getFullVersion
Returns the ImageJ version and build number as a String, for example "1.46n05", or 1.46n99 if there is no build number. -
getDirectory
Returns the path to the specified directory iftitleis "home" ("user.home"), "downloads", "startup", "imagej" (ImageJ directory), "plugins", "macros", "luts", "temp", "current", "default", "image" (directory active image was loaded from), "file" (directory most recently used to open or save a file), "cwd" (current working directory) or "preferences" (location of "IJ_Prefs.txt" file), otherwise displays a dialog and returns the path to the directory selected by the user. Returns null if the specified directory is not found or the user cancels the dialog box. Also aborts the macro if the user cancels the dialog box. -
addSeparator
-
getDir
Alias for getDirectory(). -
getFilePath
Displays an open file dialog and returns the path to the choosen file, or returns null if the dialog is canceled. -
open
public static void open()Displays a file open dialog box and then opens the tiff, dicom, fits, pgm, jpeg, bmp, gif, lut, roi, or text file selected by the user. Displays an error message if the selected file is not in one of the supported formats, or if it is not found. -
open
Opens and displays a tiff, dicom, fits, pgm, jpeg, bmp, gif, lut, roi, or text file. Displays an error message if the specified file is not in one of the supported formats, or if it is not found. With 1.41k or later, opens images specified by a URL. -
open
Opens and displays the nth image in the specified tiff stack. -
openImage
Opens the specified file as a tiff, bmp, dicom, fits, pgm, gif, jpeg or text image and returns an ImagePlus object if successful. Calls HandleExtraFileTypes plugin if the file type is not recognised. Displays a file open dialog if 'path' is null or an empty string. Note that 'path' can also be a URL. Some reader plugins, including the Bio-Formats plugin, display the image and return null. Use IJ.open() to display a file open dialog box.- See Also:
-
openImage
Opens the nth image of the specified tiff stack. -
openVirtual
Opens the specified tiff file as a virtual stack. -
openImage
Opens an image using a file open dialog and returns it as an ImagePlus object. -
openUrlAsString
Opens a URL and returns the contents as a string. Returns "invalid input: '<'Error: message>" if there an error, including host or file not found. -
save
Saves the current 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", ".pgm", ".png", ".lut", ".roi" or ".txt". -
save
Saves the specified image, lookup table or selection to the specified file path. The file path should end with ".tif", ".jpg", ".gif", ".zip", ".raw", ".avi", ".bmp", ".fits", ".pgm", ".png", ".lut", ".roi" or ".txt". The specified image is saved in TIFF format if there is no extension. -
saveAs
-
saveAs
-
saveAsTiff
Saves the specified image in TIFF format. Displays a file save dialog if 'path' is null or an empty string. Returns 'false' if there is an error or if the user selects "Cancel" in the file save dialog. -
saveString
Saves a string as a file. Displays a file save dialog if 'path' is null or blank. Returns an error message if there is an exception, otherwise returns null. -
append
Appends a string to the end of a file. A newline character ("\n") is added to the end of the string before it is written. Returns an error message if there is an exception, otherwise returns null. -
openAsString
Opens a text file as a string. Displays a file open dialog if path is null or blank. Returns null if the user cancels the file open dialog. If there is an error, returns a message in the form "Error: message". -
openAsByteBuffer
-
createImage
Creates a new image.- Parameters:
title- image namewidth- image width in pixelsheight- image height in pixelsdepth- number of stack imagesbitdepth- 8, 16, 32 (float) or 24 (RGB)
-
createImage
Creates a new imagePlus.Typeshould contain "8-bit", "16-bit", "32-bit" or "RGB". In addition, it can contain "white", "black" or "ramp".Widthandheightspecify the width and height of the image in pixels.Depthspecifies the number of stack slices. -
createImage
public static ImagePlus createImage(String title, String type, int width, int height, int channels, int slices, int frames) Creates a new hyperstack.- Parameters:
title- image nametype- "8-bit", "16-bit", "32-bit" or "RGB". May also contain "white" , "black" (the default), "ramp", "composite-mode", "color-mode", "grayscale-mode or "label".width- image width in pixelsheight- image height in pixelschannels- number of channelsslices- number of slicesframes- number of frames
-
createHyperStack
public static ImagePlus createHyperStack(String title, int width, int height, int channels, int slices, int frames, int bitdepth) Creates a new hyperstack.- Parameters:
title- image namewidth- image width in pixelsheight- image height in pixelschannels- number of channelsslices- number of slicesframes- number of framesbitdepth- 8, 16, 32 (float) or 24 (RGB)
-
newImage
Opens a new image.Typeshould contain "8-bit", "16-bit", "32-bit" or "RGB". In addition, it can contain "white", "black" or "ramp".Widthandheightspecify the width and height of the image in pixels.Depthspecifies the number of stack slices. -
escapePressed
public static boolean escapePressed()Returns true if theEsckey was pressed since the last ImageJ command started to execute or since resetEscape() was called. -
resetEscape
public static void resetEscape()This method sets theEsckey to the "up" position. The Executer class calls this method when it runs an ImageJ command in a separate thread. -
redirectErrorMessages
public static void redirectErrorMessages()Causes IJ.error() output to be temporarily redirected to the "Log" window. -
redirectErrorMessages
public static void redirectErrorMessages(boolean redirect) Set 'true' and IJ.error() output will be temporarily redirected to the "Log" window. -
redirectingErrorMessages
public static boolean redirectingErrorMessages()Returns the state of the 'redirectErrorMessages' flag, which is set by File/Import/Image Sequence. -
suppressPluginNotFoundError
public static void suppressPluginNotFoundError()Temporarily suppress "plugin not found" errors. -
getClassLoader
Returns the class loader ImageJ uses to run plugins or the system class loader if Menus.getPlugInsPath() returns null. -
getScreenSize
Returns the size, in pixels, of the primary display. -
getLuts
Returns, as an array of strings, a list of the LUTs in the Image/Lookup Tables menu.- See Also:
-
resetClassLoader
public static void resetClassLoader() -
handleException
Displays a stack trace. Use the setExceptionHandler method() to override with a custom exception handler. -
setExceptionHandler
Installs a custom exception handler that overrides the handleException() method. -
addEventListener
-
removeEventListener
-
notifyEventListeners
public static void notifyEventListeners(int eventID) -
setProperty
Adds a key-value pair to IJ.properties. The key and value are removed if 'value' is null. -
getProperty
Returns the object in IJ.properties associated with 'key', or null if 'key' is not found. -
statusBarProtected
public static boolean statusBarProtected() -
protectStatusBar
public static void protectStatusBar(boolean protect)
-