New module @turf/line-overlap

[DenisCarriere]

New Module! @turf/line-overlap 🎉

Takes any LineString or Polygon and returns the overlapping lines between both features.

JSDocs

/**
 * Takes any LineString or Polygon and returns the overlapping lines between both features.
 *
 * @name lineOverlap
 * @param {Feature<LineString|MultiLineString|Polygon|MultiPolygon>} line1 any LineString or Polygon
 * @param {Feature<LineString|MultiLineString|Polygon|MultiPolygon>} line2 any LineString or Polygon
 * @returns {FeatureCollection<LineString>} lines(s) that are overlapping between both features

JS Example

var line1 = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [[115, -35], [125, -30], [135, -30], [145, -35]
    ]
  }
}
var line2 = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [[115, -25], [125, -30], [135, -30], [145, -25]
    ]
  }
}
var overlapping = turf.lineOverlap(line1, line2);
//= overlapping

Dependencies

"dependencies": {
  "@turf/helpers": "^4.0.1",
  "@turf/invariant": "^4.0.1",
  "@turf/line-segment": "^4.0.1",
  "@turf/meta": "^4.0.1",
  "deep-equal": "^1.0.1",
  "geojson-rbush": "^1.0.1"
}

Benchmark Results

polygons x 3,567 ops/sec ±1.61% (85 runs sampled)
simple1 x 9,013 ops/sec ±1.15% (86 runs sampled)
simple2 x 10,278 ops/sec ±1.52% (86 runs sampled)
simple3 x 13,124 ops/sec ±1.37% (85 runs sampled)

Test Examples

Blue Lines: Input features
Red Lines: Lines that are shared between features

CC: #638 @Turfjs/ownership

Please fill in this template.

• Use a meaningful title for the pull request. Include the name of the package modified.
• Have read How To Contribute.
• Run npm test at the sub modules where changes have occurred.
• Run npm run lint to ensure code style at the turf module level.

[DenisCarriere]

Primarily trying to find a solution to replicate JOSM warning "Overlapping (high)ways".

http://wiki.openstreetmap.org/wiki/JOSM/Validator

Checks for two (high)ways that share the same nodes
Remove the double (high)way

Come to think about the name, might change it to @turf/line-overlap.