source: josm/trunk/src/org/openstreetmap/josm/data/projection/Projections.java@ 9799

Last change on this file since 9799 was 9799, checked in by stoecker, 9 years ago

fix Coverity issues 1349911, 1349912, 1349913, 1349917, 1349918, 1349919, 1349922, 1349923
  • Property svn:eol-style set to native
File size: 15.2 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.data.projection;
3
4import java.io.BufferedReader;
5import java.io.IOException;
6import java.io.InputStream;
7import java.io.InputStreamReader;
8import java.nio.charset.StandardCharsets;
9import java.util.ArrayList;
10import java.util.Collection;
11import java.util.Collections;
12import java.util.HashMap;
13import java.util.HashSet;
14import java.util.LinkedHashMap;
15import java.util.List;
16import java.util.Locale;
17import java.util.Map;
18import java.util.Set;
19import java.util.regex.Matcher;
20import java.util.regex.Pattern;
21
22import org.openstreetmap.josm.Main;
23import org.openstreetmap.josm.data.coor.EastNorth;
24import org.openstreetmap.josm.data.coor.LatLon;
25import org.openstreetmap.josm.data.projection.datum.Datum;
26import org.openstreetmap.josm.data.projection.datum.GRS80Datum;
27import org.openstreetmap.josm.data.projection.datum.NTV2GridShiftFileWrapper;
28import org.openstreetmap.josm.data.projection.datum.SevenParameterDatum;
29import org.openstreetmap.josm.data.projection.datum.ThreeParameterDatum;
30import org.openstreetmap.josm.data.projection.datum.WGS84Datum;
31import org.openstreetmap.josm.data.projection.proj.AlbersEqualArea;
32import org.openstreetmap.josm.data.projection.proj.CassiniSoldner;
33import org.openstreetmap.josm.data.projection.proj.ClassProjFactory;
34import org.openstreetmap.josm.data.projection.proj.DoubleStereographic;
35import org.openstreetmap.josm.data.projection.proj.LambertAzimuthalEqualArea;
36import org.openstreetmap.josm.data.projection.proj.LambertConformalConic;
37import org.openstreetmap.josm.data.projection.proj.LonLat;
38import org.openstreetmap.josm.data.projection.proj.Mercator;
39import org.openstreetmap.josm.data.projection.proj.ObliqueMercator;
40import org.openstreetmap.josm.data.projection.proj.PolarStereographic;
41import org.openstreetmap.josm.data.projection.proj.Proj;
42import org.openstreetmap.josm.data.projection.proj.ProjFactory;
43import org.openstreetmap.josm.data.projection.proj.SwissObliqueMercator;
44import org.openstreetmap.josm.data.projection.proj.TransverseMercator;
45import org.openstreetmap.josm.gui.preferences.projection.ProjectionChoice;
46import org.openstreetmap.josm.gui.preferences.projection.ProjectionPreference;
47import org.openstreetmap.josm.io.CachedFile;
48import org.openstreetmap.josm.tools.Utils;
49
50/**
51 * Class to manage projections.
52 *
53 * Use this class to query available projection or register new projections
54 * from a plugin.
55 */
56public final class Projections {
57
58 /**
59 * Class to hold information about one projection.
60 */
61 public static class ProjectionDefinition {
62 public String code;
63 public String name;
64 public String definition;
65
66 public ProjectionDefinition(String code, String name, String definition) {
67 this.code = code;
68 this.name = name;
69 this.definition = definition;
70 }
71 }
72
73 private static final Set<String> allCodes = new HashSet<>();
74 private static final Map<String, ProjectionChoice> allProjectionChoicesByCode = new HashMap<>();
75 private static final Map<String, Projection> projectionsByCode_cache = new HashMap<>();
76
77 /*********************************
78 * Registry for custom projection
79 *
80 * should be compatible to PROJ.4
81 */
82 static final Map<String, ProjFactory> projs = new HashMap<>();
83 static final Map<String, Ellipsoid> ellipsoids = new HashMap<>();
84 static final Map<String, Datum> datums = new HashMap<>();
85 static final Map<String, NTV2GridShiftFileWrapper> nadgrids = new HashMap<>();
86 static final Map<String, ProjectionDefinition> inits;
87
88 static {
89 registerBaseProjection("aea", AlbersEqualArea.class, "core");
90 registerBaseProjection("cass", CassiniSoldner.class, "core");
91 registerBaseProjection("laea", LambertAzimuthalEqualArea.class, "core");
92 registerBaseProjection("lcc", LambertConformalConic.class, "core");
93 registerBaseProjection("lonlat", LonLat.class, "core");
94 registerBaseProjection("merc", Mercator.class, "core");
95 registerBaseProjection("omerc", ObliqueMercator.class, "core");
96 registerBaseProjection("somerc", SwissObliqueMercator.class, "core");
97 registerBaseProjection("stere", PolarStereographic.class, "core");
98 registerBaseProjection("sterea", DoubleStereographic.class, "core");
99 registerBaseProjection("tmerc", TransverseMercator.class, "core");
100
101 ellipsoids.put("airy", Ellipsoid.Airy);
102 ellipsoids.put("mod_airy", Ellipsoid.AiryMod);
103 ellipsoids.put("aust_SA", Ellipsoid.AustSA);
104 ellipsoids.put("bessel", Ellipsoid.Bessel1841);
105 ellipsoids.put("bess_nam", Ellipsoid.BesselNamibia);
106 ellipsoids.put("clrk66", Ellipsoid.Clarke1866);
107 ellipsoids.put("clrk80", Ellipsoid.Clarke1880);
108 ellipsoids.put("clrk80ign", Ellipsoid.ClarkeIGN);
109 ellipsoids.put("evrstSS", Ellipsoid.EverestSabahSarawak);
110 ellipsoids.put("intl", Ellipsoid.Hayford);
111 ellipsoids.put("helmert", Ellipsoid.Helmert);
112 ellipsoids.put("krass", Ellipsoid.Krassowsky);
113 ellipsoids.put("GRS67", Ellipsoid.GRS67);
114 ellipsoids.put("GRS80", Ellipsoid.GRS80);
115 ellipsoids.put("WGS66", Ellipsoid.WGS66);
116 ellipsoids.put("WGS72", Ellipsoid.WGS72);
117 ellipsoids.put("WGS84", Ellipsoid.WGS84);
118
119 datums.put("WGS84", WGS84Datum.INSTANCE);
120 datums.put("NAD83", GRS80Datum.INSTANCE);
121 datums.put("carthage", new ThreeParameterDatum(
122 "Carthage 1934 Tunisia", "carthage",
123 Ellipsoid.ClarkeIGN, -263.0, 6.0, 431.0));
124 datums.put("GGRS87", new ThreeParameterDatum(
125 "Greek Geodetic Reference System 1987", "GGRS87",
126 Ellipsoid.GRS80, -199.87, 74.79, 246.62));
127 datums.put("hermannskogel", new SevenParameterDatum(
128 "Hermannskogel", "hermannskogel",
129 Ellipsoid.Bessel1841, 577.326, 90.129, 463.919, 5.137, 1.474, 5.297, 2.4232));
130 datums.put("ire65", new SevenParameterDatum(
131 "Ireland 1965", "ire65",
132 Ellipsoid.AiryMod, 482.530, -130.596, 564.557, -1.042, -0.214, -0.631, 8.15));
133 datums.put("nzgd49", new SevenParameterDatum(
134 "New Zealand Geodetic Datum 1949", "nzgd49",
135 Ellipsoid.Hayford, 59.47, -5.04, 187.44, 0.47, -0.1, 1.024, -4.5993));
136 datums.put("OSGB36", new SevenParameterDatum(
137 "Airy 1830", "OSGB36",
138 Ellipsoid.Airy, 446.448, -125.157, 542.060, 0.1502, 0.2470, 0.8421, -20.4894));
139 datums.put("potsdam", new SevenParameterDatum(
140 "Potsdam Rauenberg 1950 DHDN", "potsdam",
141 Ellipsoid.Bessel1841, 598.1, 73.7, 418.2, 0.202, 0.045, -2.455, 6.7));
142
143 nadgrids.put("BETA2007.gsb", NTV2GridShiftFileWrapper.BETA2007);
144 nadgrids.put("ntf_r93_b.gsb", NTV2GridShiftFileWrapper.ntf_rgf93);
145
146 List<ProjectionDefinition> pds;
147 try {
148 pds = loadProjectionDefinitions("resource://data/projection/custom-epsg");
149 } catch (IOException ex) {
150 throw new RuntimeException(ex);
151 }
152 inits = new LinkedHashMap<>();
153 for (ProjectionDefinition pd : pds) {
154 inits.put(pd.code, pd);
155 }
156
157 for (ProjectionChoice pc : ProjectionPreference.getProjectionChoices()) {
158 for (String code : pc.allCodes()) {
159 allProjectionChoicesByCode.put(code, pc);
160 }
161 }
162 allCodes.addAll(inits.keySet());
163 allCodes.addAll(allProjectionChoicesByCode.keySet());
164 }
165
166 private Projections() {
167 // Hide default constructor for utils classes
168 }
169
170 /**
171 * Convert from lat/lon to easting/northing using the current projection.
172 *
173 * @param ll the geographical point to convert (in WGS84 lat/lon)
174 * @return the corresponding east/north coordinates
175 */
176 public static EastNorth project(LatLon ll) {
177 if (ll == null) return null;
178 return Main.getProjection().latlon2eastNorth(ll);
179 }
180
181 /**
182 * Convert from easting/norting to lat/lon using the current projection.
183 *
184 * @param en the geographical point to convert (in projected coordinates)
185 * @return the corresponding lat/lon (WGS84)
186 */
187 public static LatLon inverseProject(EastNorth en) {
188 if (en == null) return null;
189 return Main.getProjection().eastNorth2latlon(en);
190 }
191
192 /**
193 * Plugins can register additional base projections.
194 *
195 * @param id The "official" PROJ.4 id. In case the projection is not supported
196 * by PROJ.4, use some prefix, e.g. josm:myproj or gdal:otherproj.
197 * @param fac The base projection factory.
198 * @param origin Multiple plugins may implement the same base projection.
199 * Provide plugin name or similar string, so it be differentiated.
200 */
201 public static void registerBaseProjection(String id, ProjFactory fac, String origin) {
202 projs.put(id, fac);
203 }
204
205 public static void registerBaseProjection(String id, Class<? extends Proj> projClass, String origin) {
206 registerBaseProjection(id, new ClassProjFactory(projClass), origin);
207 }
208
209 /**
210 * Get a base projection by id.
211 *
212 * @param id the id, for example "lonlat" or "tmerc"
213 * @return the corresponding base projection if the id is known, null otherwise
214 */
215 public static Proj getBaseProjection(String id) {
216 ProjFactory fac = projs.get(id);
217 if (fac == null) return null;
218 return fac.createInstance();
219 }
220
221 /**
222 * Get an ellipsoid by id.
223 *
224 * @param id the id, for example "bessel" or "WGS84"
225 * @return the corresponding ellipsoid if the id is known, null otherwise
226 */
227 public static Ellipsoid getEllipsoid(String id) {
228 return ellipsoids.get(id);
229 }
230
231 /**
232 * Get a geodetic datum by id.
233 *
234 * @param id the id, for example "potsdam" or "WGS84"
235 * @return the corresponding datum if the id is known, null otherwise
236 */
237 public static Datum getDatum(String id) {
238 return datums.get(id);
239 }
240
241 /**
242 * Get a NTV2 grid database by id.
243 * @param id the id
244 * @return the corresponding NTV2 grid if the id is known, null otherwise
245 */
246 public static NTV2GridShiftFileWrapper getNTV2Grid(String id) {
247 return nadgrids.get(id);
248 }
249
250 /**
251 * Get the projection definition string for the given code.
252 * @param code the code
253 * @return the string that can be processed by #{link CustomProjection}.
254 * Null, if the code isn't supported.
255 */
256 public static String getInit(String code) {
257 ProjectionDefinition pd = inits.get(code.toUpperCase(Locale.ENGLISH));
258 if (pd == null) return null;
259 return pd.definition;
260 }
261
262 /**
263 * Load projection definitions from file.
264 *
265 * @param path the path
266 * @return projection definitions
267 * @throws IOException in case of I/O error
268 */
269 public static List<ProjectionDefinition> loadProjectionDefinitions(String path) throws IOException {
270 try (
271 CachedFile cf = new CachedFile(path);
272 InputStream in = cf.getInputStream();
273 BufferedReader r = new BufferedReader(new InputStreamReader(in, StandardCharsets.UTF_8));
274 ) {
275 return loadProjectionDefinitions(r);
276 }
277 }
278
279 /**
280 * Load projection definitions from file.
281 *
282 * @param r the reader
283 * @return projection definitions
284 * @throws IOException in case of I/O error
285 */
286 public static List<ProjectionDefinition> loadProjectionDefinitions(BufferedReader r) throws IOException {
287 List<ProjectionDefinition> result = new ArrayList<>();
288 Pattern epsgPattern = Pattern.compile("<(\\d+)>(.*)<>");
289 String line, lastline = "";
290 while ((line = r.readLine()) != null) {
291 line = line.trim();
292 if (!line.startsWith("#") && !line.isEmpty()) {
293 if (!lastline.startsWith("#")) throw new AssertionError("EPSG file seems corrupted");
294 String name = lastline.substring(1).trim();
295 Matcher m = epsgPattern.matcher(line);
296 if (m.matches()) {
297 String code = "EPSG:" + m.group(1);
298 String definition = m.group(2).trim();
299 result.add(new ProjectionDefinition(code, name, definition));
300 } else {
301 Main.warn("Failed to parse line from the EPSG projection definition: "+line);
302 }
303 }
304 lastline = line;
305 }
306 return result;
307 }
308
309 /**
310 * Get a projection by code.
311 * @param code the code, e.g. "EPSG:2026"
312 * @return the corresponding projection, if the code is known, null otherwise
313 */
314 public static Projection getProjectionByCode(String code) {
315 Projection proj = projectionsByCode_cache.get(code);
316 if (proj != null) return proj;
317 ProjectionChoice pc = allProjectionChoicesByCode.get(code);
318 if (pc != null) {
319 Collection<String> pref = pc.getPreferencesFromCode(code);
320 pc.setPreferences(pref);
321 try {
322 proj = pc.getProjection();
323 } catch (Exception e) {
324 String cause = e.getMessage();
325 Main.warn("Unable to get projection "+code+" with "+pc + (cause != null ? ". "+cause : ""));
326 }
327 }
328 if (proj == null) {
329 ProjectionDefinition pd = inits.get(code);
330 if (pd == null) return null;
331 proj = new CustomProjection(pd.name, code, pd.definition, null);
332 }
333 projectionsByCode_cache.put(code, proj);
334 return proj;
335 }
336
337 /**
338 * Get a list of all supported projection codes.
339 *
340 * @return all supported projection codes
341 * @see #getProjectionByCode(java.lang.String)
342 */
343 public static Collection<String> getAllProjectionCodes() {
344 return Collections.unmodifiableCollection(allCodes);
345 }
346
347 /**
348 * Get a list of ids of all registered base projections.
349 *
350 * @return all registered base projection ids
351 * @see #getBaseProjection(java.lang.String)
352 */
353 public static Collection<String> getAllBaseProjectionIds() {
354 return projs.keySet();
355 }
356
357 private static String listKeys(Map<String, ?> map) {
358 List<String> keys = new ArrayList<>(map.keySet());
359 Collections.sort(keys);
360 return Utils.join(", ", keys);
361 }
362
363 /**
364 * Replies the list of projections as string (comma separated).
365 * @return the list of projections as string (comma separated)
366 * @since 8533
367 */
368 public static String listProjs() {
369 return listKeys(projs);
370 }
371
372 /**
373 * Replies the list of ellipsoids as string (comma separated).
374 * @return the list of ellipsoids as string (comma separated)
375 * @since 8533
376 */
377 public static String listEllipsoids() {
378 return listKeys(ellipsoids);
379 }
380
381 /**
382 * Replies the list of datums as string (comma separated).
383 * @return the list of datums as string (comma separated)
384 * @since 8533
385 */
386 public static String listDatums() {
387 return listKeys(datums);
388 }
389
390 /**
391 * Replies the list of nadgrids as string (comma separated).
392 * @return the list of nadgrids as string (comma separated)
393 * @since 8533
394 */
395 public static String listNadgrids() {
396 return listKeys(nadgrids);
397 }
398}
Note: See TracBrowser for help on using the repository browser.