ROIPositionDescriptorsPlugin

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ID_POSITION_C`
`static java.lang.String`	`ID_POSITION_T`
`static java.lang.String`	`ID_POSITION_X`
`static java.lang.String`	`ID_POSITION_Y`
`static java.lang.String`	`ID_POSITION_Z`
`static ROIPositionCDescriptor`	`positionCDescriptor`
`static ROIPositionTDescriptor`	`positionTDescriptor`
`static ROIPositionXDescriptor`	`positionXDescriptor`
`static ROIPositionYDescriptor`	`positionYDescriptor`
`static ROIPositionZDescriptor`	`positionZDescriptor`

Constructor Summary

Constructors
Constructor and Description

ROIPositionDescriptorsPlugin()

Constructors
Constructor and Description
`ROIPositionDescriptorsPlugin()`

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, removeSequence, report, toString

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

- Field Detail
  - ID_POSITION_X
```
public static final java.lang.String ID_POSITION_X
```
    See Also:
    Constant Field Values
  - ID_POSITION_Y
```
public static final java.lang.String ID_POSITION_Y
```
    See Also:
    Constant Field Values
  - ID_POSITION_Z
```
public static final java.lang.String ID_POSITION_Z
```
    See Also:
    Constant Field Values
  - ID_POSITION_T
```
public static final java.lang.String ID_POSITION_T
```
    See Also:
    Constant Field Values
  - ID_POSITION_C
```
public static final java.lang.String ID_POSITION_C
```
    See Also:
    Constant Field Values
  - positionXDescriptor
```
public static final ROIPositionXDescriptor positionXDescriptor
```
  - positionYDescriptor
```
public static final ROIPositionYDescriptor positionYDescriptor
```
  - positionZDescriptor
```
public static final ROIPositionZDescriptor positionZDescriptor
```
  - positionTDescriptor
```
public static final ROIPositionTDescriptor positionTDescriptor
```
  - positionCDescriptor
```
public static final ROIPositionCDescriptor positionCDescriptor
```
- Constructor Detail
  - ROIPositionDescriptorsPlugin
```
public ROIPositionDescriptorsPlugin()
```
- 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.

Icy Developer Documentation

Class ROIPositionDescriptorsPlugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class icy.plugin.abstract_.Plugin

Methods inherited from class java.lang.Object

Field Detail

ID_POSITION_X

ID_POSITION_Y

ID_POSITION_Z

ID_POSITION_T

ID_POSITION_C

positionXDescriptor

positionYDescriptor

positionZDescriptor

positionTDescriptor

positionCDescriptor

Constructor Detail

ROIPositionDescriptorsPlugin

Method Detail

getDescriptors

compute

Icy Developer Documentation