001package plugins.kernel.roi.descriptor.property;
002
003import icy.roi.ROI;
004import icy.roi.ROIDescriptor;
005import icy.sequence.Sequence;
006import icy.type.rectangle.Rectangle5D;
007
008/**
009 * Size X ROI descriptor class (see {@link ROIDescriptor})
010 * 
011 * @author Stephane
012 */
013public class ROISizeXDescriptor extends ROIDescriptor
014{
015    public static final String ID = "Size X";
016
017    public ROISizeXDescriptor()
018    {
019        super(ID, "Size X", Double.class);
020    }
021
022    @Override
023    public String getDescription()
024    {
025        return "Size in X dimension";
026    }
027
028    @Override
029    public Object compute(ROI roi, Sequence sequence) throws UnsupportedOperationException
030    {
031        return Double.valueOf(getSizeX(roi.getBounds5D()));
032    }
033
034    /**
035     * Returns size X of specified Rectangle5D object
036     */
037    public static double getSizeX(Rectangle5D point)
038    {
039        if (point == null)
040            return Double.NaN;
041
042        return point.getSizeX();
043    }
044}