Package Exports

@spatial/clusters-kmeans

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 (@spatial/clusters-kmeans) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@spatial/clusters-kmeans

clustersKmeans

Takes a set of points and partition them into clusters using the k-mean . It uses the k-means algorithm

Parameters

points FeatureCollection<Point> to be clustered
options Object Optional parameters (optional, default {})
- options.numberOfClusters number numberOfClusters that will be generated (optional, default Math.sqrt(numberOfPoints/2))
- options.mutate boolean allows GeoJSON input to be mutated (significant performance increase if true) (optional, default false)

Examples

// create random points with random z-values in their properties
var points = turf.randomPoint(100, {bbox: [0, 30, 20, 50]});
var options = {numberOfClusters: 7};
var clustered = turf.clustersKmeans(points, options);

//addToMap
var addToMap = [clustered];

Returns FeatureCollection<Point> Clustered Points with an additional two properties associated to each Feature:- {number} cluster - the associated clusterId

{[number, number]} centroid - Centroid of the cluster [Longitude, Latitude]

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 @spatial/clusters-kmeans

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

$ npm install @turf/turf