1   /* Copyright 2013-2017 CS Systèmes d'Information
2    * Licensed to CS Systèmes d'Information (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.orekit.rugged.raster;
18  
19  import org.orekit.rugged.errors.RuggedException;
20  
21  /** Interface representing one tile of a raster Digital Elevation Model.
22   * @author Luc Maisonobe
23   * @author Guylaine Prat
24   */
25  public interface UpdatableTile {
26  
27      /** Set the tile global geometry.
28       * @param minLatitude minimum latitude (rad)
29       * @param minLongitude minimum longitude (rad)
30       * @param latitudeStep step in latitude (size of one raster element) (rad)
31       * @param longitudeStep step in longitude (size of one raster element) (rad)
32       * @param latitudeRows number of latitude rows
33       * @param longitudeColumns number of longitude columns
34       * @exception RuggedException if tile is empty (zero rows or columns)
35       */
36      void setGeometry(double minLatitude, double minLongitude,
37                       double latitudeStep, double longitudeStep,
38                       int latitudeRows, int longitudeColumns)
39          throws RuggedException;
40  
41      /** Set the elevation for one raster element.
42       * <p>
43       * BEWARE! The order of the indices follows geodetic conventions, i.e.
44       * the latitude is given first and longitude afterwards, so the first
45       * index specifies a <em>row</em> index with zero at South and max value
46       * at North, and the second index specifies a <em>column</em> index
47       * with zero at West and max value at East. This is <em>not</em> the
48       * same as some raster conventions (as our row index increases from South
49       * to North) and this is also not the same as Cartesian coordinates as
50       * our ordinate index appears before our abscissa index).
51       * </p>
52       * @param latitudeIndex index of latitude (row index)
53       * @param longitudeIndex index of longitude (column index)
54       * @param elevation elevation (m)
55       * @exception RuggedException if indices are out of bound
56       */
57      void setElevation(int latitudeIndex, int longitudeIndex, double elevation)
58          throws RuggedException;
59  
60  }