ROIPropertyDescriptorsPlugin

Field Summary

Fields
Modifier and Type	Field and Description
`static ROIColorDescriptor`	`colorDescriptor`
`static ROIGroupIdDescriptor`	`groupIdDescriptor`
`static ROIIconDescriptor`	`iconDescriptor`
`static java.lang.String`	`ID_COLOR`
`static java.lang.String`	`ID_ICON`
`static java.lang.String`	`ID_NAME`
`static java.lang.String`	`ID_OPACITY`
`static java.lang.String`	`ID_READONLY`
`static ROINameDescriptor`	`nameDescriptor`
`static ROIOpacityDescriptor`	`opacityDescriptor`
`static ROIReadOnlyDescriptor`	`readOnlyDescriptor`

Constructor Summary

Constructors
Constructor and Description

ROIPropertyDescriptorsPlugin()

Constructors
Constructor and Description
`ROIPropertyDescriptorsPlugin()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.Map<ROIDescriptor,java.lang.Object>`	`compute(ROI roi, Sequence sequence)` Computes the descriptor(s) (declared in the `PluginROIDescriptor.getDescriptors()`) on the specified ROI.
`java.util.List<ROIDescriptor>`	`getDescriptors()` Returns the list of `ROIDescriptor` available in this plug-in.

Methods inherited from class icy.plugin.abstract_.Plugin
addIcyFrame, addSequence, getActiveImage, getActiveSequence, getActiveViewer, getDescriptor, getFocusedImage, getFocusedSequence, getFocusedViewer, getIconResource, getImageResource, getInstallFolder, getName, getOwnerClassName, getPlugin, getPreferences, getPreferencesRoot, getResource, getResourceAsStream, getResources, getSequences, isBundled, loadLibrary, prepareLibrary, removeSequence, report, toString

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

- Field Detail
  - ID_ICON
```
public static final java.lang.String ID_ICON
```
    See Also:
    Constant Field Values
  - ID_NAME
```
public static final java.lang.String ID_NAME
```
    See Also:
    Constant Field Values
  - ID_COLOR
```
public static final java.lang.String ID_COLOR
```
    See Also:
    Constant Field Values
  - ID_OPACITY
```
public static final java.lang.String ID_OPACITY
```
    See Also:
    Constant Field Values
  - ID_READONLY
```
public static final java.lang.String ID_READONLY
```
    See Also:
    Constant Field Values
  - iconDescriptor
```
public static final ROIIconDescriptor iconDescriptor
```
  - nameDescriptor
```
public static final ROINameDescriptor nameDescriptor
```
  - groupIdDescriptor
```
public static final ROIGroupIdDescriptor groupIdDescriptor
```
  - colorDescriptor
```
public static final ROIColorDescriptor colorDescriptor
```
  - opacityDescriptor
```
public static final ROIOpacityDescriptor opacityDescriptor
```
  - readOnlyDescriptor
```
public static final ROIReadOnlyDescriptor readOnlyDescriptor
```
- Constructor Detail
  - ROIPropertyDescriptorsPlugin
```
public ROIPropertyDescriptorsPlugin()
```
- Method Detail
  - getDescriptors
```
public java.util.List<ROIDescriptor> getDescriptors()
```
    Description copied from interface: PluginROIDescriptor
    Returns the list of ROIDescriptor available in this plug-in.
    While simple descriptors usually have just to return a single a real-valued number (e.g. volume), advanced descriptors may need to produce several results for a given ROI (e.g. a best-fitting ellipse is defined by multiple parameters), or adjust the name of the descriptor(s) based on the type of ROI (e.g. "surface" would only apply in 2D, while "volume" would only apply in 3D).
    Example:
```
 List result = ArrayList();
 result.add(new ROIDescriptor("area", Double.class));
 result.add(new ROIDescriptor("volume", Double.class));
 result.add(new ROIDescriptor("...", Double.class));
 
```
    Specified by:
    
    getDescriptors in interface PluginROIDescriptor
  - compute
```
public java.util.Map<ROIDescriptor,java.lang.Object> compute(ROI roi,
                                                    Sequence sequence)
                                                      throws java.lang.UnsupportedOperationException
```
    Description copied from interface: PluginROIDescriptor
    
    Computes the descriptor(s) (declared in the PluginROIDescriptor.getDescriptors()) on the specified ROI.
    Depending on the type of descriptor and ROI, this method can return null for some of the descriptor results.
    Note that using this method may be faster than calling the compute method for each descriptor separately as some descriptor can group their calculation.
    
    Specified by:
    
    compute in interface PluginROIDescriptor
    
    Parameters:
    roi - the ROI on which the descriptor(s) should be computed
    sequence - an optional sequence where the pixel informations can be retrieved
    
    Returns:
    a map where each entry associates a descriptor to its value (which can be null if the descriptor cannot be computed).
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the type of the given ROI is not supported by this descriptor or if sequence is null while the calculation requires it.

Class ROIPropertyDescriptorsPlugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class icy.plugin.abstract_.Plugin

Methods inherited from class java.lang.Object

Field Detail

ID_ICON

ID_NAME

ID_COLOR

ID_OPACITY

ID_READONLY

iconDescriptor

nameDescriptor

groupIdDescriptor

colorDescriptor

opacityDescriptor

readOnlyDescriptor

Constructor Detail

ROIPropertyDescriptorsPlugin

Method Detail

getDescriptors

compute