ROIIntensityDescriptorsPlugin

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ROIIntensityDescriptorsPlugin.IntensityDescriptorInfos

Nested Classes
Modifier and Type	Class and Description
`static class`	`ROIIntensityDescriptorsPlugin.IntensityDescriptorInfos`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ID_MAX_INTENSITY`
`static java.lang.String`	`ID_MEAN_INTENSITY`
`static java.lang.String`	`ID_MIN_INTENSITY`
`static java.lang.String`	`ID_STANDARD_DEVIATION`
`static java.lang.String`	`ID_SUM_INTENSITY`
`static ROIMaxIntensityDescriptor`	`maxIntensityDescriptor`
`static ROIMeanIntensityDescriptor`	`meanIntensityDescriptor`
`static ROIMinIntensityDescriptor`	`minIntensityDescriptor`
`static ROIStandardDeviationDescriptor`	`standardDeviationDescriptor`
`static ROISumIntensityDescriptor`	`sumIntensityDescriptor`

Constructor Summary

Constructors
Constructor and Description

ROIIntensityDescriptorsPlugin()

Constructors
Constructor and Description
`ROIIntensityDescriptorsPlugin()`

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.
`static ROIIntensityDescriptorsPlugin.IntensityDescriptorInfos`	`computeIntensityDescriptors(ROI roi, Sequence sequence, boolean allowMultiChannel)` Returns the pixel intensity information for the specified ROI and Sequence.
`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_MIN_INTENSITY
```
public static final java.lang.String ID_MIN_INTENSITY
```
    See Also:
    Constant Field Values
  - ID_MEAN_INTENSITY
```
public static final java.lang.String ID_MEAN_INTENSITY
```
    See Also:
    Constant Field Values
  - ID_MAX_INTENSITY
```
public static final java.lang.String ID_MAX_INTENSITY
```
    See Also:
    Constant Field Values
  - ID_SUM_INTENSITY
```
public static final java.lang.String ID_SUM_INTENSITY
```
    See Also:
    Constant Field Values
  - ID_STANDARD_DEVIATION
```
public static final java.lang.String ID_STANDARD_DEVIATION
```
    See Also:
    Constant Field Values
  - minIntensityDescriptor
```
public static final ROIMinIntensityDescriptor minIntensityDescriptor
```
  - meanIntensityDescriptor
```
public static final ROIMeanIntensityDescriptor meanIntensityDescriptor
```
  - maxIntensityDescriptor
```
public static final ROIMaxIntensityDescriptor maxIntensityDescriptor
```
  - sumIntensityDescriptor
```
public static final ROISumIntensityDescriptor sumIntensityDescriptor
```
  - standardDeviationDescriptor
```
public static final ROIStandardDeviationDescriptor standardDeviationDescriptor
```
- Constructor Detail
  - ROIIntensityDescriptorsPlugin
```
public ROIIntensityDescriptorsPlugin()
```
- Method Detail
  - computeIntensityDescriptors
```
public static ROIIntensityDescriptorsPlugin.IntensityDescriptorInfos computeIntensityDescriptors(ROI roi,
                                                                                 Sequence sequence,
                                                                                 boolean allowMultiChannel)
                                                                                          throws java.lang.Exception,
                                                                                                 java.lang.UnsupportedOperationException
```
    Returns the pixel intensity information for the specified ROI and Sequence.
    Be careful: the returned result may be incorrect or exception may be thrown if the ROI change while the descriptor is being computed.
    
    Parameters:
    roi - the ROI on which we want to compute the intensity descriptors
    sequence - the Sequence used to compute the intensity descriptors
    allowMultiChannel - Allow multi channel intensity computation. If this parameter is set to false and the ROI number of channel is > 1 then a UnsupportedOperationException is launch.
    
    Throws:
    
    java.lang.Exception - If the ROI dimension changed during the descriptor computation.
    
    java.lang.UnsupportedOperationException - If the C dimension of the ROI is > 1 while allowMultiChannel parameter is set to false
  - 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 ROIIntensityDescriptorsPlugin

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class icy.plugin.abstract_.Plugin

Methods inherited from class java.lang.Object

Field Detail

ID_MIN_INTENSITY

ID_MEAN_INTENSITY

ID_MAX_INTENSITY

ID_SUM_INTENSITY

ID_STANDARD_DEVIATION

minIntensityDescriptor

meanIntensityDescriptor

maxIntensityDescriptor

sumIntensityDescriptor

standardDeviationDescriptor

Constructor Detail

ROIIntensityDescriptorsPlugin

Method Detail

computeIntensityDescriptors

getDescriptors

compute