- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- java.awt.Window
-
- java.awt.Frame
-
- ij.plugin.frame.PlugInFrame
-
- ij.plugin.frame.RoiManager
-
- All Implemented Interfaces:
PlugIn,ActionListener,FocusListener,ItemListener,MouseListener,MouseWheelListener,WindowListener,ImageObserver,MenuContainer,Serializable,Iterable<Roi>,EventListener,Accessible,ListSelectionListener
public class RoiManager extends PlugInFrame implements ActionListener, ItemListener, MouseListener, MouseWheelListener, ListSelectionListener, Iterable<Roi>
This plugin implements the Analyze/Tools/ROI Manager command.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.awt.Frame
Frame.AccessibleAWTFrame
-
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
-
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
-
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
-
Field Summary
Fields Modifier and Type Field Description static StringLOC_KEY-
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
-
Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
-
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
-
Constructor Summary
Constructors Constructor Description RoiManager()Opens the "ROI Manager" window, or activates it if it is already open.RoiManager(boolean b)Constructs an ROI Manager without displaying it.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidactionPerformed(ActionEvent e)voidadd(Roi roi, int n)Adds the specified ROI to the list.voidadd(ImagePlus imp, Roi roi, int n)Adds the specified ROI to the list.voidaddRoi(Roi roi)Adds the specified ROI.voidallowRecording(boolean allow)voidclose()Overrides PlugInFrame.close().voiddelete(int index)Deletes the ROI at 'index' and updates the display.voiddeselect()voiddeselect(Roi roi)Deselect the specified ROI if it is the only one selected.intgetCount()Returns the ROI count.booleangetDrawLabels()static StringgetErrorMessage()Returns the most recent I/O error message, or null if there was no error.intgetIndex(String name)Returns the index of the first ROI with the specified name, or -1 if no ROI has that name.int[]getIndexes()Returns an array of the selected indexes or all indexes if none are selected.static StringgetIndexesAsString()This is a macro-callable version of getSelectedIndexes().static RoiManagergetInstance()Returns a reference to the ROI Manager, or null if it is not open and a batch mode macro is not running.static RoiManagergetInstance2()Returns a reference to the ROI Manager window or to the macro batch mode RoiManager, or null if neither exists.ListgetList()Deprecated.StringgetName(int index)Returns the name of the ROI with the specified index, or null if the index is out of range.static StringgetName(String index)Returns the name of the ROI with the specified index.static RoiManagergetRawInstance()RoigetRoi(int index)Returns a reference to the ROI at the specified index.intgetRoiIndex(Roi roi)Returns the index of the specified Roi, or -1 if it is not found.static RoiManagergetRoiManager()Returns a reference to the ROI Manager if it open or opens it if it is not already open.HashtablegetROIs()Deprecated.Roi[]getRoisAsArray()Returns the ROIs as an array.intgetSelectedIndex()Returns the index of the first selected ROI or -1 if no ROI is selected.int[]getSelectedIndexes()Returns an array of the selected indexes.Roi[]getSelectedRoisAsArray()Returns the selected ROIs as an array, or all the ROIs if none are selected.intgetSliceNumber(String label)Returns the slice number associated with the specified name, or -1 if the name does not include a slice number.booleanisSelected(int index)Returns 'true' if the index is valid and the indexed ROI is selected.voiditemStateChanged(ItemEvent e)Iterator<Roi>iterator()voidmouseClicked(MouseEvent e)voidmouseEntered(MouseEvent e)voidmouseExited(MouseEvent e)voidmousePressed(MouseEvent e)voidmouseReleased(MouseEvent e)voidmouseWheelMoved(MouseWheelEvent event)voidmoveRoisToOverlay(ImagePlus imp)Moves all the ROIs to the specified image's overlay.voidmultiCrop(String directory, String options)ResultsTablemultiMeasure(ImagePlus imp)This method measures the selected ROIs, or all ROIs if none are selected, on all the slices of a stack and returns a ResultsTable arranged with one row per slice.static ResultsTablemultiMeasure(ImagePlus imp, Roi[] rois, boolean appendResults)booleanopen(String path)Opens a single .roi file or a ZIP-compressed set of ROIs.voidprocessWindowEvent(WindowEvent e)voidrename(int index, String newName)voidreset()Clears this RoiManager so that it contains no ROIs.static voidresetMultiMeasureResults()static voidrestoreCentered(boolean b)voidrotate(double angle)voidrotate(double angle, double xcenter, double ycenter)booleanrunCommand(ImagePlus imp, String cmd)Using the specified image, runs the ROI Manager "Add", "Add & Draw", "Update", "Delete", "Measure", "Draw", "Show All", "Show None", "Fill", "Deselect", "Select All", "Combine", "AND", "XOR", "Split", "Sort" or "Multi Measure" command.booleanrunCommand(String cmd)Executes the ROI Manager "Add", "Add & Draw", "Update", "Delete", "Measure", "Draw", "Show All", "Show None", "Fill", "Deselect", "Select All", "Combine", "AND", "XOR", "Split", "Sort" or "Multi Measure" command.booleanrunCommand(String cmd, String name)Executes the ROI Manager "Open", "Save" or "Rename" command.booleanrunCommand(String cmd, String hexColor, double lineWidth)Adds the current selection to the ROI Manager, using the specified color (a 6 digit hex string) and line width.booleansave(String path)If one ROI is selected, it is saved as a .roi file, if multiple (or no) ROIs are selected, they are saved as a .zip ROI set.voidscale(double xscale, double yscale, boolean centered)voidselect(int index)Assigns the ROI at the specified index to the current image.voidselect(int index, boolean shiftKeyDown, boolean altKeyDown)voidselect(ImagePlus imp, int index)Assigns the ROI at the specified index to 'imp'.voidselectAndMakeVisible(ImagePlus imp, int index)intselected()Returns the count of selected ROIs.voidselectGroup(int group)Selects all ROIs of a given group.static voidselectGroup(String group)Obsolete; replaced by RoiManager.selectGroup() macro function.voidselectPosition(int c, int z, int t)Selects all ROIs at the specified position.voidsetEditMode(ImagePlus imp, boolean editMode)voidsetGroup(int group)Sets the group for the selected ROIs.static voidsetGroup(String group)Obsolete; replaced by RoiManager.setGroup() macro function.voidsetOverlay(Overlay overlay)voidsetPosition(int position)Sets the position of the selected ROIs.voidsetPosition(int c, int z, int t)Sets the c,z,t position of the selected ROIs.voidsetRoi(Roi roi, int index)Replaces the ROI at the specified index.voidsetSelectedIndexes(int[] indexes)Selects multiple ROIs, where 'indexes' is an array of integers, each greater than or equal to 0 and less than the value returned by getCount().StringtoString()voidtranslate(double dx, double dy)Moves the selected ROIs or all the ROIs if none are selected.voidvalueChanged(ListSelectionEvent e)voidwindowActivated(WindowEvent e)-
Methods inherited from class ij.plugin.frame.PlugInFrame
focusGained, focusLost, run, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened
-
Methods inherited from class java.awt.Frame
addNotify, getAccessibleContext, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, paramString, remove, removeNotify, setBackground, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated
-
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree
-
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
-
-
-
-
Field Detail
-
LOC_KEY
public static final String LOC_KEY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RoiManager
public RoiManager()
Opens the "ROI Manager" window, or activates it if it is already open.- See Also:
RoiManager(boolean),getRoiManager()
-
RoiManager
public RoiManager(boolean b)
Constructs an ROI Manager without displaying it. The boolean argument is ignored.
-
-
Method Detail
-
actionPerformed
public void actionPerformed(ActionEvent e)
- Specified by:
actionPerformedin interfaceActionListener
-
itemStateChanged
public void itemStateChanged(ItemEvent e)
- Specified by:
itemStateChangedin interfaceItemListener
-
addRoi
public void addRoi(Roi roi)
Adds the specified ROI.
-
add
public void add(Roi roi, int n)
Adds the specified ROI to the list. The second argument ('n') will be used to form the first part of the ROI label if it is zero or greater.- Parameters:
roi- the Roi to be addedn- if zero or greater, will be used to form the first part of the label
-
add
public void add(ImagePlus imp, Roi roi, int n)
Adds the specified ROI to the list. The third argument ('n') will be used to form the first part of the ROI label if it is zero or greater.- Parameters:
imp- the image associated with the ROI, or nullroi- the Roi to be addedn- if zero or greater, will be used to form the first part of the label
-
setRoi
public void setRoi(Roi roi, int index)
Replaces the ROI at the specified index.
-
delete
public void delete(int index)
Deletes the ROI at 'index' and updates the display.
-
rename
public void rename(int index, String newName)
-
getSliceNumber
public int getSliceNumber(String label)
Returns the slice number associated with the specified name, or -1 if the name does not include a slice number.
-
open
public boolean open(String path)
Opens a single .roi file or a ZIP-compressed set of ROIs. Returns 'true' if the operation was succesful.
-
save
public boolean save(String path)
If one ROI is selected, it is saved as a .roi file, if multiple (or no) ROIs are selected, they are saved as a .zip ROI set. Returns 'true' if the save operation was succesful.- See Also:
setSelectedIndexes(int[])
-
multiMeasure
public ResultsTable multiMeasure(ImagePlus imp)
This method measures the selected ROIs, or all ROIs if none are selected, on all the slices of a stack and returns a ResultsTable arranged with one row per slice.- See Also:
- JavaScript example
-
multiMeasure
public static ResultsTable multiMeasure(ImagePlus imp, Roi[] rois, boolean appendResults)
-
setGroup
public void setGroup(int group)
Sets the group for the selected ROIs.
-
setPosition
public void setPosition(int position)
Sets the position of the selected ROIs.
-
setPosition
public void setPosition(int c, int z, int t)Sets the c,z,t position of the selected ROIs.
-
setGroup
public static void setGroup(String group)
Obsolete; replaced by RoiManager.setGroup() macro function.
-
getDrawLabels
public boolean getDrawLabels()
-
processWindowEvent
public void processWindowEvent(WindowEvent e)
- Overrides:
processWindowEventin classWindow
-
getRoiManager
public static RoiManager getRoiManager()
Returns a reference to the ROI Manager if it open or opens it if it is not already open.
-
getInstance
public static RoiManager getInstance()
Returns a reference to the ROI Manager, or null if it is not open and a batch mode macro is not running. If the ROI Manager is not open and a batch mode macro is running, returns the hidden batch mode RoiManager.- See Also:
getRoiManager()
-
getRawInstance
public static RoiManager getRawInstance()
-
getInstance2
public static RoiManager getInstance2()
Returns a reference to the ROI Manager window or to the macro batch mode RoiManager, or null if neither exists.
-
getROIs
public Hashtable getROIs()
Deprecated.Obsolete- See Also:
getCount(),getRoisAsArray()
-
getList
public List getList()
Deprecated.Obsolete- See Also:
getCount(),getRoisAsArray(),getSelectedIndex()
-
getCount
public int getCount()
Returns the ROI count.
-
selected
public int selected()
Returns the count of selected ROIs.
-
getRoiIndex
public int getRoiIndex(Roi roi)
Returns the index of the specified Roi, or -1 if it is not found.
-
getSelectedIndex
public int getSelectedIndex()
Returns the index of the first selected ROI or -1 if no ROI is selected.
-
getRoi
public Roi getRoi(int index)
Returns a reference to the ROI at the specified index.
-
getRoisAsArray
public Roi[] getRoisAsArray()
Returns the ROIs as an array.
-
getSelectedRoisAsArray
public Roi[] getSelectedRoisAsArray()
Returns the selected ROIs as an array, or all the ROIs if none are selected.
-
getName
public String getName(int index)
Returns the name of the ROI with the specified index, or null if the index is out of range. See also: RoiManager.getName() macro function.
-
getIndex
public int getIndex(String name)
Returns the index of the first ROI with the specified name, or -1 if no ROI has that name. See also: RoiManager.getIndex() macro function.
-
getName
public static String getName(String index)
Returns the name of the ROI with the specified index. Can be called from a macro usingcall("ij.plugin.frame.RoiManager.getName", index)Returns "null" if the Roi Manager is not open or index is out of range.
-
runCommand
public boolean runCommand(String cmd)
Executes the ROI Manager "Add", "Add & Draw", "Update", "Delete", "Measure", "Draw", "Show All", "Show None", "Fill", "Deselect", "Select All", "Combine", "AND", "XOR", "Split", "Sort" or "Multi Measure" command. Returns false ifcmdis not one of these strings.
-
runCommand
public boolean runCommand(ImagePlus imp, String cmd)
Using the specified image, runs the ROI Manager "Add", "Add & Draw", "Update", "Delete", "Measure", "Draw", "Show All", "Show None", "Fill", "Deselect", "Select All", "Combine", "AND", "XOR", "Split", "Sort" or "Multi Measure" command.
-
runCommand
public boolean runCommand(String cmd, String name)
Executes the ROI Manager "Open", "Save" or "Rename" command. Returns false ifcmdis not "Open", "Save" or "Rename", or if an error occurs.
-
reset
public void reset()
Clears this RoiManager so that it contains no ROIs.
-
scale
public void scale(double xscale, double yscale, boolean centered)
-
rotate
public void rotate(double angle)
-
rotate
public void rotate(double angle, double xcenter, double ycenter)
-
translate
public void translate(double dx, double dy)Moves the selected ROIs or all the ROIs if none are selected.
-
runCommand
public boolean runCommand(String cmd, String hexColor, double lineWidth)
Adds the current selection to the ROI Manager, using the specified color (a 6 digit hex string) and line width.
-
select
public void select(int index)
Assigns the ROI at the specified index to the current image.
-
select
public void select(ImagePlus imp, int index)
Assigns the ROI at the specified index to 'imp'.
-
selectAndMakeVisible
public void selectAndMakeVisible(ImagePlus imp, int index)
-
select
public void select(int index, boolean shiftKeyDown, boolean altKeyDown)
-
selectGroup
public void selectGroup(int group)
Selects all ROIs of a given group.
-
selectPosition
public void selectPosition(int c, int z, int t)Selects all ROIs at the specified position.
-
selectGroup
public static void selectGroup(String group)
Obsolete; replaced by RoiManager.selectGroup() macro function.
-
deselect
public void deselect()
-
deselect
public void deselect(Roi roi)
Deselect the specified ROI if it is the only one selected.
-
setEditMode
public void setEditMode(ImagePlus imp, boolean editMode)
-
close
public void close()
Overrides PlugInFrame.close().- Overrides:
closein classPlugInFrame
-
moveRoisToOverlay
public void moveRoisToOverlay(ImagePlus imp)
Moves all the ROIs to the specified image's overlay.
-
mousePressed
public void mousePressed(MouseEvent e)
- Specified by:
mousePressedin interfaceMouseListener
-
mouseWheelMoved
public void mouseWheelMoved(MouseWheelEvent event)
- Specified by:
mouseWheelMovedin interfaceMouseWheelListener
-
setSelectedIndexes
public void setSelectedIndexes(int[] indexes)
Selects multiple ROIs, where 'indexes' is an array of integers, each greater than or equal to 0 and less than the value returned by getCount().- See Also:
getSelectedIndexes(),getSelectedRoisAsArray(),getCount()
-
getSelectedIndexes
public int[] getSelectedIndexes()
Returns an array of the selected indexes.
-
getIndexesAsString
public static String getIndexesAsString()
This is a macro-callable version of getSelectedIndexes(). Example: indexes=split(call("ij.plugin.frame.RoiManager.getIndexesAsString"));
-
getIndexes
public int[] getIndexes()
Returns an array of the selected indexes or all indexes if none are selected.
-
isSelected
public boolean isSelected(int index)
Returns 'true' if the index is valid and the indexed ROI is selected.
-
allowRecording
public void allowRecording(boolean allow)
-
restoreCentered
public static void restoreCentered(boolean b)
-
mouseClicked
public void mouseClicked(MouseEvent e)
- Specified by:
mouseClickedin interfaceMouseListener
-
mouseReleased
public void mouseReleased(MouseEvent e)
- Specified by:
mouseReleasedin interfaceMouseListener
-
mouseEntered
public void mouseEntered(MouseEvent e)
- Specified by:
mouseEnteredin interfaceMouseListener
-
mouseExited
public void mouseExited(MouseEvent e)
- Specified by:
mouseExitedin interfaceMouseListener
-
valueChanged
public void valueChanged(ListSelectionEvent e)
- Specified by:
valueChangedin interfaceListSelectionListener
-
windowActivated
public void windowActivated(WindowEvent e)
- Specified by:
windowActivatedin interfaceWindowListener- Overrides:
windowActivatedin classPlugInFrame
-
resetMultiMeasureResults
public static void resetMultiMeasureResults()
-
setOverlay
public void setOverlay(Overlay overlay)
-
getErrorMessage
public static String getErrorMessage()
Returns the most recent I/O error message, or null if there was no error.
-
-