Link
Search

Configuration

  1. XML
    1. fmm and stmatch
    2. ubodt_gen
  2. Argument list
    1. fmm and stmatch
    2. ubodt_gen

XML

fmm and stmatch

config/ Type Option Description
input/ubodt/file String Required ubodt file name(required only for fmm)
input/network/file String Required network file name
input/network/id String Optional network id field name (default:id)
input/network/source String Optional network source field name (default:source)
input/network/target String Optional network target field name (default:target)
input/network/mode String Optional network mode name (default:drive), only applies to OSM network, one of drive|walk|bike|all.
input/gps/file String Required GPS file name
input/gps/id String Optional GPS id field/column name (default:id)
input/gps/geom String Optional GPS geometry field/column name (default:geom), only applicable for CSV file
input/gps/gps_point - Optional if specified read input data as gps point, otherwise (default) read input data as trajectory
input/gps/x String Optional X field/column name (default:x), only applicable for GPS point CSV file
input/gps/y String Optional Y field/column name (default:y), only applicable for GPS point CSV file
input/gps/timestamp String Optional Timestamp field/column name (default:timestamp), an integer list (Trajectory file) and int (Point GPS file)
parameters/k int Optional number of candidates (default:8)
parameters/r float Optional search radius (unit: map unit) (default:300)
parameters/gps_error float Optional GPS sensor error (unit: map unit) (default:50)
parameters/vmax float Optional Maximum vehicle speed (unit: map unit), only applicable for stmatch (default:30)
parameters/factor float Optional Factor to limit shortest path search, only applicable for stmatch (default:1.5)
output/file String Required Output file name
output/fields String Required Output fields name, one or more in (opath,cpath,tpath,ogeom,mgeom, pgeom,offset,error,spdist,tp,ep,all)
other/log_level int Optional Log level (default:2(info)). 0-trace,1-debug,2-info,3-warn,4-err,5-critical,6off
other/use_omp - Optional If specified, run map matching in multiple thread
other/step int Optional Number of trajectories to report the progress of matching (default:100)

Warning

  • About map unit. The unit of search radius and gps error, vmax are assumed to be the same as the road network shapefile.
    • Both the network and gps data should be in the same reference system.
    • If both the network and gps data are unprojected (in geodetic degree such as OSM and latitude, longitude), then 1 degree of latitude or longitude equals to about 111km. Search radius of 0.003 should be defined here to represent to 300 meters in reality.
    • If both the network and gps data are projected in meters, Search radius of 300 corresponds to 300 meters in reality.

An example can be

<?xml version="1.0" encoding="utf-8"?>
<config>
  <input>
    <ubodt>
      <file>ubodt.txt</file>
    </ubodt>
    <network>
      <file>data/edges.shp</file>
      <id>id</id>
    </network>
    <gps>
      <file>data/trips.shp</file>
      <id>id</id>
    </gps>
  </input>
  <parameters>
    <k>4</k>
    <r>0.4</r>
    <gps_error>0.5</gps_error>
  </parameters>
  <output>
    <fields>
      <all/>
    </fields>
    <file>mr.txt</file>
  </output>
  <other>
    <log_level>2</log_level>
  </other>
</config>

ubodt_gen

config/ Type Option Description
input/network/id String Optional network id field name (default:id)
input/network/source String Optional network source field name (default:source)
input/network/target String Optional network target field name (default:target)
input/network/mode String Optional network mode name (default:drive), only applies to OSM network, one of drive|walk|bike|all.
parameters/delta float Optional Upper distance of routing (default:3000, unit: map unit)
output.file String Required Output file name
other/log_level int Optional Log level (default:2(infor)), 0-trace,1-debug,2-info,3-warn,4-err,5-critical,6-off
other/use_omp - Optional If specified, run in multiple threads, which will be faster

Warning

  • Delta should be specified in the same spatial unit as the network file. If the reference system is WGS84 (in degree), then 1 degree of latitude or longitude equals to about 111km. It is suggested to try some small values first (e.g., 0.01 degree).

An example is provided as

<?xml version="1.0" encoding="utf-8"?>
<config>
    <input>
        <network>
            <file>data/edges.shp</file>
            <id>id</id>
            <source>source</source>
            <target>target</target>
        </network>
    </input>
    <parameters>
        <delta>3</delta>
    </parameters>
    <output>
        <file>ubodt.txt</file>        
    </output>
</config>

Argument list

fmm and stmatch

Argument Type Option Description
--ubodt string required Ubodt file name
--network string required Network file name
--network_id string optional Network id name (id)
--source string optional Network source name (source)
--target string optional Network target name (target)
--mode String Optional network mode name (default:drive), only applies to OSM network, one of drive|walk|bike|all.
--gps string required GPS file name
--gps_id string optional GPS id name (id)
--gps_geom string optional GPS geometry name (geom) (Applicable to GPS trajectory file)
--gps_point string optional if specified read input data as gps point, otherwise (default) read input data as trajectory
--gps_x string optional GPS x name (x) (Applicable to GPS point CSV file)
--gps_y string optional GPS y name (y) (Applicable to GPS point CSV file)
--gps_timestamp string optional GPS timestamp name (timestamp)
-k,--candidates int optional number of candidates (8)
-r,--radius double optional search radius (300)
-e,--error double optional GPS error (50)
--factor double optional scale factor (1.5)
--vmax double optional Maximum speed (30)
-e,--error double optional GPS error (50)
--log_level int optional log level (2)
--use_omp int optional if specified, multi-thread computing executed
--output string required Output file name
--output_fields string optional Output fields

ubodt_gen

Argument Type Option Description
--network string required Network file name
--network_id string optional Network id name (id)
--source string optional Network source name (source)
--target string optional Network target name (target)
--mode String Optional network mode name (default:drive), only applies to OSM network, one of drive|walk|bike|all.
--output string required Output file name
--delta float optional upperbound (3000)
--log_level int optional log level (2)
--use_omp int optional if specified, multi-thread computing executed