NETCONVERT

From Sumo
Revision as of 11:14, 25 September 2013 by Behrisch (talk | contribs) (From 30.000 feet)
Jump to navigation Jump to search

From 30.000 feet

NETCONVERT imports digital road networks from different sources and generates road networks that can be used by other tools from the package.

Purpose: Road networks import and conversion
System: portable (Linux/Windows is tested); runs on command line
Input (mandatory): Definition of a road network
Output: A generated SUMO-road network; optionally also other outputs
Programming Language: C++

Usage Description

NETCONVERT is a command line application. It assumes at least one parameter - the combination of the name of the file type to import as parameter name and the name of the file to import as parameter value. So, for importing a network from OpenStreetMap one could simply write:

netconvert --osm my_osm_net.xml

and for importing a VISUM-network:

netconvert --visum my_visum_net.net

In both cases, as no output name is given, the SUMO network generated from the imported data is written into the file "net.net.xml". To write the network into a different file, use the option -o <OUTPUT_FILE>. If you want to save the imported VISUM-network into a file named "my_sumo_net.net.xml", write:

netconvert --visum my_visum_net.net -o my_sumo_net.net.xml

Many further parameter steer how the network is imported and how the resulting SUMO-network is generated.

Supported Formats

NETCONVERT is able to import road networks from the following formats:

Options

You may use a XML schema definition file for setting up a NETCONVERT configuration: netconvertConfiguration.xsd.

Configuration

All applications of the SUMO-suite handle configuration options the same way. These options are discussed at Basics/Using the Command Line Applications#Configuration Files.

Option Description
-c <FILE>
--configuration-file <FILE>
Loads the named config on startup
--save-configuration <FILE> Saves current configuration into FILE
--save-template <FILE> Saves a configuration template (empty) into FILE
--save-schema <FILE> Saves the configuration schema into FILE
--save-commented <BOOL> Adds comments to saved template, configuration, or schema; default: false

Input

Option Description
-s <FILE>
--sumo-net-file <FILE>
Read SUMO-net from FILE
-n <FILE>
--node-files <FILE>
Read XML-node defs from FILE
-e <FILE>
--edge-files <FILE>
Read XML-edge defs from FILE
-x <FILE>
--connection-files <FILE>
Read XML-connection defs from FILE
-i <FILE>
--tllogic-files <FILE>
Read XML-traffic light defs from FILE
-t <FILE>
--type-files <FILE>
Read XML-type defs from FILE
--shapefile-prefix <FILE> Read shapefiles (ArcView, Tiger, ...) from files starting with 'FILE'
--dlr-navteq-prefix <FILE> Read converted Navteq GDF data (unsplitted Elmar-network) from path 'FILE'
--osm-files <FILE> Read OSM-network from path 'FILE(s)'
--opendrive-files <FILE> Read OpenDRIVE-network from FILE
--visum-file <FILE> Read VISUM-net from FILE
--vissim-file <FILE> Read VISSIM-net from FILE
--robocup-dir <FILE> Read RoboCup-net from DIR
--matsim-files <FILE> Read MATsim-net from FILE
--itsumo-files <FILE> Read ITSUMO-net from FILE

Output

