ROIHandler (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.plugins.util.ROIHandler

```
public class ROIHandler
extends Object
```
Utility class for managing regions of interest within ImageJ. Capable of constructing ROIs within ImageJ's ROI manager matching those specified in an OME metadata store, and vice versa.

Author:

Melissa Linkert melissa at glencoesoftware.com

Constructor Summary

Constructors
Constructor and Description

ROIHandler()

Constructors
Constructor and Description
`ROIHandler()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`openROIs(IMetadata retrieve, ij.ImagePlus[] images)` Look for ROIs in the given OMEXMLMetadata; if any are present, apply them to the given images and display them in the ROI manager.
`static void`	`openROIs(IMetadata retrieve, ij.ImagePlus[] images, boolean isOMERO)` Opens the rois and converts them into ImageJ Rois.
`static void`	`openROIs(IMetadata retrieve, ij.ImagePlus[] images, boolean isOMERO, String roisMode)` Opens the rois and converts them into ImageJ Rois.
`static Roi[]`	`readFromOverlays()` Returns rois if any from the overlay.
`static Roi[]`	`readFromRoiManager()` Returns the rois if any stored in the ROI manager.
`static void`	`saveROIs(MetadataStore store)` Save ROIs in the ROI manager to the given MetadataStore.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ROIHandler
```
public ROIHandler()
```
- Method Detail
  - openROIs
```
public static void openROIs(IMetadata retrieve,
                            ij.ImagePlus[] images)
```
    Look for ROIs in the given OMEXMLMetadata; if any are present, apply them to the given images and display them in the ROI manager.
  - openROIs
```
public static void openROIs(IMetadata retrieve,
                            ij.ImagePlus[] images,
                            boolean isOMERO)
```
    Opens the rois and converts them into ImageJ Rois.
    
    Parameters:
    
    retrieve - The OMEXML store.
    
    images - The imageJ object.
    
    isOMERO - true if data stored in OMERO, false otherwise.
  - openROIs
```
public static void openROIs(IMetadata retrieve,
                            ij.ImagePlus[] images,
                            boolean isOMERO,
                            String roisMode)
```
    Opens the rois and converts them into ImageJ Rois.
    
    Parameters:
    
    retrieve - The OMEXML store.
    
    images - The imageJ object.
    
    isOMERO - true if data stored in OMERO, false otherwise.
    
    roisMode - Determines whether to import Rois to overlay or RoiManager
  - readFromRoiManager
```
public static Roi[] readFromRoiManager()
```
    Returns the rois if any stored in the ROI manager.
    
    Returns:
    
    See above.
  - readFromOverlays
```
public static Roi[] readFromOverlays()
```
    Returns rois if any from the overlay.
    
    Returns:
    
    See above
  - saveROIs
```
public static void saveROIs(MetadataStore store)
```
    Save ROIs in the ROI manager to the given MetadataStore.
    
    Parameters:
    
    store - Where to store the rois.

Class ROIHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ROIHandler

Method Detail

openROIs

openROIs

openROIs

readFromRoiManager

readFromOverlays

saveROIs