001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2005-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.coverage;
033
034 import java.util.Set;
035 import org.opengis.geometry.primitive.Curve;
036 import org.opengis.annotation.UML;
037
038 import static org.opengis.annotation.Obligation.*;
039 import static org.opengis.annotation.Specification.*;
040
041
042 /**
043 * Limits of a value segment specified by two values of the arc-length parameter of the
044 * {@linkplain Curve curve} underlying its parent {@linkplain ValueCurve value curve}.
045 *
046 * @version ISO 19123:2004
047 * @author Alessio Fabiani
048 * @author Martin Desruisseaux (IRD)
049 * @since GeoAPI 2.1
050 */
051 @UML(identifier="CV_ValueSegment", specification=ISO_19123)
052 public interface ValueSegment {
053 /**
054 * Returns the value of the arc-length parameter of the parent
055 * curve at the start of this value segment.
056 *
057 * @return The value at the start of this segment.
058 */
059 @UML(identifier="startParameter", obligation=MANDATORY, specification=ISO_19123)
060 double getStartParameter();
061
062 /**
063 * Returns the value of the arc-length parameter of the parent
064 * curve at the end of this value segment.
065 *
066 * @return The value at the end of this segment.
067 */
068 @UML(identifier="endParameter", obligation=MANDATORY, specification=ISO_19123)
069 double getEndParameter();
070
071 /**
072 * Returns the set of <var>point</var>-<var>value</var> pairs that provide control
073 * values for the interpolation. Linear interpolation requires a minimum of two control
074 * values, usually those at the beginning and end of the value segment. Additional
075 * control values are required to support interpolation by higher order functions.
076 *
077 * @return The set of control points and values.
078 */
079 @UML(identifier="controlPoint", obligation=MANDATORY, specification=ISO_19123)
080 Set<PointValuePair> getControlPoints();
081 }