icy.plugin.interface_

Interface PluginROIDescriptor

All Superinterfaces:

PluginNoEDTConstructor

All Known Implementing Classes:

ROIBasicMeasureDescriptorsPlugin, ROIIntensityDescriptorsPlugin, ROIMassCenterDescriptorsPlugin, ROIPositionDescriptorsPlugin, ROIPropertyDescriptorsPlugin, ROISizeDescriptorsPlugin

public interface PluginROIDescriptor
extends PluginNoEDTConstructor

Plugin interface providing the basic functionalities to compute various descriptors for regions of interest (ROI)

Author:

Stephane Dallongeville, Alexandre Dufour

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 getDescriptors()) on the specified ROI.
java.util.List<ROIDescriptor>	getDescriptors() Returns the list of ROIDescriptor available in this plug-in.

Method Detail

getDescriptors

java.util.List<ROIDescriptor> getDescriptors()

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));
 

compute

java.util.Map<ROIDescriptor,java.lang.Object> compute(ROI roi,
                                                    Sequence sequence)
                                                      throws java.lang.UnsupportedOperationException

Computes the descriptor(s) (declared in the 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.

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.