plugins.kernel.roi.descriptor.property

Class ROIIconDescriptor

java.lang.Object

icy.roi.ROIDescriptor

plugins.kernel.roi.descriptor.property.ROIIconDescriptor

public class ROIIconDescriptor
extends ROIDescriptor

Icon descriptor class (see ROIDescriptor).
Return the ROI icon a 20 pixels side icon

Author:

Stephane

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ROIIconDescriptor()

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.
java.lang.String	getDescription() Returns a single line description (used as tooltip) for this descriptor
static java.awt.Image	getIcon(ROI roi) Returns ROI icon
boolean	needRecompute(ROIEvent change) Returns true if this descriptor need to be recomputed when the specified ROI change event happen.

Methods inherited from class icy.roi.ROIDescriptor

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

ROIIconDescriptor

public ROIIconDescriptor()

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

needRecompute

public boolean needRecompute(ROIEvent change)

Description copied from class: ROIDescriptor

Returns true if this descriptor need to be recomputed when the specified ROI change event happen.
By default it returns true on ROI content change, 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

getIcon

public static java.awt.Image getIcon(ROI roi)

Returns ROI icon