001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2005-2013 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.DirectPosition;
036 import org.opengis.geometry.coordinate.Triangle;
037 import org.opengis.annotation.UML;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041
042
043 /**
044 * A {@linkplain ValueObject value object} that consists of three {@linkplain PointValuePair
045 * point-value pairs} where the points are non-collinear. Value triangles are used for interpolation
046 * of a coverage.
047 *
048 * @version ISO 19123:2004
049 * @author Alessio Fabiani
050 * @author Martin Desruisseaux (IRD)
051 * @since GeoAPI 2.1
052 */
053 @UML(identifier="CV_ValueTriangle", specification=ISO_19123)
054 public interface ValueTriangle extends ValueObject {
055 /**
056 * Returns the triangle that defines the relative position of the three
057 * {@linkplain PointValuePair point-value pairs} at its vertices.
058 *
059 * @return The geometry as a triangle.
060 *
061 * @todo The returns type in ISO-19123 is {@link Triangle}.
062 */
063 @UML(identifier="geometry", obligation=MANDATORY, specification=ISO_19123)
064 DomainObject<?> getGeometry();
065
066 /**
067 * Returns the three <var>point</var>-<var>value</var> pairs at the vertices of this
068 * value triangle.
069 *
070 * @return The control values.
071 */
072 @UML(identifier="controlValue", obligation=MANDATORY, specification=ISO_19123)
073 Set<PointValuePair> getControlValues();
074
075 /**
076 * Returns the barycentric coordinates of the specified position as a sequence of numbers.
077 *
078 * @param p The position where to calculate.
079 * @return The barycentric coordinates.
080 */
081 @UML(identifier="point", obligation=MANDATORY, specification=ISO_19123)
082 double[] point(DirectPosition p);
083 }