JSPM

  • Created
  • Published
  • Downloads 764693
  • Score
    100M100P100Q192931F
  • License MIT

turf concave module

Package Exports

  • @turf/concave

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/concave) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/concave

concave

Takes a set of points and returns a concave hull polygon.

Internally, this uses turf-tin to generate geometries.

Parameters

  • points FeatureCollection<Point> input points
  • maxEdge number the size of an edge necessary for part of the hull to become concave (in miles)
  • units [string] can be degrees, radians, miles, or kilometers (optional, default kilometers)

Examples

var points = {
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-63.601226, 44.642643]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-63.591442, 44.651436]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-63.580799, 44.648749]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-63.573589, 44.641788]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-63.587665, 44.64533]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-63.595218, 44.64765]
      }
    }
  ]
};

var hull = turf.concave(points, 1, 'miles');

var resultFeatures = points.features.concat(hull);
var result = {
  "type": "FeatureCollection",
  "features": resultFeatures
};

//=result
  • Throws Error if maxEdge parameter is missing or unable to compute hull

Returns Feature<Polygon> a concave hull


This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @turf/concave

Or install the Turf module that includes it as a function:

$ npm install @turf/turf