plugins.kernel.roi.descriptor.intensity

Class ROISumIntensityDescriptor

java.lang.Object

icy.roi.ROIDescriptor

plugins.kernel.roi.descriptor.intensity.ROISumIntensityDescriptor

public class ROISumIntensityDescriptor
extends ROIDescriptor

Sum intensity 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
ROISumIntensityDescriptor()

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	computeSumIntensity(ROI roi, Sequence sequence) Computes and returns the intensity sum for the specified ROI on given sequence.
java.lang.String	getDescription() Returns a single line description (used as tooltip) for this descriptor
boolean	needRecompute(SequenceEvent change) Returns true if this descriptor need to be recomputed when the specified Sequence change event happen.
boolean	separateChannel() Returns true if this descriptor compute its result on Sequence data and *per channel* (as pixel intensity information).

Methods inherited from class icy.roi.ROIDescriptor

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

ROISumIntensityDescriptor

public ROISumIntensityDescriptor()

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

separateChannel

public boolean separateChannel()

Description copied from class: ROIDescriptor

Returns true if this descriptor compute its result on Sequence data and *per channel* (as pixel intensity information).
By default it returns false, override this method if a descriptor require per channel computation.

Overrides:

separateChannel in class ROIDescriptor

See Also:

ROIDescriptor.compute(ROI, Sequence)

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

computeSumIntensity

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

Computes and returns the intensity sum for the specified ROI on given sequence.
It may returns Double.Nan if the operation is not supported for that ROI.

Parameters:

roi - the ROI on which we want to compute the intensity sum

sequence - the sequence used to compute the pixel intensity

Throws:

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