1 package tim.prune.function.srtm;
3 import java.util.ArrayList;
5 import javax.swing.JOptionPane;
8 import tim.prune.DataSubscriber;
9 import tim.prune.GenericFunction;
10 import tim.prune.I18nManager;
11 import tim.prune.UpdateMessageBroker;
12 import tim.prune.data.Altitude;
13 import tim.prune.data.DataPoint;
14 import tim.prune.data.Field;
15 import tim.prune.data.Track;
16 import tim.prune.data.UnitSetLibrary;
17 import tim.prune.gui.ProgressDialog;
18 import tim.prune.undo.UndoLookupSrtm;
21 * Class to provide a lookup function for point altitudes using the Space
22 * Shuttle's SRTM data files. HGT files are downloaded into memory via HTTP and
23 * point altitudes can then be interpolated from the 3m grid data.
25 public class LookupSrtmFunction extends GenericFunction implements Runnable
27 /** Progress dialog */
28 private ProgressDialog _progress = null;
29 /** Track to process */
30 private Track _track = null;
31 /** Flag for whether this is a real track or a terrain one */
32 private boolean _normalTrack = true;
33 /** Flag to check whether this function is currently running or not */
34 private boolean _running = false;
36 /** Altitude below which is considered void */
37 private static final int VOID_VAL = -32768;
41 * @param inApp App object
43 public LookupSrtmFunction(App inApp) {
47 /** @return name key */
48 public String getNameKey() {
49 return "function.lookupsrtm";
53 * Begin the lookup using the normal track
56 begin(_app.getTrackInfo().getTrack(), true);
60 * Begin the lookup with an alternative track
61 * @param inAlternativeTrack
63 public void begin(Track inAlternativeTrack) {
64 begin(inAlternativeTrack, false);
68 * Begin the function with the given parameters
69 * @param inTrack track to process
70 * @param inNormalTrack true if this is a "normal" track, false for an artificially constructed one such as for terrain
72 private void begin(Track inTrack, boolean inNormalTrack)
75 if (! SrtmDiskCache.ensureCacheIsUsable())
77 _app.showErrorMessage(getNameKey(), "error.cache.notthere");
79 if (_progress == null) {
80 _progress = new ProgressDialog(_parentFrame, getNameKey());
84 _normalTrack = inNormalTrack;
85 // start new thread for time-consuming part
86 new Thread(this).start();
90 * Run method using separate thread
94 // Compile list of tiles to get
95 ArrayList<SrtmTile> tileList = new ArrayList<SrtmTile>();
96 boolean hasZeroAltitudePoints = false;
97 boolean hasNonZeroAltitudePoints = false;
98 // First, loop to see what kind of points we have
99 for (int i = 0; i < _track.getNumPoints(); i++)
101 if (_track.getPoint(i).hasAltitude())
103 if (_track.getPoint(i).getAltitude().getValue() == 0) {
104 hasZeroAltitudePoints = true;
107 hasNonZeroAltitudePoints = true;
111 // Should we overwrite the zero altitude values?
112 boolean overwriteZeros = hasZeroAltitudePoints && !hasNonZeroAltitudePoints;
113 // If non-zero values present as well, ask user whether to overwrite the zeros or not
114 if (hasNonZeroAltitudePoints && hasZeroAltitudePoints && JOptionPane.showConfirmDialog(_parentFrame,
115 I18nManager.getText("dialog.lookupsrtm.overwritezeros"), I18nManager.getText(getNameKey()),
116 JOptionPane.YES_NO_OPTION) == JOptionPane.YES_OPTION)
118 overwriteZeros = true;
121 // Now loop again to extract the required tiles
122 for (int i = 0; i < _track.getNumPoints(); i++)
124 // Consider points which don't have altitudes or have zero values
125 if (needsAltitude(_track.getPoint(i), overwriteZeros))
127 SrtmTile tile = new SrtmTile(_track.getPoint(i));
128 boolean alreadyGot = false;
129 for (int t = 0; t < tileList.size(); t++)
131 if (tileList.get(t).equals(tile)) {
135 if (!alreadyGot) {tileList.add(tile);}
138 lookupValues(tileList, overwriteZeros);
144 * true if we need to set the altitude of this point
146 private boolean needsAltitude(DataPoint point, boolean overwriteZeros)
148 if (!point.hasAltitude())
152 if (overwriteZeros && point.getAltitude().getValue() == 0)
160 * Lookup the values from SRTM data
161 * @param inTileList list of tiles to get
162 * @param inOverwriteZeros true to overwrite zero altitude values
164 private void lookupValues(ArrayList<SrtmTile> inTileList, boolean inOverwriteZeros)
166 UndoLookupSrtm undo = new UndoLookupSrtm(_app.getTrackInfo());
167 int numAltitudesFound = 0;
168 // Update progress bar
169 if (_progress != null)
171 _progress.setMaximum(inTileList.size());
172 _progress.setValue(0);
174 String errorMessage = "";
175 for (int t=0; t<inTileList.size() && !_progress.isCancelled(); t++)
177 SrtmTile tile = inTileList.get(t);
178 SrtmSource srtmSource = tile.findBestCachedSource();
180 if (srtmSource == null)
182 errorMessage += "Tile "+tile.getTileName()+" not in cache!\n";
187 _progress.setValue(t);
191 heights = srtmSource.getTileHeights(tile);
193 catch (SrtmSourceException e)
195 errorMessage += e.getMessage();
199 int rowSize = srtmSource.getRowSize(tile);
202 errorMessage += "Tile "+tile.getTileName()+" is corrupted";
206 numAltitudesFound += applySrtmTileToWholeTrack(tile, heights, rowSize, inOverwriteZeros);
208 catch (SrtmSourceException e)
210 errorMessage += e.getMessage();
216 if (_progress.isCancelled()) {
220 if (! errorMessage.equals("")) {
221 _app.showErrorMessageNoLookup(getNameKey(), errorMessage);
224 if (numAltitudesFound > 0)
226 // Inform app including undo information
227 _track.requestRescale();
228 UpdateMessageBroker.informSubscribers(DataSubscriber.DATA_ADDED_OR_REMOVED);
229 // Don't update app if we're doing another track
232 _app.completeFunction(undo,
233 I18nManager.getTextWithNumber("confirm.lookupsrtm", numAltitudesFound));
236 else if (inTileList.size() > 0) {
237 _app.showErrorMessage(getNameKey(), "error.lookupsrtm.nonefound");
240 _app.showErrorMessage(getNameKey(), "error.lookupsrtm.nonerequired");
245 * Given the height data read in from file, apply the given tile to all points
246 * in the track with missing altitude
247 * @param inTile tile being applied
248 * @param inHeights height data read in from file
249 * @param inOverwriteZeros true to overwrite zero altitude values
250 * @return number of altitudes found
252 private int applySrtmTileToWholeTrack(SrtmTile inTile, int[] inHeights, int inRowSize, boolean inOverwriteZeros)
253 throws SrtmSourceException
255 int numAltitudesFound = 0;
256 // Loop over all points in track, try to apply altitude from array
257 for (int p = 0; p < _track.getNumPoints(); p++)
259 DataPoint point = _track.getPoint(p);
260 if (needsAltitude(point, inOverwriteZeros))
262 if (new SrtmTile(point).equals(inTile))
264 double x = (point.getLongitude().getDouble() - inTile.getLongitude()) * (inRowSize - 1);
265 double y = inRowSize - (point.getLatitude().getDouble() - inTile.getLatitude()) * (inRowSize - 1);
266 int idx1 = ((int)y)*inRowSize + (int)x;
269 int[] fouralts = {inHeights[idx1], inHeights[idx1+1], inHeights[idx1-inRowSize], inHeights[idx1-inRowSize+1]};
270 int numVoids = (fouralts[0]==VOID_VAL?1:0) + (fouralts[1]==VOID_VAL?1:0)
271 + (fouralts[2]==VOID_VAL?1:0) + (fouralts[3]==VOID_VAL?1:0);
272 // if (numVoids > 0) System.out.println(numVoids + " voids found");
273 double altitude = 0.0;
276 case 0: altitude = bilinearInterpolate(fouralts, x, y); break;
277 case 1: altitude = bilinearInterpolate(fixVoid(fouralts), x, y); break;
279 case 3: altitude = averageNonVoid(fouralts); break;
280 default: altitude = VOID_VAL;
282 // Special case for terrain tracks, don't interpolate voids yet
283 if (!_normalTrack && numVoids > 0) {
286 if (altitude != VOID_VAL)
288 point.setFieldValue(Field.ALTITUDE, ""+altitude, false);
289 // depending on settings, this value may have been added as feet, we need to force metres
290 point.getAltitude().reset(new Altitude((int)altitude, UnitSetLibrary.UNITS_METRES));
294 catch (ArrayIndexOutOfBoundsException obe) {
295 throw new SrtmSourceException("Point not in tile? lat=" + point.getLatitude().getDouble() + ", x=" + x + ", y=" + y + ", idx=" + idx1+"\n");
300 return numAltitudesFound;
304 * Perform a bilinear interpolation on the given altitude array
305 * @param inAltitudes array of four altitude values on corners of square (bl, br, tl, tr)
306 * @param inX x coordinate
307 * @param inY y coordinate
308 * @return interpolated altitude
310 private static double bilinearInterpolate(int[] inAltitudes, double inX, double inY)
312 double alpha = inX - (int) inX;
313 double beta = 1 - (inY - (int) inY);
314 double alt = (1-alpha)*(1-beta)*inAltitudes[0] + alpha*(1-beta)*inAltitudes[1]
315 + (1-alpha)*beta*inAltitudes[2] + alpha*beta*inAltitudes[3];
320 * Fix a single void in the given array by replacing it with the average of the others
321 * @param inAltitudes array of altitudes containing one void
322 * @return fixed array without voids
324 private static int[] fixVoid(int[] inAltitudes)
326 int[] fixed = new int[inAltitudes.length];
327 for (int i = 0; i < inAltitudes.length; i++)
329 if (inAltitudes[i] == VOID_VAL) {
330 fixed[i] = (int) Math.round(averageNonVoid(inAltitudes));
333 fixed[i] = inAltitudes[i];
340 * Calculate the average of the non-void altitudes in the given array
341 * @param inAltitudes array of altitudes with one or more voids
342 * @return average of non-void altitudes
344 private static final double averageNonVoid(int[] inAltitudes)
346 double totalAltitude = 0.0;
348 for (int i = 0; i < inAltitudes.length; i++)
350 if (inAltitudes[i] != VOID_VAL)
352 totalAltitude += inAltitudes[i];
356 if (numAlts < 1) {return VOID_VAL;}
357 return totalAltitude / numAlts;
361 * @return true if a thread is currently running
363 public boolean isRunning()