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