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>();
97 // Now loop again to extract the required tiles
98 for (int i = 0; i < _track.getNumPoints(); i++)
100 SrtmTile tile = new SrtmTile(_track.getPoint(i));
101 boolean alreadyGot = false;
102 for (int t = 0; t < tileList.size(); t++)
104 if (tileList.get(t).equals(tile)) {
108 if (!alreadyGot) {tileList.add(tile);}
110 lookupValues(tileList);
116 * Lookup the values from SRTM data
117 * @param inTileList list of tiles to get
118 * @param inOverwriteZeros true to overwrite zero altitude values
120 private void lookupValues(ArrayList<SrtmTile> inTileList)
122 UndoLookupSrtm undo = new UndoLookupSrtm(_app.getTrackInfo());
123 int numAltitudesFound = 0;
124 // Update progress bar
125 if (_progress != null)
127 _progress.setMaximum(inTileList.size());
128 _progress.setValue(0);
130 String errorMessage = "";
131 for (int t=0; t<inTileList.size() && !_progress.isCancelled(); t++)
133 SrtmTile tile = inTileList.get(t);
134 SrtmSource srtmSource = tile.findBestCachedSource();
136 if (srtmSource == null)
138 errorMessage += "Tile "+tile.getTileName()+" not in cache!\n";
143 _progress.setValue(t);
147 heights = srtmSource.getTileHeights(tile);
149 catch (SrtmSourceException e)
151 errorMessage += e.getMessage();
155 int rowSize = srtmSource.getRowSize(tile);
158 errorMessage += "Tile "+tile.getTileName()+" is corrupted";
161 numAltitudesFound += applySrtmTimeToWholeTrack(tile, heights, rowSize);
165 if (_progress.isCancelled()) {
169 if (! errorMessage.equals("")) {
170 _app.showErrorMessageNoLookup(getNameKey(), errorMessage);
173 if (numAltitudesFound > 0)
175 // Inform app including undo information
176 _track.requestRescale();
177 UpdateMessageBroker.informSubscribers(DataSubscriber.DATA_ADDED_OR_REMOVED);
178 // Don't update app if we're doing another track
181 _app.completeFunction(undo,
182 I18nManager.getTextWithNumber("confirm.lookupsrtm", numAltitudesFound));
185 else if (inTileList.size() > 0) {
186 _app.showErrorMessage(getNameKey(), "error.lookupsrtm.nonefound");
189 _app.showErrorMessage(getNameKey(), "error.lookupsrtm.nonerequired");
194 * Given the height data read in from file, apply the given tile to all points
195 * in the track with missing altitude
196 * @param inTile tile being applied
197 * @param inHeights height data read in from file
198 * @return number of altitudes found
200 private int applySrtmTimeToWholeTrack(SrtmTile inTile, int[] inHeights, int inRowSize)
202 int numAltitudesFound = 0;
203 // Loop over all points in track, try to apply altitude from array
204 for (int p = 0; p < _track.getNumPoints(); p++)
206 DataPoint point = _track.getPoint(p);
207 if (new SrtmTile(point).equals(inTile))
209 double x = (point.getLongitude().getDouble() - inTile.getLongitude()) * (inRowSize - 1);
210 double y = inRowSize - (point.getLatitude().getDouble() - inTile.getLatitude()) * (inRowSize - 1);
211 int idx1 = ((int)y)*inRowSize + (int)x;
214 int[] fouralts = {inHeights[idx1], inHeights[idx1+1], inHeights[idx1-inRowSize], inHeights[idx1-inRowSize+1]};
215 int numVoids = (fouralts[0]==VOID_VAL?1:0) + (fouralts[1]==VOID_VAL?1:0)
216 + (fouralts[2]==VOID_VAL?1:0) + (fouralts[3]==VOID_VAL?1:0);
217 // if (numVoids > 0) System.out.println(numVoids + " voids found");
218 double altitude = 0.0;
221 case 0: altitude = bilinearInterpolate(fouralts, x, y); break;
222 case 1: altitude = bilinearInterpolate(fixVoid(fouralts), x, y); break;
224 case 3: altitude = averageNonVoid(fouralts); break;
225 default: altitude = VOID_VAL;
227 // Special case for terrain tracks, don't interpolate voids yet
228 if (!_normalTrack && numVoids > 0) {
231 if (altitude != VOID_VAL)
233 point.setFieldValue(Field.ALTITUDE, ""+altitude, false);
234 // depending on settings, this value may have been added as feet, we need to force metres
235 point.getAltitude().reset(new Altitude((int)altitude, UnitSetLibrary.UNITS_METRES));
239 catch (ArrayIndexOutOfBoundsException obe) {
240 System.err.println("Point not in tile? lat=" + point.getLatitude().getDouble() + ", x=" + x + ", y=" + y + ", idx=" + idx1+"\n");
244 return numAltitudesFound;
248 * Perform a bilinear interpolation on the given altitude array
249 * @param inAltitudes array of four altitude values on corners of square (bl, br, tl, tr)
250 * @param inX x coordinate
251 * @param inY y coordinate
252 * @return interpolated altitude
254 private static double bilinearInterpolate(int[] inAltitudes, double inX, double inY)
256 double alpha = inX - (int) inX;
257 double beta = 1 - (inY - (int) inY);
258 double alt = (1-alpha)*(1-beta)*inAltitudes[0] + alpha*(1-beta)*inAltitudes[1]
259 + (1-alpha)*beta*inAltitudes[2] + alpha*beta*inAltitudes[3];
264 * Fix a single void in the given array by replacing it with the average of the others
265 * @param inAltitudes array of altitudes containing one void
266 * @return fixed array without voids
268 private static int[] fixVoid(int[] inAltitudes)
270 int[] fixed = new int[inAltitudes.length];
271 for (int i = 0; i < inAltitudes.length; i++)
273 if (inAltitudes[i] == VOID_VAL) {
274 fixed[i] = (int) Math.round(averageNonVoid(inAltitudes));
277 fixed[i] = inAltitudes[i];
284 * Calculate the average of the non-void altitudes in the given array
285 * @param inAltitudes array of altitudes with one or more voids
286 * @return average of non-void altitudes
288 private static final double averageNonVoid(int[] inAltitudes)
290 double totalAltitude = 0.0;
292 for (int i = 0; i < inAltitudes.length; i++)
294 if (inAltitudes[i] != VOID_VAL)
296 totalAltitude += inAltitudes[i];
300 if (numAlts < 1) {return VOID_VAL;}
301 return totalAltitude / numAlts;
305 * @return true if a thread is currently running
307 public boolean isRunning()