Line data Source code
1 : /****************************************************************************/
2 : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 : // Copyright (C) 2005-2024 German Aerospace Center (DLR) and others.
4 : // This program and the accompanying materials are made available under the
5 : // terms of the Eclipse Public License 2.0 which is available at
6 : // https://www.eclipse.org/legal/epl-2.0/
7 : // This Source Code may also be made available under the following Secondary
8 : // Licenses when the conditions for such availability set forth in the Eclipse
9 : // Public License 2.0 are satisfied: GNU General Public License, version 2
10 : // or later which is available at
11 : // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 : // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 : /****************************************************************************/
14 : /// @file polyconvert_main.cpp
15 : /// @author Daniel Krajzewicz
16 : /// @author Jakob Erdmann
17 : /// @author Christoph Sommer
18 : /// @author Michael Behrisch
19 : /// @author Melanie Knocke
20 : /// @date Mon, 05 Dec 2005
21 : ///
22 : // Main for POLYCONVERT
23 : /****************************************************************************/
24 : #include <config.h>
25 :
26 : #ifdef HAVE_VERSION_H
27 : #include <version.h>
28 : #endif
29 :
30 : #include <iostream>
31 : #include <string>
32 : #include <utils/options/OptionsIO.h>
33 : #include <utils/options/OptionsCont.h>
34 : #include <utils/common/UtilExceptions.h>
35 : #include <utils/common/StringTokenizer.h>
36 : #include <utils/common/SystemFrame.h>
37 : #include <utils/common/MsgHandler.h>
38 : #include <utils/common/StringUtils.h>
39 : #include <utils/common/ToString.h>
40 : #include <utils/iodevices/OutputDevice.h>
41 : #include <utils/importio/LineReader.h>
42 : #include <utils/geom/GeoConvHelper.h>
43 : #include <utils/geom/GeomConvHelper.h>
44 : #include <utils/geom/Boundary.h>
45 : #include <utils/xml/SUMOSAXReader.h>
46 : #include <utils/xml/XMLSubSys.h>
47 : #include <polyconvert/PCLoaderVisum.h>
48 : #include <polyconvert/PCLoaderDlrNavteq.h>
49 : #include <polyconvert/PCLoaderXML.h>
50 : #include <polyconvert/PCLoaderOSM.h>
51 : #include <polyconvert/PCLoaderArcView.h>
52 : #include <polyconvert/PCTypeMap.h>
53 : #include <polyconvert/PCTypeDefHandler.h>
54 : #include <polyconvert/PCNetProjectionLoader.h>
55 : #include <polyconvert/pc_typemap.h>
56 :
57 :
58 : // ===========================================================================
59 : // method definitions
60 : // ===========================================================================
61 : void
62 53 : fillOptions() {
63 53 : OptionsCont& oc = OptionsCont::getOptions();
64 106 : oc.addCallExample("-c <CONFIGURATION>", "run with configuration options set in file");
65 :
66 : // insert options sub-topics
67 53 : SystemFrame::addConfigurationOptions(oc); // fill this subtopic, too
68 53 : oc.addOptionSubTopic("Input");
69 53 : oc.addOptionSubTopic("Output");
70 53 : GeoConvHelper::addProjectionOptions(oc);
71 53 : oc.addOptionSubTopic("Pruning");
72 53 : oc.addOptionSubTopic("Processing");
73 53 : oc.addOptionSubTopic("Building Defaults");
74 :
75 :
76 : // register options
77 : // add i/o options
78 : // original network
79 106 : oc.doRegister("net-file", 'n', new Option_FileName());
80 106 : oc.addSynonyme("net-file", "net");
81 106 : oc.addDescription("net-file", "Input", TL("Loads SUMO-network FILE as reference to offset and projection"));
82 :
83 : // dlrnavteq import
84 106 : oc.doRegister("dlr-navteq-poly-files", new Option_FileName());
85 106 : oc.addDescription("dlr-navteq-poly-files", "Input", TL("Reads polygons from FILE assuming they're coded in DLR-Navteq (Elmar)-format"));
86 106 : oc.doRegister("dlr-navteq-poi-files", new Option_FileName());
87 106 : oc.addDescription("dlr-navteq-poi-files", "Input", TL("Reads pois from FILE assuming they're coded in DLR-Navteq (Elmar)-format"));
88 :
89 : // visum import
90 106 : oc.doRegister("visum-files", new Option_FileName());
91 106 : oc.addSynonyme("visum-files", "visum");
92 106 : oc.addDescription("visum-files", "Input", TL("Reads polygons from FILE assuming it's a Visum-net"));
93 :
94 106 : oc.doRegister("visum.language-file", new Option_FileName());
95 106 : oc.addDescription("visum.language-file", "Input", TL("Load language mappings from FILE"));
96 :
97 : // xml import
98 106 : oc.doRegister("xml-files", new Option_FileName());
99 106 : oc.addSynonyme("xml-files", "xml");
100 106 : oc.addDescription("xml-files", "Input", TL("Reads pois and shapes from FILE assuming they're coded in XML"));
101 :
102 : // osm import
103 106 : oc.doRegister("osm-files", new Option_FileName());
104 106 : oc.addSynonyme("osm-files", "osm");
105 106 : oc.addDescription("osm-files", "Input", TL("Reads pois from FILE assuming they're coded in OSM"));
106 53 : oc.doRegister("osm.keep-full-type", new Option_Bool(false));
107 106 : oc.addDescription("osm.keep-full-type", "Input", TL("The type will be made of the key-value - pair"));
108 53 : oc.doRegister("osm.use-name", new Option_Bool(false));
109 106 : oc.addDescription("osm.use-name", "Input", TL("The id will be set from the given 'name' attribute"));
110 53 : oc.doRegister("osm.merge-relations", new Option_Float(-1));
111 106 : oc.addDescription("osm.merge-relations", "Input", TL("If FLOAT >= 0, assemble one polygon from all ways of a relation if they all connect with gaps below FLOAT"));
112 :
113 : // arcview import
114 106 : oc.doRegister("shapefile-prefixes", new Option_FileName());
115 106 : oc.addSynonyme("shapefile-prefixes", "shapefile-prefix");
116 106 : oc.addSynonyme("shapefile-prefixes", "shapefile");
117 106 : oc.addSynonyme("shapefile-prefixes", "shape-files", true);
118 106 : oc.addDescription("shapefile-prefixes", "Input", TL("Reads shapes from shapefiles FILE"));
119 :
120 53 : oc.doRegister("shapefile.guess-projection", new Option_Bool(false));
121 106 : oc.addSynonyme("shapefile.guess-projection", "arcview.guess-projection", true);
122 106 : oc.addDescription("shapefile.guess-projection", "Input", TL("Guesses the shapefile's projection"));
123 :
124 53 : oc.doRegister("shapefile.traditional-axis-mapping", new Option_Bool(false));
125 106 : oc.addDescription("shapefile.traditional-axis-mapping", "Input", TL("Use traditional axis order (lon, lat)"));
126 :
127 106 : oc.doRegister("shapefile.id-column", new Option_String());
128 106 : oc.addSynonyme("shapefile.id-column", "shapefile.id-name", true);
129 106 : oc.addSynonyme("shapefile.id-column", "shape-files.id-name", true);
130 106 : oc.addDescription("shapefile.id-column", "Input", TL("Defines in which column the id can be found"));
131 :
132 106 : oc.doRegister("shapefile.type-columns", new Option_StringVector());
133 106 : oc.addSynonyme("shapefile.type-columns", "shapefile.type-column");
134 106 : oc.addDescription("shapefile.type-columns", "Input", TL("Defines which columns form the type id (comma separated list)"));
135 :
136 53 : oc.doRegister("shapefile.use-running-id", new Option_Bool(false));
137 106 : oc.addDescription("shapefile.use-running-id", "Input", TL("A running number will be used as id"));
138 :
139 53 : oc.doRegister("shapefile.add-param", new Option_Bool(false));
140 106 : oc.addDescription("shapefile.add-param", "Input", TL("Extract all additional columns as params"));
141 :
142 106 : oc.doRegister("shapefile.fill", new Option_String());
143 106 : oc.addDescription("shapefile.fill", "Input", TL("[auto|true|false]. Forces the 'fill' status to the given value. Default 'auto' tries to determine it from the data type"));
144 :
145 : // typemap reading
146 106 : oc.doRegister("type-file", new Option_FileName());
147 106 : oc.addSynonyme("type-file", "typemap", true);
148 106 : oc.addDescription("type-file", "Input", TL("Reads types from FILE"));
149 :
150 : // need to do this here to be able to check for network and route input options
151 53 : SystemFrame::addReportOptions(oc);
152 :
153 : // output
154 106 : oc.doRegister("output-file", 'o', new Option_FileName());
155 106 : oc.addSynonyme("output-file", "output");
156 106 : oc.addDescription("output-file", "Output", TL("Write generated polygons/pois to FILE"));
157 :
158 106 : oc.doRegister("dlr-tdp-output", new Option_FileName());
159 106 : oc.addDescription("dlr-tdp-output", "Output", TL("Write generated polygons/pois to a dlr-tdp file with the given prefix"));
160 :
161 :
162 : // pruning options
163 53 : oc.doRegister("prune.in-net", new Option_Bool(false));
164 106 : oc.addSynonyme("prune.in-net", "prune.on-net", true);
165 106 : oc.addDescription("prune.in-net", TL("Pruning"), TL("Enables pruning on net boundaries"));
166 :
167 106 : oc.doRegister("prune.in-net.offsets", new Option_String("0,0,0,0"));
168 106 : oc.addSynonyme("prune.in-net.offsets", "prune.on-net.offsets", true);
169 106 : oc.addDescription("prune.in-net.offsets", TL("Pruning"), TL("Uses FLOAT,FLOAT,FLOAT,FLOAT as offset definition added to the net boundary. Positive values grow the boundary on all sides while negative values shrink it."));
170 :
171 106 : oc.doRegister("prune.boundary", new Option_String());
172 106 : oc.addDescription("prune.boundary", TL("Pruning"), TL("Uses STR as pruning boundary"));
173 :
174 106 : oc.doRegister("prune.keep-list", new Option_String());
175 106 : oc.addSynonyme("prune.keep-list", "prune.keep");
176 106 : oc.addSynonyme("prune.keep-list", "prune.ignore", true);
177 106 : oc.addDescription("prune.keep-list", TL("Pruning"), TL("Items in STR will be kept though out of boundary"));
178 :
179 159 : oc.doRegister("prune.explicit", new Option_StringVector(StringVector({ "" })));
180 106 : oc.addSynonyme("prune.explicit", "remove");
181 106 : oc.addDescription("prune.explicit", TL("Pruning"), TL("Items with names in STR[] will be removed"));
182 :
183 :
184 53 : oc.doRegister("offset.x", new Option_Float(0));
185 106 : oc.addSynonyme("offset.x", "x-offset-to-apply", true);
186 106 : oc.addDescription("offset.x", "Processing", TL("Adds FLOAT to net x-positions"));
187 :
188 53 : oc.doRegister("offset.y", new Option_Float(0));
189 106 : oc.addSynonyme("offset.y", "y-offset-to-apply", true);
190 106 : oc.addDescription("offset.y", "Processing", TL("Adds FLOAT to net y-positions"));
191 :
192 53 : oc.doRegister("offset.z", new Option_Float(0));
193 106 : oc.addDescription("offset.z", "Processing", TL("Adds FLOAT to net z-positions"));
194 :
195 53 : oc.doRegister("all-attributes", new Option_Bool(false));
196 106 : oc.addDescription("all-attributes", "Processing", TL("Imports all attributes as key/value pairs"));
197 :
198 53 : oc.doRegister("ignore-errors", new Option_Bool(false));
199 106 : oc.addDescription("ignore-errors", "Processing", TL("Continue on broken input"));
200 :
201 53 : oc.doRegister("poi-layer-offset", new Option_Float(0));
202 106 : oc.addDescription("poi-layer-offset", "Processing", TL("Adds FLOAT to the layer value for each poi (i.e. to raise it above polygons)"));
203 :
204 : // building defaults options
205 106 : oc.doRegister("color", new Option_String("0.2,0.5,1."));
206 159 : oc.addDescription("color", "Building Defaults", TL("Sets STR as default color"));
207 :
208 106 : oc.doRegister("prefix", new Option_String(""));
209 159 : oc.addDescription("prefix", "Building Defaults", TL("Sets STR as default prefix"));
210 :
211 106 : oc.doRegister("type", new Option_String("unknown"));
212 159 : oc.addDescription("type", "Building Defaults", TL("Sets STR as default type"));
213 :
214 53 : oc.doRegister("fill", new Option_Bool(true));
215 159 : oc.addDescription("fill", "Building Defaults", TL("Fills polygons by default"));
216 :
217 106 : oc.doRegister("icon", new Option_String(SUMOXMLDefinitions::POIIcons.getString(POIIcon::NONE)));
218 159 : oc.addDescription("icon", "Building Defaults", TL("Sets STR as default icon"));
219 :
220 53 : oc.doRegister("layer", new Option_Float(-1));
221 159 : oc.addDescription("layer", "Building Defaults", TL("Sets FLOAT as default layer"));
222 :
223 53 : oc.doRegister("discard", new Option_Bool(false));
224 159 : oc.addDescription("discard", "Building Defaults", TL("Sets default action to discard"));
225 :
226 : // projection
227 53 : oc.doRegister("proj.plain-geo", new Option_Bool(false));
228 106 : oc.addDescription("proj.plain-geo", "Projection", TL("Write geo coordinates in output"));
229 53 : }
230 :
231 :
232 : int
233 53 : main(int argc, char** argv) {
234 53 : OptionsCont& oc = OptionsCont::getOptions();
235 53 : oc.setApplicationDescription(TL("Importer of polygons and POIs for the microscopic, multi-modal traffic simulation SUMO."));
236 106 : oc.setApplicationName("polyconvert", "Eclipse SUMO polyconvert Version " VERSION_STRING);
237 : int ret = 0;
238 : try {
239 : // initialise subsystems
240 53 : XMLSubSys::init();
241 53 : fillOptions();
242 53 : OptionsIO::setArgs(argc, argv);
243 53 : OptionsIO::getOptions();
244 53 : if (oc.processMetaOptions(argc < 2)) {
245 8 : SystemFrame::close();
246 8 : return 0;
247 : }
248 45 : SystemFrame::checkOptions(oc);
249 135 : XMLSubSys::setValidation(oc.getString("xml-validation"), oc.getString("xml-validation.net"), "never");
250 90 : if (oc.isDefault("aggregate-warnings")) {
251 90 : oc.setDefault("aggregate-warnings", "5");
252 : }
253 45 : MsgHandler::initOutputOptions();
254 : // build the projection
255 45 : double scale = 1.0;
256 137 : if ((oc.isSet("dlr-navteq-poly-files") || oc.isSet("dlr-navteq-poi-files")) && oc.isDefault("proj.scale")) {
257 6 : scale = 1e-5;
258 : }
259 90 : if (!oc.isSet("net")) {
260 : // from the given options
261 : #ifdef PROJ_API_FILE
262 32 : const int numProjections = oc.getBool("simple-projection") + oc.getBool("proj.utm") + oc.getBool("proj.dhdn") + (oc.getString("proj").length() > 1);
263 75 : if ((oc.isSet("osm-files") || oc.isSet("dlr-navteq-poly-files") || oc.isSet("dlr-navteq-poi-files") || oc.isSet("shapefile-prefixes")) && numProjections == 0) {
264 : // input is lon,lat and projecting it to UTM ensures accurate handling of geometry
265 42 : oc.set("proj.utm", "true");
266 42 : if (oc.isDefault("proj.plain-geo")) {
267 : // without reference to a network, raw UTM isn't helpful so we better write the data out as lon,lat
268 40 : oc.set("proj.plain-geo", "true");
269 : }
270 : }
271 64 : if (oc.isDefault("proj.scale")) {
272 64 : oc.set("proj.scale", toString(scale, 5));
273 : }
274 : #endif
275 32 : if (!GeoConvHelper::init(oc)) {
276 0 : throw ProcessError(TL("Could not build projection!"));
277 : }
278 : } else {
279 : // from the supplied network
280 : // @todo warn about given options being ignored
281 26 : PCNetProjectionLoader::load(oc.getString("net"), scale);
282 : }
283 45 : Boundary pruningBoundary = GeoConvHelper::getFinal().getConvBoundary();
284 : // check whether the input shall be pruned
285 : bool prune = false;
286 90 : if (oc.getBool("prune.in-net")) {
287 2 : if (!oc.isSet("net")) {
288 0 : throw ProcessError(TL("In order to prune the input on the net, you have to supply a network."));
289 : }
290 1 : bool ok = true;
291 : // !!! no proper error handling
292 : Boundary offsets = GeomConvHelper::parseBoundaryReporting(
293 3 : oc.getString("prune.in-net.offsets"), "--prune.on-net.offsets", nullptr, ok, true, true);
294 1 : pruningBoundary.setOffsets(
295 1 : pruningBoundary.xmin() - offsets.xmin(),
296 1 : pruningBoundary.ymin() - offsets.ymin(),
297 1 : pruningBoundary.xmax() + offsets.xmax(),
298 1 : pruningBoundary.ymax() + offsets.ymax());
299 : prune = true;
300 1 : }
301 90 : if (oc.isSet("prune.boundary")) {
302 0 : bool ok = true;
303 : // !!! no proper error handling
304 0 : pruningBoundary = GeomConvHelper::parseBoundaryReporting(oc.getString("prune.boundary"), "--prune.boundary", nullptr, ok);
305 : prune = true;
306 : }
307 70 : if (oc.isSet("osm-files") && oc.isDefault("poi-layer-offset")) {
308 50 : oc.setDefault("poi-layer-offset", "5"); // sufficient when using the default typemap
309 : }
310 :
311 45 : PCPolyContainer toFill(prune, pruningBoundary, oc.getStringVector("remove"));
312 :
313 : // read in the type defaults
314 90 : if (!oc.isSet("type-file")) {
315 38 : const char* sumoPath = std::getenv("SUMO_HOME");
316 38 : if (sumoPath == nullptr) {
317 0 : WRITE_WARNING(TL("Environment variable SUMO_HOME is not set, using built in type maps."));
318 : } else {
319 38 : const std::string path = sumoPath + std::string("/data/typemap/");
320 76 : if (oc.isSet("dlr-navteq-poly-files")) {
321 12 : oc.setDefault("type-file", path + "navteqPolyconvert.typ.xml");
322 : }
323 76 : if (oc.isSet("osm-files")) {
324 54 : oc.setDefault("type-file", path + "osmPolyconvert.typ.xml");
325 : }
326 76 : if (oc.isSet("visum-files")) {
327 0 : oc.setDefault("type-file", path + "visumPolyconvert.typ.xml");
328 : }
329 : }
330 : }
331 45 : PCTypeMap tm(oc);
332 45 : PCTypeDefHandler handler(oc, tm);
333 90 : if (oc.isSet("type-file")) {
334 58 : if (!XMLSubSys::runParser(handler, oc.getString("type-file"))) {
335 : // something failed
336 0 : throw ProcessError();
337 : }
338 : } else {
339 16 : handler.setFileName("built in type map");
340 16 : SUMOSAXReader* reader = XMLSubSys::getSAXReader(handler);
341 32 : if (oc.isSet("dlr-navteq-poly-files")) {
342 0 : reader->parseString(navteqTypemap);
343 : }
344 32 : if (oc.isSet("osm-files")) {
345 0 : reader->parseString(osmTypemap);
346 : }
347 32 : if (oc.isSet("visum-files")) {
348 0 : reader->parseString(visumTypemap);
349 : }
350 16 : delete reader;
351 : }
352 : // read in the data
353 45 : PCLoaderXML::loadIfSet(oc, toFill, tm); // SUMO-XML
354 44 : PCLoaderOSM::loadIfSet(oc, toFill, tm); // OSM-XML
355 43 : PCLoaderDlrNavteq::loadIfSet(oc, toFill, tm); // Elmar-files
356 43 : PCLoaderVisum::loadIfSet(oc, toFill, tm); // VISUM
357 43 : PCLoaderArcView::loadIfSet(oc, toFill, tm); // shape-files
358 43 : GeoConvHelper::computeFinal();
359 : // error processing
360 44 : if (MsgHandler::getErrorInstance()->wasInformed() && !oc.getBool("ignore-errors")) {
361 1 : throw ProcessError();
362 : }
363 : // output
364 44 : if (!oc.isSet("output-file") && !oc.isSet("dlr-tdp-output")) {
365 0 : std::string out = "polygons.xml";
366 0 : if (oc.isSet("configuration-file")) {
367 0 : out = FileHelpers::getConfigurationRelative(oc.getString("configuration-file"), out);
368 : }
369 0 : oc.setDefault("output-file", out);
370 : }
371 84 : if (oc.isSet("output-file")) {
372 82 : toFill.save(oc.getString("output-file"), oc.getBool("proj.plain-geo"));
373 : }
374 84 : if (oc.isSet("dlr-tdp-output")) {
375 2 : toFill.saveDlrTDP(oc.getString("dlr-tdp-output"));
376 : }
377 :
378 57 : } catch (const ProcessError& e) {
379 3 : if (std::string(e.what()) != std::string("Process Error") && std::string(e.what()) != std::string("")) {
380 0 : WRITE_ERROR(e.what());
381 : }
382 3 : MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
383 : ret = 1;
384 : #ifndef _DEBUG
385 3 : } catch (const std::exception& e) {
386 0 : if (std::string(e.what()) != std::string("")) {
387 0 : WRITE_ERROR(e.what());
388 : }
389 0 : MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
390 : ret = 1;
391 0 : } catch (...) {
392 0 : MsgHandler::getErrorInstance()->inform("Quitting (on unknown error).", false);
393 : ret = 1;
394 : #endif
395 0 : }
396 45 : SystemFrame::close();
397 : // report about ending
398 : if (ret == 0) {
399 : std::cout << "Success." << std::endl;
400 : }
401 : return ret;
402 : }
403 :
404 :
405 : /****************************************************************************/
|