eskelcz / cheap-ruler Goto Github PK

Fork of cheap-ruler, using {latitude, longitude} object for all Point inputs and outputs. Tests are not covered yet, only tested distance method manually. PR for tests would be most welcome.

A collection of very fast approximations to common geodesic measurements. Useful for performance-sensitive code that measures things on a city scale.

The approximations are based on an FCC-approved formula of ellipsoidal Earth projection. For distances under 500 kilometers and not on the poles, the results are very precise — within 0.1% margin of error compared to Vincenti formulas, and usually much less for shorter distances.

Compared to corresponding Turf methods (using Node v6):

• distance: ~31x faster
• bearing: ~3.6x faster
• destination: ~7.2x faster
• lineDistance: ~31x faster
• area: ~3.4x faster
• along: ~31x faster
• pointOnLine: ~78x faster
• lineSlice: ~60x faster

Additional utility methods:

• lineSliceAlong: ~285x faster than turf.lineSlice(turf.along(...
• bufferPoint: ~260x faster than creating a bounding box with two diagonal turf.destination calls
• bufferBBox: ~260x faster (likewise)
• insideBBox: ~19x faster than turf.inside(turf.point(p), turf.bboxPolygon(bbox))

var ruler = cheapRuler(35.05, 'miles');
// ...
var distance = ruler.distance([30.51, 50.32], [30.52, 50.312]);
var lineLength = ruler.lineDistance(line.geometry.coordinates);
var bbox = ruler.bufferPoint([30.5, 50.5], 0.01);

Note: to get the full performance benefit, create a ruler object only once per a general area of calculation, and then reuse it as much as possible. Don't create a new ruler for every calculation.

Creates a ruler object that will approximate measurements around the given latitude. Units are one of: kilometers (default), miles, nauticalmiles, meters, yards, feet, inches.

Creates a ruler object from tile coordinates (y and z). Convenient in tile-reduce scripts.

var ruler = cheapRuler.fromTile(1567, 12);

Given two points of the form [longitude, latitude], returns the distance.

var distance = ruler.distance([30.5, 50.5], [30.51, 50.49]);

Returns the bearing between two points in angles.

var bearing = ruler.bearing([30.5, 50.5], [30.51, 50.49]);

Returns a new point given distance and bearing from the starting point.

var point = ruler.destination([30.5, 50.5], 0.1, 90);

Returns a new point given easting and northing offsets from the starting point.

var point = ruler.offset([30.5, 50.5], 10, 5); // 10km east and 5km north

Given a line (an array of points), returns the total line distance.

var length = ruler.lineDistance([
    [-67.031, 50.458], [-67.031, 50.534],
    [-66.929, 50.534], [-66.929, 50.458]
]);

Given a polygon (an array of rings, where each ring is an array of points), returns the area. Note that it returns the value in the specified units (square kilometers by default) rather than square meters as in turf.area.

var area = ruler.area([[
    [-67.031, 50.458], [-67.031, 50.534], [-66.929, 50.534],
    [-66.929, 50.458], [-67.031, 50.458]
]]);

Returns the point at a specified distance along the line.

var point = ruler.along(line, 2.5);

Returns an object of the form {point, index, t}, where point is closest point on the line from the given point, index is the start index of the segment with the closest point, and t is a parameter from 0 to 1 that indicates where the closest point is on that segment.

var point = ruler.pointOnLine(line, [-67.04, 50.5]).point;

Returns a part of the given line between the start and the stop points (or their closest points on the line).

ruler.lineSlice([-67.04, 50.5], [-67.05, 50.56], line);

Returns a part of the given line between the start and the stop points indicated by distance along the line.

ruler.lineSliceAlong(10, 20, line);

Given a point, returns a bounding box object ([w, s, e, n]) created from the given point buffered by a given distance.

var bbox = ruler.bufferPoint([30.5, 50.5], 0.01);

Given a bounding box, returns the box buffered by a given distance.

var bbox = ruler.bufferBBox([30.5, 50.5, 31, 51], 0.2);

Returns true if the given point is inside in the given bounding box, otherwise false.

var inside = ruler.insideBBox([30.5, 50.5], [30, 50, 31, 51]);

Multipliers for converting between units are also exposed in cheapRuler.units:

// convert 50 meters to yards
50 * cheapRuler.units.yards / cheapRuler.units.meters;

If you don't specify units when creating a ruler object, you can use these constants to convert return values (using multiplication) and input arguments (using division) to any units:

// get distance between points in feet
var distanceInFeet = ruler.distance(a, b) * cheapRuler.units.feet;

// make a bbox from a point with a 200 inch buffer
var box = ruler.bufferPoint(p, 200 / cheapRuler.units.inches);

• NPM: npm install cheap-ruler
• Browser build on CDN
• Browser build on CDN (minified)

A table that shows the margin of error for ruler.distance compared to node-vincenty (a state of the art distance formula):

Errors for all other methods are similar.

• cheap-ruler-cpp – C++ port of this library
• flat-projection – Rust library based on the same concept