1 /* Copyright 2013 Applied Defense Solutions, Inc.
2 * Licensed to CS Communication & Systèmes (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.utils;
18
19 import java.io.Serializable;
20 import java.util.Arrays;
21
22 import org.hipparchus.util.FastMath;
23 import org.hipparchus.util.MathUtils;
24 import org.orekit.errors.OrekitIllegalArgumentException;
25 import org.orekit.errors.OrekitMessages;
26
27 /**
28 * Class for modeling the ground elevation values around a given point.
29 * <p>
30 * Instances of this class can be considered to be immutable
31 * @author Hank Grabowski
32 * @since 6.1
33 */
34 public class ElevationMask implements Serializable {
35
36 /** Serializable UID. */
37 private static final long serialVersionUID = 20131118L;
38
39 /** Azimuth-elevation mask. */
40 private final double[][] azelmask;
41
42 /**
43 * Creates an instance of an Elevation mask based on the passed in parameter.
44 * @param mask azimuth-elevation mask (rad). First column (i.e. mask[i][0])
45 * should contain azimuth values and the second column (i.e. mask[i][1])
46 * should contain corresponding elevations
47 */
48 public ElevationMask(final double[][] mask) {
49 this.azelmask = checkMask(mask);
50 }
51
52 /** Get the interpolated elevation for a given azimuth according to the mask.
53 * @param azimuth azimuth (rad)
54 * @return elevation angle (rad)
55 */
56 public double getElevation(final double azimuth) {
57 double elevation = 0.0;
58 boolean fin = false;
59 for (int i = 1; i < azelmask.length & !fin; i++) {
60 if (azimuth <= azelmask[i][0]) {
61 fin = true;
62 final double azd = azelmask[i - 1][0];
63 final double azf = azelmask[i][0];
64 final double eld = azelmask[i - 1][1];
65 final double elf = azelmask[i][1];
66 elevation = eld + (azimuth - azd) * (elf - eld) / (azf - azd);
67 }
68 }
69 return elevation;
70 }
71
72 /** Checking and ordering the azimuth-elevation tabulation.
73 * @param azimelev azimuth-elevation tabulation to be checked and ordered
74 * @return ordered azimuth-elevation tabulation ordered
75 */
76 private static double[][] checkMask(final double[][] azimelev) {
77
78 // Copy of the given mask
79 final double[][] mask = new double[azimelev.length + 2][azimelev[0].length];
80 for (int i = 0; i < azimelev.length; i++) {
81 System.arraycopy(azimelev[i], 0, mask[i + 1], 0, azimelev[i].length);
82 // Reducing azimuth between 0 and 2*Pi
83 mask[i + 1][0] = MathUtils.normalizeAngle(mask[i + 1][0], FastMath.PI);
84 }
85
86 // Sorting the mask with respect to azimuth
87 Arrays.sort(mask, 1, mask.length - 1, (d1, d2) -> Double.compare(d1[0], d2[0]));
88
89 // Extending the mask in order to cover [0, 2PI] in azimuth
90 mask[0][0] = mask[mask.length - 2][0] - MathUtils.TWO_PI;
91 mask[0][1] = mask[mask.length - 2][1];
92 mask[mask.length - 1][0] = mask[1][0] + MathUtils.TWO_PI;
93 mask[mask.length - 1][1] = mask[1][1];
94
95 // Checking the sorted mask: same azimuth modulo 2PI must have same elevation
96 for (int i = 1; i < mask.length; i++) {
97 if (Double.compare(mask[i - 1][0], mask[i][0]) == 0) {
98 if (Double.compare(mask[i - 1][1], mask[i][1]) != 0) {
99 throw new OrekitIllegalArgumentException(OrekitMessages.UNEXPECTED_TWO_ELEVATION_VALUES_FOR_ONE_AZIMUTH,
100 mask[i - 1][1], mask[i][1], mask[i][0]);
101 }
102 }
103 }
104
105 return mask;
106 }
107
108
109 }