plugins.kernel.roi.descriptor.measure

Class ROIVolumeDescriptor

java.lang.Object

icy.roi.ROIDescriptor

plugins.kernel.roi.descriptor.measure.ROIVolumeDescriptor

public class ROIVolumeDescriptor
extends ROIDescriptor

Volume 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
ROIVolumeDescriptor()

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	computeVolume(double interiorPoints, ROI roi, Sequence sequence) Computes and returns the volume from a given number of interior points expressed in the unit of the descriptor (see getUnit(Sequence)) for the specified sequence and ROI.
static double	computeVolume(ROI roi, Sequence sequence) Computes and returns the volume expressed in the unit of the descriptor (see getUnit(Sequence)) for 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"...
boolean	needRecompute(SequenceEvent change) Returns true if this descriptor need to be recomputed when the specified Sequence change event happen.

Methods inherited from class icy.roi.ROIDescriptor

computeDescriptor, computeDescriptor, equals, getDescriptor, getDescriptor, getDescriptors, getId, getName, getType, hashCode, 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

ROIVolumeDescriptor

public ROIVolumeDescriptor()

Method Detail

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

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

needRecompute

public boolean needRecompute(SequenceEvent change)

Description copied from class: ROIDescriptor

Returns true if this descriptor need to be recomputed when the specified Sequence change event happen.
By default it returns false, override this method if a descriptor need a specific implementation.

Overrides:

needRecompute in class ROIDescriptor

See Also:

ROIDescriptor.compute(ROI, Sequence)

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

computeVolume

public static double computeVolume(ROI roi,
                   Sequence sequence)
                            throws java.lang.UnsupportedOperationException

Computes and returns the volume expressed in the unit of the descriptor (see getUnit(Sequence)) for the specified ROI.
It may thrown an UnsupportedOperationException if the operation is not supported for that ROI.

Parameters:

roi - the ROI on which we want to compute the volume

sequence - an optional sequence where the pixel size can be retrieved

Returns:

the volume expressed in the unit of the descriptor (see getUnit(Sequence))

Throws:

java.lang.UnsupportedOperationException - if the operation is not supported for this ROI

computeVolume

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

Computes and returns the volume from a given number of interior points expressed in the unit of the descriptor (see getUnit(Sequence)) for the specified sequence and ROI.
It may returns Double.Nan 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 volume

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

Returns:

the volume expressed in the unit of the descriptor (see getUnit(Sequence))

Throws:

java.lang.UnsupportedOperationException - if the operation is not supported for this ROI