Option Description
-o <FILE>
--output-file <FILE>
The generated net will be written to FILE
--plain-output-prefix <FILE> Prefix of files to write plain xml nodes, edges and connections to
--junctions.join-output <FILE> Writes information about joined junctions to FILE (can be loaded as additional node-file to reproduce joins
-M <FILE>
--map-output <FILE>
Writes joined edges information to FILE
--matsim-output <FILE> The generated net will be written to FILE using MATsim format.
--opendrive-output <FILE> The generated net will be written to FILE using OpenDRIVE format.
--dlr-navteq-output <FILE> The generated net will be written to dlr-navteq files with the given PREFIX.
--output.street-names <BOOL> Street names will be included in the output (if available); default: false
--output.original-names <BOOL> Writes original names, if given, as parameter; default: false
--street-sign-output <FILE> Writes street signs as POIs to FILE.

Projection

Option Description
--simple-projection <BOOL> Uses a simple method for projection; default: false
--proj.scale <INT> Number of places to shift decimal point to right in geo-coordinates; default: 0
--proj.utm <BOOL> Determine the UTM zone (for a universal transversal mercator projection based on the WGS84 ellipsoid); default: false
--proj.dhdn <BOOL> Determine the DHDN zone (for a transversal mercator projection based on the bessel ellipsoid); default: false
--proj <STRING> Uses STR as proj.4 definition for projection; default: !
--proj.inverse <BOOL> Inverses projection; default: false
--proj.plain-geo <BOOL> Write geo coordinates in plain-xml; default: false

TLS Building

Option Description
--tls.discard-loaded <BOOL> Does not instatiate traffic lights loaded from other formats than XML; default: false
--tls.set <STRING> Interprets STR as list of junctions to be controlled by TLS
--tls.unset <STRING> Interprets STR as list of junctions to be not controlled by TLS
--tls.guess <BOOL> Turns on TLS guessing; default: false
--tls.taz-nodes <BOOL> Sets district nodes as tls-controlled; default: false
--tls-guess.joining <BOOL> Includes node clusters into guess; default: false
--tls.join <BOOL> Tries to cluster tls-controlled nodes; default: false
--tls.green.time <INT> Use INT as green phase duration; default: 31
-D <FLOAT>
--tls.yellow.min-decel <FLOAT>
Defines smallest vehicle deceleration; default: 3
--tls.yellow.patch-small <BOOL> Given yellow times are patched even if being too short; default: false
--tls.yellow.time <INT> Set INT as fixed time for yellow phase durations
--tls.half-offset <STRING> TLSs in STR will be shifted by half-phase
--tls.quarter-offset <STRING> TLSs in STR will be shifted by quarter-phase

Ramp Guessing

Option Description
--ramps.guess <BOOL> Enable ramp-guessing; default: false
--ramps.max-ramp-speed <FLOAT> Treat edges with speed > FLOAT as no ramps; default: -1
--ramps.min-highway-speed <FLOAT> Treat edges with speed < FLOAT as no highways; default: 21.9444
--ramps.ramp-length <FLOAT> Use FLOAT as ramp-length; default: 100
--ramps.set <STRING> Tries to handle the given edges as ramps
--ramps.no-split <BOOL> Avoids edge splitting; default: false

Edge Removal

Option Description
--keep-edges.min-speed <FLOAT> Only keep edges with speed in meters/second > FLOAT
--remove-edges.explicit <STRING> Remove edges in STR
--keep-edges.explicit <STRING> Only keep edges in STR
--keep-edges.input-file <FILE> Only keep edges in FILE
--keep-edges.postload <BOOL> Remove edges after joining; default: false
--keep-edges.in-boundary <STRING> Only keep edges which are located within the given boundary (given either as CARTESIAN corner coordinates <xmin,ymin,xmax,ymax> or as polygon <x0,y0,x1,y1,...>)
--keep-edges.by-vclass <STRING> Only keep edges which allow one of the vclasss in STR
--remove-edges.by-vclass <STRING> Remove edges which allow only vclasses from STR
--keep-edges.by-type <STRING> Only keep edges where type is in STR
--remove-edges.by-type <STRING> Remove edges where type is in STR
--remove-edges.isolated <BOOL> Removes isolated edges; default: false

Unregulated Nodes

Option Description
--keep-nodes-unregulated <BOOL> All nodes will be unregulated; default: false
--keep-nodes-unregulated.explicit <STRING> Do not regulate nodes in STR
--keep-nodes-unregulated.district-nodes <BOOL> Do not regulate district nodes; default: false

Processing

Option Description
--ignore-errors <BOOL> Continue on broken input; default: false
--ignore-errors.connections <BOOL> Continue on invalid connections; default: false
--show-errors.connections-first-try <BOOL> Show errors in connections at parsing; default: false
--lanes-from-capacity.norm <FLOAT> The factor for flow to no. lanes conversion; default: 1800
--speed-in-kmh <BOOL> vmax is parsed as given in km/h (some); default: false
--plain.extend-edge-shape <BOOL> If edge shapes do not end at the node positions, extend them; default: false
--matsim.keep-length <BOOL> The edge lengths given in the MATSIM-file will be kept; default: false
--matsim.lanes-from-capacity <BOOL> The lane number will be computed from the capacity; default: false
--shapefile.street-id <STRING> Read edge ids from column STR
--shapefile.from-id <STRING> Read from-node ids from column STR
--shapefile.to-id <STRING> Read to-node ids from column STR
--shapefile.type-id <STRING> Read type ids from column STR
--shapefile.use-defaults-on-failure <BOOL> Uses edge type defaults on problems; default: false
--shapefile.all-bidirectional <BOOL> Insert edges in both directions; default: false
--shapefile.guess-projection <BOOL> Guess the proper projection; default: false
--vissim.join-distance <FLOAT> Structure join offset [m]; default: 5
--vissim.default-speed <FLOAT> Use FLOAT as default speed; default: 50
--vissim.speed-norm <FLOAT> Factor for edge velocity; default: 1
--vissim.report-unset-speeds <BOOL> Writes lanes without an explicit speed set; default: false
--visum.use-type-priority <BOOL> Uses priorities from types; default: false
--visum.use-type-laneno <BOOL> Uses lane numbers from types; default: false
--visum.use-type-speed <BOOL> Uses speeds from types; default: false
--visum.connector-speeds <FLOAT> Sets connector speed; default: 100
--visum.connectors-lane-number <INT> Sets connector lane number; default: 3
--visum.no-connectors <BOOL> Excludes connectors; default: false
--visum.recompute-lane-number <BOOL> Computes the number of lanes from the edges' capacities; default: false
--visum.verbose-warnings <BOOL> Prints all warnings, some of which are due to VISUM misbehaviour; default: false
--osm.skip-duplicates-check <BOOL> Skips the check for duplicate nodes and edges.; default: false
--no-internal-links <BOOL> Omits internal links; default: false
--dismiss-vclasses <BOOL> Removes vehicle class restrictions from imported edges; default: false
--no-turnarounds <BOOL> Disables building turnarounds; default: false
--no-turnarounds.tls <BOOL> Disables building turnarounds at tls-controlled junctions; default: false
--no-left-connections <BOOL> Disables building connections to left; default: false
--geometry.split <BOOL> Splits edges across geometry nodes; default: false
-R <BOOL>
--geometry.remove <BOOL>
Replace nodes which only define edge geometry by geometry points (joins edges); default: false
--geometry.max-segment-length <FLOAT> splits geometry to restrict segment length; default: 0
--offset.disable-normalization <BOOL> Turn off normalizing node positions; default: false
--offset.x <FLOAT> Adds FLOAT to net x-positions; default: 0
--offset.y <FLOAT> Adds FLOAT to net y-positions; default: 0
--flip-y-axis <BOOL> Flips the y-coordinate along zero; default: false
--roundabouts.guess <BOOL> Enable roundabout-guessing; default: false
--lefthand <BOOL> Assumes left-hand traffic on the network; default: false
--junctions.join <BOOL> Joins junctions that are close to each other (recommended for OSM import); default: false
--junctions.join-dist <FLOAT> Determines the maximal distance for joining junctions (defaults to 10); default: 10
--junctions.join-exclude <STRING> Interprets STR as list of junctions to exclude from joining
--speed.offset <FLOAT> Modifies all edge speeds by adding FLOAT; default: 0
--speed.factor <FLOAT> Modifies all edge speeds by multiplying FLOAT; default: 1
--tls.join-dist <FLOAT> Determines the maximal distance for joining traffic lights (defaults to 20); default: 20

Building Defaults

Option Description
-L <INT>
--default.lanenumber <INT>
The default number of lanes in an edge; default: 1
-S <FLOAT>
--default.speed <FLOAT>
The default speed on an edge (in m/s); default: 13.9
-P <INT>
--default.priority <INT>
The default priority of an edge; default: -1

Report

Option Description
-v <BOOL>
--verbose <BOOL>
Switches to verbose output; default: false
-p <BOOL>
--print-options <BOOL>
Prints option values before processing; default: false
-? <BOOL>
--help <BOOL>
Prints this screen; default: false
-V <BOOL>
--version <BOOL>
Prints the current version; default: false
-X <BOOL>
--xml-validation <BOOL>
Enable schema validation of XML inputs; default: false
-W <BOOL>
--no-warnings <BOOL>
Disables output of warnings; default: false
-l <FILE>
--log <FILE>
Writes all messages to FILE (implies verbose)
--message-log <FILE> Writes all non-error messages to FILE (implies verbose)
--error-log <FILE> Writes all warnings and errors to FILE

Random Number

Option Description
--random <BOOL> Initialises the random number generator with the current system time; default: false
--seed <INT> Initialises the random number generator with the given value; default: 23423