Package Exports

@turf/interpolate

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

Readme

@turf/interpolate

interpolate

Takes a set of points and estimates their 'property' values on a grid using the Inverse Distance Weighting (IDW) method.

Parameters

points FeatureCollection<Point> with known value
cellSize number the distance across each grid point
options Object Optional parameters (optional, default {})
- options.gridType string defines the output format based on a Grid Type (options: 'square' | 'point' | 'hex' | 'triangle') (optional, default 'square')
- options.property string the property name in points from which z-values will be pulled, zValue fallbacks to 3rd coordinate if no property exists. (optional, default 'elevation')
- options.units string used in calculating cellSize, can be degrees, radians, miles, or kilometers (optional, default 'kilometers')
- options.weight number exponent regulating the distance-decay weighting (optional, default 1)

Examples

var points = turf.randomPoint(30, {bbox: [50, 30, 70, 50]});

// add a random property to each point
turf.featureEach(points, function(point) {
    point.properties.solRad = Math.random() * 50;
});
var options = {gridType: 'points', property: 'solRad', units: 'miles'};
var grid = turf.interpolate(points, 100, options);

//addToMap
var addToMap = [grid];

Returns FeatureCollection<(Point | Polygon)> grid of points or polygons with interpolated 'property'

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/interpolate

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

$ npm install @turf/turf