plugins.kernel.roi.descriptor.measure

Class ROIInteriorDescriptor

java.lang.Object

icy.roi.ROIDescriptor

plugins.kernel.roi.descriptor.measure.ROIInteriorDescriptor

public class ROIInteriorDescriptor
extends ROIDescriptor

Interior ROI descriptor class (see ROIDescriptor)

Author:

Stephane

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID

Constructor Summary

Constructors

Constructor and Description
ROIInteriorDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	compute(ROI roi, Sequence sequence) Computes the descriptor on the specified ROI and return the result.
static double	computeInterior(double interiorPoints, ROI roi, Sequence sequence, int dim) Returns the interior size from a given number of interior points in the best unit (see Sequence.getBestPixelSizeUnit(int, int)) for the specified sequence and dimension.
static double	computeInterior(ROI roi) Returns the number of point inside the specified ROI.
java.lang.String	getDescription() Returns a single line description (used as tooltip) for this descriptor
java.lang.String	getUnit(Sequence sequence) Returns the unit of this descriptor (ex: "px", "mm", "µm2"...

Methods inherited from class icy.roi.ROIDescriptor

computeDescriptor, computeDescriptor, equals, getDescriptor, getDescriptor, getDescriptors, getId, getName, getType, hashCode, needRecompute, needRecompute, separateChannel, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

ROIInteriorDescriptor

public ROIInteriorDescriptor()

Method Detail

getUnit

public java.lang.String getUnit(Sequence sequence)

Description copied from class: ROIDescriptor

Returns the unit of this descriptor (ex: "px", "mm", "µm2"...).
It can return an empty or null string (default implementation) if there is no specific unit attached to the descriptor.
Note that unit is concatenated to the name to build the title (column header) in the ROI panel.

Overrides:

getUnit in class ROIDescriptor

Parameters:

sequence - the sequence on which we want to compute the descriptor (if required) to get access to the pixel size informations and return according unit

getDescription

public java.lang.String getDescription()

Description copied from class: ROIDescriptor

Returns a single line description (used as tooltip) for this descriptor

Specified by:

getDescription in class ROIDescriptor

compute

public java.lang.Object compute(ROI roi,
                       Sequence sequence)
                         throws java.lang.UnsupportedOperationException

Description copied from class: ROIDescriptor

Computes the descriptor on the specified ROI and return the result.

Specified by:

compute in class ROIDescriptor

Parameters:

roi - the ROI on which the descriptor(s) should be computed

sequence - an optional sequence where the pixel informations can be retrieved (see ROIDescriptor.separateChannel())

Returns:

the result of this descriptor computed from the specified parameters.

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

computeInterior

public static double computeInterior(ROI roi)

Returns the number of point inside the specified ROI.

Parameters:

roi - the ROI on which we want to compute the number of contour point

Returns:

the number of point inside the ROI

computeInterior

public static double computeInterior(double interiorPoints,
                     ROI roi,
                     Sequence sequence,
                     int dim)
                              throws java.lang.UnsupportedOperationException

Returns the interior size from a given number of interior points in the best unit (see Sequence.getBestPixelSizeUnit(int, int)) for the specified sequence and dimension.

Ex:
• computeInterior(sequence, roi, 2) return the area value
• computeInterior(sequence, roi, 3) return the volume value

It may thrown an UnsupportedOperationException if the operation is not supported for that ROI.

Parameters:

interiorPoints - the number of interior points (override the ROI value)

roi - the ROI we want to compute the interior size

sequence - the input sequence used to retrieve operation unit by using pixel size information.

dim - the dimension for the interior size operation (2 = area, 3 = volume, ...)

Returns:

the number of point inside the ROI

Throws:

java.lang.UnsupportedOperationException - if the interior calculation for the specified dimension is not supported by the ROI

See Also:

Sequence.getBestPixelSizeUnit(int, int)