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.geometry.coordinate;
033
034 import org.opengis.annotation.UML;
035
036 import static org.opengis.annotation.Obligation.*;
037 import static org.opengis.annotation.Specification.*;
038
039
040 /**
041 * A {@linkplain ParametricCurveSurface parametric curve surface} defined from a rectangular grid
042 * in the parameter space. The rows from this grid are control points for horizontal surface curves;
043 * the columns are control points for vertical surface curves. The working assumption is that for a
044 * pair of parametric coordinates (<var>s</var>, <var>t</var>), that the horizontal curves for
045 * each integer offset are calculated and evaluated at <var>s</var>. This defines a sequence of
046 * control points:
047 *
048 * <blockquote>
049 * <c<sub>n</sub>(<var>s</var>) : <var>s</var> = 1 … columns>
050 * </blockquote>
051 *
052 * From this sequence, a vertical curve is calculated for <var>s</var>, and evaluated at <var>t</var>.
053 * In most cases, the order of calculation (horizontal-vertical versus vertical-horizontal) does not
054 * make a difference. Where it does, the horizontal-vertical order shall be the one used.
055 * <p>
056 * The most common case of a gridded surface is a 2D spline. In this case the weight functions for
057 * each parameter make order of calculation unimportant:
058 *
059 * <blockquote>TODO: copy equations there</blockquote>
060 *
061 * Logically, any pair of curve interpolation types can lead to a subtype of {@code GriddedSurface}.
062 * The sub-interfaces provided in this package define some of the most commonly encountered surfaces
063 * that can be represented in this manner.
064 *
065 * @version <A HREF="http://www.opengeospatial.org/standards/as">ISO 19107</A>
066 * @author Martin Desruisseaux (IRD)
067 * @since GeoAPI 2.0
068 */
069 @UML(identifier="GM_GriddedSurface", specification=ISO_19107)
070 public interface GriddedSurface extends ParametricCurveSurface {
071 /**
072 * Returns the doubly indexed sequence of control points, given in row major form.
073 * There is no assumption made about the shape of the grid. For example, the positions
074 * need not effect a "2½D" surface, consecutive points may be equal in any or
075 * all of their ordinates. Further, the curves in either or both directions may close.
076 */
077 @UML(identifier="controlPoint", obligation=MANDATORY, specification=ISO_19107)
078 PointGrid getControlPoints();
079
080 /**
081 * Returns the number of rows in the parameter grid.
082 */
083 @UML(identifier="rows", obligation=MANDATORY, specification=ISO_19107)
084 int getRows();
085
086 /**
087 * Returns the number of columns in the parameter grid.
088 */
089 @UML(identifier="columns", obligation=MANDATORY, specification=ISO_19107)
090 int getColumns();
091 }