@turf/standard-deviational-ellipse 7.0.0-alpha.0 → 7.0.0-alpha.110

package/README.md

@@ -69,26 +69,21 @@ Returns **[Feature][11]<[Polygon][12]>** an elliptical Polygon that includes app
 
 [12]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
-<!-- This file is automatically generated. Please don't edit it directly:
-if you find an error, edit the source file (likely index.js), and re-run
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/standard-deviational-ellipse
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,91 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.js
+var _meta = require('@turf/meta');
+var _invariant = require('@turf/invariant');
+var _helpers = require('@turf/helpers');
+var _centermean = require('@turf/center-mean');
+var _pointswithinpolygon = require('@turf/points-within-polygon');
+var _ellipse = require('@turf/ellipse');
+function standardDeviationalEllipse(points, options) {
+  options = options || {};
+  if (!_helpers.isObject.call(void 0, options))
+    throw new Error("options is invalid");
+  var steps = options.steps || 64;
+  var weightTerm = options.weight;
+  var properties = options.properties || {};
+  if (!_helpers.isNumber.call(void 0, steps))
+    throw new Error("steps must be a number");
+  if (!_helpers.isObject.call(void 0, properties))
+    throw new Error("properties must be a number");
+  var numberOfFeatures = _meta.coordAll.call(void 0, points).length;
+  var meanCenter = _centermean.centerMean.call(void 0, points, { weight: weightTerm });
+  var xDeviationSquaredSum = 0;
+  var yDeviationSquaredSum = 0;
+  var xyDeviationSum = 0;
+  _meta.featureEach.call(void 0, points, function(point) {
+    var weight = point.properties[weightTerm] || 1;
+    var deviation = getDeviations(_invariant.getCoords.call(void 0, point), _invariant.getCoords.call(void 0, meanCenter));
+    xDeviationSquaredSum += Math.pow(deviation.x, 2) * weight;
+    yDeviationSquaredSum += Math.pow(deviation.y, 2) * weight;
+    xyDeviationSum += deviation.x * deviation.y * weight;
+  });
+  var bigA = xDeviationSquaredSum - yDeviationSquaredSum;
+  var bigB = Math.sqrt(Math.pow(bigA, 2) + 4 * Math.pow(xyDeviationSum, 2));
+  var bigC = 2 * xyDeviationSum;
+  var theta = Math.atan((bigA + bigB) / bigC);
+  var thetaDeg = theta * 180 / Math.PI;
+  var sigmaXsum = 0;
+  var sigmaYsum = 0;
+  var weightsum = 0;
+  _meta.featureEach.call(void 0, points, function(point) {
+    var weight = point.properties[weightTerm] || 1;
+    var deviation = getDeviations(_invariant.getCoords.call(void 0, point), _invariant.getCoords.call(void 0, meanCenter));
+    sigmaXsum += Math.pow(
+      deviation.x * Math.cos(theta) - deviation.y * Math.sin(theta),
+      2
+    ) * weight;
+    sigmaYsum += Math.pow(
+      deviation.x * Math.sin(theta) + deviation.y * Math.cos(theta),
+      2
+    ) * weight;
+    weightsum += weight;
+  });
+  var sigmaX = Math.sqrt(2 * sigmaXsum / weightsum);
+  var sigmaY = Math.sqrt(2 * sigmaYsum / weightsum);
+  var theEllipse = _ellipse.ellipse.call(void 0, meanCenter, sigmaX, sigmaY, {
+    units: "degrees",
+    angle: thetaDeg,
+    steps,
+    properties
+  });
+  var pointsWithinEllipse = _pointswithinpolygon.pointsWithinPolygon.call(void 0, 
+    points,
+    _helpers.featureCollection.call(void 0, [theEllipse])
+  );
+  var standardDeviationalEllipseProperties = {
+    meanCenterCoordinates: _invariant.getCoords.call(void 0, meanCenter),
+    semiMajorAxis: sigmaX,
+    semiMinorAxis: sigmaY,
+    numberOfFeatures,
+    angle: thetaDeg,
+    percentageWithinEllipse: 100 * _meta.coordAll.call(void 0, pointsWithinEllipse).length / numberOfFeatures
+  };
+  theEllipse.properties.standardDeviationalEllipse = standardDeviationalEllipseProperties;
+  return theEllipse;
+}
+__name(standardDeviationalEllipse, "standardDeviationalEllipse");
+function getDeviations(coordinates, center) {
+  return {
+    x: coordinates[0] - center[0],
+    y: coordinates[1] - center[1]
+  };
+}
+__name(getDeviations, "getDeviations");
+var turf_standard_deviational_ellipse_default = standardDeviationalEllipse;
+
+
+
+exports.default = turf_standard_deviational_ellipse_default; exports.standardDeviationalEllipse = standardDeviationalEllipse;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.js"],"names":[],"mappings":";;;;AAAA,SAAS,UAAU,mBAAmB;AACtC,SAAS,iBAAiB;AAC1B,SAAS,mBAAmB,UAAU,gBAAgB;AACtD,SAAS,kBAAkB;AAC3B,SAAS,2BAA2B;AACpC,SAAS,eAAe;AAwCxB,SAAS,2BAA2B,QAAQ,SAAS;AAEnD,YAAU,WAAW,CAAC;AACtB,MAAI,CAAC,SAAS,OAAO;AAAG,UAAM,IAAI,MAAM,oBAAoB;AAC5D,MAAI,QAAQ,QAAQ,SAAS;AAC7B,MAAI,aAAa,QAAQ;AACzB,MAAI,aAAa,QAAQ,cAAc,CAAC;AAGxC,MAAI,CAAC,SAAS,KAAK;AAAG,UAAM,IAAI,MAAM,wBAAwB;AAC9D,MAAI,CAAC,SAAS,UAAU;AAAG,UAAM,IAAI,MAAM,6BAA6B;AAGxE,MAAI,mBAAmB,SAAS,MAAM,EAAE;AACxC,MAAI,aAAa,WAAW,QAAQ,EAAE,QAAQ,WAAW,CAAC;AAS1D,MAAI,uBAAuB;AAC3B,MAAI,uBAAuB;AAC3B,MAAI,iBAAiB;AAErB,cAAY,QAAQ,SAAU,OAAO;AACnC,QAAI,SAAS,MAAM,WAAW,UAAU,KAAK;AAC7C,QAAI,YAAY,cAAc,UAAU,KAAK,GAAG,UAAU,UAAU,CAAC;AACrE,4BAAwB,KAAK,IAAI,UAAU,GAAG,CAAC,IAAI;AACnD,4BAAwB,KAAK,IAAI,UAAU,GAAG,CAAC,IAAI;AACnD,sBAAkB,UAAU,IAAI,UAAU,IAAI;AAAA,EAChD,CAAC;AAED,MAAI,OAAO,uBAAuB;AAClC,MAAI,OAAO,KAAK,KAAK,KAAK,IAAI,MAAM,CAAC,IAAI,IAAI,KAAK,IAAI,gBAAgB,CAAC,CAAC;AACxE,MAAI,OAAO,IAAI;AACf,MAAI,QAAQ,KAAK,MAAM,OAAO,QAAQ,IAAI;AAC1C,MAAI,WAAY,QAAQ,MAAO,KAAK;AAKpC,MAAI,YAAY;AAChB,MAAI,YAAY;AAChB,MAAI,YAAY;AAChB,cAAY,QAAQ,SAAU,OAAO;AACnC,QAAI,SAAS,MAAM,WAAW,UAAU,KAAK;AAC7C,QAAI,YAAY,cAAc,UAAU,KAAK,GAAG,UAAU,UAAU,CAAC;AACrE,iBACE,KAAK;AAAA,MACH,UAAU,IAAI,KAAK,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK;AAAA,MAC5D;AAAA,IACF,IAAI;AACN,iBACE,KAAK;AAAA,MACH,UAAU,IAAI,KAAK,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK;AAAA,MAC5D;AAAA,IACF,IAAI;AACN,iBAAa;AAAA,EACf,CAAC;AAED,MAAI,SAAS,KAAK,KAAM,IAAI,YAAa,SAAS;AAClD,MAAI,SAAS,KAAK,KAAM,IAAI,YAAa,SAAS;AAElD,MAAI,aAAa,QAAQ,YAAY,QAAQ,QAAQ;AAAA,IACnD,OAAO;AAAA,IACP,OAAO;AAAA,IACP;AAAA,IACA;AAAA,EACF,CAAC;AACD,MAAI,sBAAsB;AAAA,IACxB;AAAA,IACA,kBAAkB,CAAC,UAAU,CAAC;AAAA,EAChC;AACA,MAAI,uCAAuC;AAAA,IACzC,uBAAuB,UAAU,UAAU;AAAA,IAC3C,eAAe;AAAA,IACf,eAAe;AAAA,IACf;AAAA,IACA,OAAO;AAAA,IACP,yBACG,MAAM,SAAS,mBAAmB,EAAE,SAAU;AAAA,EACnD;AACA,aAAW,WAAW,6BACpB;AAEF,SAAO;AACT;AAzFS;AAmGT,SAAS,cAAc,aAAa,QAAQ;AAC1C,SAAO;AAAA,IACL,GAAG,YAAY,CAAC,IAAI,OAAO,CAAC;AAAA,IAC5B,GAAG,YAAY,CAAC,IAAI,OAAO,CAAC;AAAA,EAC9B;AACF;AALS;AAQT,IAAO,4CAAQ","sourcesContent":["import { coordAll, featureEach } from \"@turf/meta\";\nimport { getCoords } from \"@turf/invariant\";\nimport { featureCollection, isObject, isNumber } from \"@turf/helpers\";\nimport { centerMean } from \"@turf/center-mean\";\nimport { pointsWithinPolygon } from \"@turf/points-within-polygon\";\nimport { ellipse } from \"@turf/ellipse\";\n\n/**\n * Takes a {@link FeatureCollection} and returns a standard deviational ellipse,\n * also known as a “directional distribution.” The standard deviational ellipse\n * aims to show the direction and the distribution of a dataset by drawing\n * an ellipse that contains about one standard deviation’s worth (~ 70%) of the\n * data.\n *\n * This module mirrors the functionality of [Directional Distribution](http://desktop.arcgis.com/en/arcmap/10.3/tools/spatial-statistics-toolbox/directional-distribution.htm)\n * in ArcGIS and the [QGIS Standard Deviational Ellipse Plugin](http://arken.nmbu.no/~havatv/gis/qgisplugins/SDEllipse/)\n *\n * **Bibliography**\n *\n * • Robert S. Yuill, “The Standard Deviational Ellipse; An Updated Tool for\n * Spatial Description,” _Geografiska Annaler_ 53, no. 1 (1971): 28–39,\n * doi:{@link https://doi.org/10.2307/490885|10.2307/490885}.\n *\n * • Paul Hanly Furfey, “A Note on Lefever’s “Standard Deviational Ellipse,”\n * _American Journal of Sociology_ 33, no. 1 (1927): 94—98,\n * doi:{@link https://doi.org/10.1086/214336|10.1086/214336}.\n *\n *\n * @name standardDeviationalEllipse\n * @param {FeatureCollection<Point>} points GeoJSON points\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.weight] the property name used to weight the center\n * @param {number} [options.steps=64] number of steps for the polygon\n * @param {Object} [options.properties={}] properties to pass to the resulting ellipse\n * @returns {Feature<Polygon>} an elliptical Polygon that includes approximately 1 SD of the dataset within it.\n * @example\n *\n * var bbox = [-74, 40.72, -73.98, 40.74];\n * var points = turf.randomPoint(400, {bbox: bbox});\n * var sdEllipse = turf.standardDeviationalEllipse(points);\n *\n * //addToMap\n * var addToMap = [points, sdEllipse];\n *\n */\nfunction standardDeviationalEllipse(points, options) {\n  // Optional params\n  options = options || {};\n  if (!isObject(options)) throw new Error(\"options is invalid\");\n  var steps = options.steps || 64;\n  var weightTerm = options.weight;\n  var properties = options.properties || {};\n\n  // Validation:\n  if (!isNumber(steps)) throw new Error(\"steps must be a number\");\n  if (!isObject(properties)) throw new Error(\"properties must be a number\");\n\n  // Calculate mean center & number of features:\n  var numberOfFeatures = coordAll(points).length;\n  var meanCenter = centerMean(points, { weight: weightTerm });\n\n  // Calculate angle of rotation:\n  // [X, Y] = mean center of all [x, y].\n  // theta = arctan( (A + B) / C )\n  // A = sum((x - X)^2) - sum((y - Y)^2)\n  // B = sqrt(A^2 + 4(sum((x - X)(y - Y))^2))\n  // C = 2(sum((x - X)(y - Y)))\n\n  var xDeviationSquaredSum = 0;\n  var yDeviationSquaredSum = 0;\n  var xyDeviationSum = 0;\n\n  featureEach(points, function (point) {\n    var weight = point.properties[weightTerm] || 1;\n    var deviation = getDeviations(getCoords(point), getCoords(meanCenter));\n    xDeviationSquaredSum += Math.pow(deviation.x, 2) * weight;\n    yDeviationSquaredSum += Math.pow(deviation.y, 2) * weight;\n    xyDeviationSum += deviation.x * deviation.y * weight;\n  });\n\n  var bigA = xDeviationSquaredSum - yDeviationSquaredSum;\n  var bigB = Math.sqrt(Math.pow(bigA, 2) + 4 * Math.pow(xyDeviationSum, 2));\n  var bigC = 2 * xyDeviationSum;\n  var theta = Math.atan((bigA + bigB) / bigC);\n  var thetaDeg = (theta * 180) / Math.PI;\n\n  // Calculate axes:\n  // sigmaX = sqrt((1 / n - 2) * sum((((x - X) * cos(theta)) - ((y - Y) * sin(theta)))^2))\n  // sigmaY = sqrt((1 / n - 2) * sum((((x - X) * sin(theta)) - ((y - Y) * cos(theta)))^2))\n  var sigmaXsum = 0;\n  var sigmaYsum = 0;\n  var weightsum = 0;\n  featureEach(points, function (point) {\n    var weight = point.properties[weightTerm] || 1;\n    var deviation = getDeviations(getCoords(point), getCoords(meanCenter));\n    sigmaXsum +=\n      Math.pow(\n        deviation.x * Math.cos(theta) - deviation.y * Math.sin(theta),\n        2\n      ) * weight;\n    sigmaYsum +=\n      Math.pow(\n        deviation.x * Math.sin(theta) + deviation.y * Math.cos(theta),\n        2\n      ) * weight;\n    weightsum += weight;\n  });\n\n  var sigmaX = Math.sqrt((2 * sigmaXsum) / weightsum);\n  var sigmaY = Math.sqrt((2 * sigmaYsum) / weightsum);\n\n  var theEllipse = ellipse(meanCenter, sigmaX, sigmaY, {\n    units: \"degrees\",\n    angle: thetaDeg,\n    steps: steps,\n    properties: properties,\n  });\n  var pointsWithinEllipse = pointsWithinPolygon(\n    points,\n    featureCollection([theEllipse])\n  );\n  var standardDeviationalEllipseProperties = {\n    meanCenterCoordinates: getCoords(meanCenter),\n    semiMajorAxis: sigmaX,\n    semiMinorAxis: sigmaY,\n    numberOfFeatures: numberOfFeatures,\n    angle: thetaDeg,\n    percentageWithinEllipse:\n      (100 * coordAll(pointsWithinEllipse).length) / numberOfFeatures,\n  };\n  theEllipse.properties.standardDeviationalEllipse =\n    standardDeviationalEllipseProperties;\n\n  return theEllipse;\n}\n\n/**\n * Get x_i - X and y_i - Y\n *\n * @private\n * @param {Array} coordinates Array of [x_i, y_i]\n * @param {Array} center Array of [X, Y]\n * @returns {Object} { x: n, y: m }\n */\nfunction getDeviations(coordinates, center) {\n  return {\n    x: coordinates[0] - center[0],\n    y: coordinates[1] - center[1],\n  };\n}\n\nexport { standardDeviationalEllipse };\nexport default standardDeviationalEllipse;\n"]}

package/dist/cjs/index.d.ts

@@ -0,0 +1,32 @@
+import { Position, Feature, Polygon, FeatureCollection, Point, GeoJsonProperties } from 'geojson';
+
+/**
+ * http://turfjs.org/docs/#standarddeviational-ellipse
+ */
+
+declare interface SDEProps {
+  meanCenterCoordinates: Position;
+  semiMajorAxis: number;
+  semiMinorAxis: number;
+  numberOfFeatures: number;
+  angle: number;
+  percentageWithinEllipse: number;
+}
+
+declare interface StandardDeviationalEllipse extends Feature<Polygon> {
+  properties: {
+    standardDeviationalEllipse: SDEProps;
+    [key: string]: any;
+  };
+}
+
+declare function standardDeviationalEllipse(
+  points: FeatureCollection<Point>,
+  options?: {
+    properties?: GeoJsonProperties;
+    weight?: string;
+    steps?: number;
+  }
+): StandardDeviationalEllipse;
+
+export { type SDEProps, type StandardDeviationalEllipse, standardDeviationalEllipse as default, standardDeviationalEllipse };

package/dist/esm/index.d.mts

@@ -0,0 +1,32 @@
+import { Position, Feature, Polygon, FeatureCollection, Point, GeoJsonProperties } from 'geojson';
+
+/**
+ * http://turfjs.org/docs/#standarddeviational-ellipse
+ */
+
+declare interface SDEProps {
+  meanCenterCoordinates: Position;
+  semiMajorAxis: number;
+  semiMinorAxis: number;
+  numberOfFeatures: number;
+  angle: number;
+  percentageWithinEllipse: number;
+}
+
+declare interface StandardDeviationalEllipse extends Feature<Polygon> {
+  properties: {
+    standardDeviationalEllipse: SDEProps;
+    [key: string]: any;
+  };
+}
+
+declare function standardDeviationalEllipse(
+  points: FeatureCollection<Point>,
+  options?: {
+    properties?: GeoJsonProperties;
+    weight?: string;
+    steps?: number;
+  }
+): StandardDeviationalEllipse;
+
+export { type SDEProps, type StandardDeviationalEllipse, standardDeviationalEllipse as default, standardDeviationalEllipse };

package/dist/esm/index.mjs

@@ -0,0 +1,91 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.js
+import { coordAll, featureEach } from "@turf/meta";
+import { getCoords } from "@turf/invariant";
+import { featureCollection, isObject, isNumber } from "@turf/helpers";
+import { centerMean } from "@turf/center-mean";
+import { pointsWithinPolygon } from "@turf/points-within-polygon";
+import { ellipse } from "@turf/ellipse";
+function standardDeviationalEllipse(points, options) {
+  options = options || {};
+  if (!isObject(options))
+    throw new Error("options is invalid");
+  var steps = options.steps || 64;
+  var weightTerm = options.weight;
+  var properties = options.properties || {};
+  if (!isNumber(steps))
+    throw new Error("steps must be a number");
+  if (!isObject(properties))
+    throw new Error("properties must be a number");
+  var numberOfFeatures = coordAll(points).length;
+  var meanCenter = centerMean(points, { weight: weightTerm });
+  var xDeviationSquaredSum = 0;
+  var yDeviationSquaredSum = 0;
+  var xyDeviationSum = 0;
+  featureEach(points, function(point) {
+    var weight = point.properties[weightTerm] || 1;
+    var deviation = getDeviations(getCoords(point), getCoords(meanCenter));
+    xDeviationSquaredSum += Math.pow(deviation.x, 2) * weight;
+    yDeviationSquaredSum += Math.pow(deviation.y, 2) * weight;
+    xyDeviationSum += deviation.x * deviation.y * weight;
+  });
+  var bigA = xDeviationSquaredSum - yDeviationSquaredSum;
+  var bigB = Math.sqrt(Math.pow(bigA, 2) + 4 * Math.pow(xyDeviationSum, 2));
+  var bigC = 2 * xyDeviationSum;
+  var theta = Math.atan((bigA + bigB) / bigC);
+  var thetaDeg = theta * 180 / Math.PI;
+  var sigmaXsum = 0;
+  var sigmaYsum = 0;
+  var weightsum = 0;
+  featureEach(points, function(point) {
+    var weight = point.properties[weightTerm] || 1;
+    var deviation = getDeviations(getCoords(point), getCoords(meanCenter));
+    sigmaXsum += Math.pow(
+      deviation.x * Math.cos(theta) - deviation.y * Math.sin(theta),
+      2
+    ) * weight;
+    sigmaYsum += Math.pow(
+      deviation.x * Math.sin(theta) + deviation.y * Math.cos(theta),
+      2
+    ) * weight;
+    weightsum += weight;
+  });
+  var sigmaX = Math.sqrt(2 * sigmaXsum / weightsum);
+  var sigmaY = Math.sqrt(2 * sigmaYsum / weightsum);
+  var theEllipse = ellipse(meanCenter, sigmaX, sigmaY, {
+    units: "degrees",
+    angle: thetaDeg,
+    steps,
+    properties
+  });
+  var pointsWithinEllipse = pointsWithinPolygon(
+    points,
+    featureCollection([theEllipse])
+  );
+  var standardDeviationalEllipseProperties = {
+    meanCenterCoordinates: getCoords(meanCenter),
+    semiMajorAxis: sigmaX,
+    semiMinorAxis: sigmaY,
+    numberOfFeatures,
+    angle: thetaDeg,
+    percentageWithinEllipse: 100 * coordAll(pointsWithinEllipse).length / numberOfFeatures
+  };
+  theEllipse.properties.standardDeviationalEllipse = standardDeviationalEllipseProperties;
+  return theEllipse;
+}
+__name(standardDeviationalEllipse, "standardDeviationalEllipse");
+function getDeviations(coordinates, center) {
+  return {
+    x: coordinates[0] - center[0],
+    y: coordinates[1] - center[1]
+  };
+}
+__name(getDeviations, "getDeviations");
+var turf_standard_deviational_ellipse_default = standardDeviationalEllipse;
+export {
+  turf_standard_deviational_ellipse_default as default,
+  standardDeviationalEllipse
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.js"],"sourcesContent":["import { coordAll, featureEach } from \"@turf/meta\";\nimport { getCoords } from \"@turf/invariant\";\nimport { featureCollection, isObject, isNumber } from \"@turf/helpers\";\nimport { centerMean } from \"@turf/center-mean\";\nimport { pointsWithinPolygon } from \"@turf/points-within-polygon\";\nimport { ellipse } from \"@turf/ellipse\";\n\n/**\n * Takes a {@link FeatureCollection} and returns a standard deviational ellipse,\n * also known as a “directional distribution.” The standard deviational ellipse\n * aims to show the direction and the distribution of a dataset by drawing\n * an ellipse that contains about one standard deviation’s worth (~ 70%) of the\n * data.\n *\n * This module mirrors the functionality of [Directional Distribution](http://desktop.arcgis.com/en/arcmap/10.3/tools/spatial-statistics-toolbox/directional-distribution.htm)\n * in ArcGIS and the [QGIS Standard Deviational Ellipse Plugin](http://arken.nmbu.no/~havatv/gis/qgisplugins/SDEllipse/)\n *\n * **Bibliography**\n *\n * • Robert S. Yuill, “The Standard Deviational Ellipse; An Updated Tool for\n * Spatial Description,” _Geografiska Annaler_ 53, no. 1 (1971): 28–39,\n * doi:{@link https://doi.org/10.2307/490885|10.2307/490885}.\n *\n * • Paul Hanly Furfey, “A Note on Lefever’s “Standard Deviational Ellipse,”\n * _American Journal of Sociology_ 33, no. 1 (1927): 94—98,\n * doi:{@link https://doi.org/10.1086/214336|10.1086/214336}.\n *\n *\n * @name standardDeviationalEllipse\n * @param {FeatureCollection<Point>} points GeoJSON points\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.weight] the property name used to weight the center\n * @param {number} [options.steps=64] number of steps for the polygon\n * @param {Object} [options.properties={}] properties to pass to the resulting ellipse\n * @returns {Feature<Polygon>} an elliptical Polygon that includes approximately 1 SD of the dataset within it.\n * @example\n *\n * var bbox = [-74, 40.72, -73.98, 40.74];\n * var points = turf.randomPoint(400, {bbox: bbox});\n * var sdEllipse = turf.standardDeviationalEllipse(points);\n *\n * //addToMap\n * var addToMap = [points, sdEllipse];\n *\n */\nfunction standardDeviationalEllipse(points, options) {\n  // Optional params\n  options = options || {};\n  if (!isObject(options)) throw new Error(\"options is invalid\");\n  var steps = options.steps || 64;\n  var weightTerm = options.weight;\n  var properties = options.properties || {};\n\n  // Validation:\n  if (!isNumber(steps)) throw new Error(\"steps must be a number\");\n  if (!isObject(properties)) throw new Error(\"properties must be a number\");\n\n  // Calculate mean center & number of features:\n  var numberOfFeatures = coordAll(points).length;\n  var meanCenter = centerMean(points, { weight: weightTerm });\n\n  // Calculate angle of rotation:\n  // [X, Y] = mean center of all [x, y].\n  // theta = arctan( (A + B) / C )\n  // A = sum((x - X)^2) - sum((y - Y)^2)\n  // B = sqrt(A^2 + 4(sum((x - X)(y - Y))^2))\n  // C = 2(sum((x - X)(y - Y)))\n\n  var xDeviationSquaredSum = 0;\n  var yDeviationSquaredSum = 0;\n  var xyDeviationSum = 0;\n\n  featureEach(points, function (point) {\n    var weight = point.properties[weightTerm] || 1;\n    var deviation = getDeviations(getCoords(point), getCoords(meanCenter));\n    xDeviationSquaredSum += Math.pow(deviation.x, 2) * weight;\n    yDeviationSquaredSum += Math.pow(deviation.y, 2) * weight;\n    xyDeviationSum += deviation.x * deviation.y * weight;\n  });\n\n  var bigA = xDeviationSquaredSum - yDeviationSquaredSum;\n  var bigB = Math.sqrt(Math.pow(bigA, 2) + 4 * Math.pow(xyDeviationSum, 2));\n  var bigC = 2 * xyDeviationSum;\n  var theta = Math.atan((bigA + bigB) / bigC);\n  var thetaDeg = (theta * 180) / Math.PI;\n\n  // Calculate axes:\n  // sigmaX = sqrt((1 / n - 2) * sum((((x - X) * cos(theta)) - ((y - Y) * sin(theta)))^2))\n  // sigmaY = sqrt((1 / n - 2) * sum((((x - X) * sin(theta)) - ((y - Y) * cos(theta)))^2))\n  var sigmaXsum = 0;\n  var sigmaYsum = 0;\n  var weightsum = 0;\n  featureEach(points, function (point) {\n    var weight = point.properties[weightTerm] || 1;\n    var deviation = getDeviations(getCoords(point), getCoords(meanCenter));\n    sigmaXsum +=\n      Math.pow(\n        deviation.x * Math.cos(theta) - deviation.y * Math.sin(theta),\n        2\n      ) * weight;\n    sigmaYsum +=\n      Math.pow(\n        deviation.x * Math.sin(theta) + deviation.y * Math.cos(theta),\n        2\n      ) * weight;\n    weightsum += weight;\n  });\n\n  var sigmaX = Math.sqrt((2 * sigmaXsum) / weightsum);\n  var sigmaY = Math.sqrt((2 * sigmaYsum) / weightsum);\n\n  var theEllipse = ellipse(meanCenter, sigmaX, sigmaY, {\n    units: \"degrees\",\n    angle: thetaDeg,\n    steps: steps,\n    properties: properties,\n  });\n  var pointsWithinEllipse = pointsWithinPolygon(\n    points,\n    featureCollection([theEllipse])\n  );\n  var standardDeviationalEllipseProperties = {\n    meanCenterCoordinates: getCoords(meanCenter),\n    semiMajorAxis: sigmaX,\n    semiMinorAxis: sigmaY,\n    numberOfFeatures: numberOfFeatures,\n    angle: thetaDeg,\n    percentageWithinEllipse:\n      (100 * coordAll(pointsWithinEllipse).length) / numberOfFeatures,\n  };\n  theEllipse.properties.standardDeviationalEllipse =\n    standardDeviationalEllipseProperties;\n\n  return theEllipse;\n}\n\n/**\n * Get x_i - X and y_i - Y\n *\n * @private\n * @param {Array} coordinates Array of [x_i, y_i]\n * @param {Array} center Array of [X, Y]\n * @returns {Object} { x: n, y: m }\n */\nfunction getDeviations(coordinates, center) {\n  return {\n    x: coordinates[0] - center[0],\n    y: coordinates[1] - center[1],\n  };\n}\n\nexport { standardDeviationalEllipse };\nexport default standardDeviationalEllipse;\n"],"mappings":";;;;AAAA,SAAS,UAAU,mBAAmB;AACtC,SAAS,iBAAiB;AAC1B,SAAS,mBAAmB,UAAU,gBAAgB;AACtD,SAAS,kBAAkB;AAC3B,SAAS,2BAA2B;AACpC,SAAS,eAAe;AAwCxB,SAAS,2BAA2B,QAAQ,SAAS;AAEnD,YAAU,WAAW,CAAC;AACtB,MAAI,CAAC,SAAS,OAAO;AAAG,UAAM,IAAI,MAAM,oBAAoB;AAC5D,MAAI,QAAQ,QAAQ,SAAS;AAC7B,MAAI,aAAa,QAAQ;AACzB,MAAI,aAAa,QAAQ,cAAc,CAAC;AAGxC,MAAI,CAAC,SAAS,KAAK;AAAG,UAAM,IAAI,MAAM,wBAAwB;AAC9D,MAAI,CAAC,SAAS,UAAU;AAAG,UAAM,IAAI,MAAM,6BAA6B;AAGxE,MAAI,mBAAmB,SAAS,MAAM,EAAE;AACxC,MAAI,aAAa,WAAW,QAAQ,EAAE,QAAQ,WAAW,CAAC;AAS1D,MAAI,uBAAuB;AAC3B,MAAI,uBAAuB;AAC3B,MAAI,iBAAiB;AAErB,cAAY,QAAQ,SAAU,OAAO;AACnC,QAAI,SAAS,MAAM,WAAW,UAAU,KAAK;AAC7C,QAAI,YAAY,cAAc,UAAU,KAAK,GAAG,UAAU,UAAU,CAAC;AACrE,4BAAwB,KAAK,IAAI,UAAU,GAAG,CAAC,IAAI;AACnD,4BAAwB,KAAK,IAAI,UAAU,GAAG,CAAC,IAAI;AACnD,sBAAkB,UAAU,IAAI,UAAU,IAAI;AAAA,EAChD,CAAC;AAED,MAAI,OAAO,uBAAuB;AAClC,MAAI,OAAO,KAAK,KAAK,KAAK,IAAI,MAAM,CAAC,IAAI,IAAI,KAAK,IAAI,gBAAgB,CAAC,CAAC;AACxE,MAAI,OAAO,IAAI;AACf,MAAI,QAAQ,KAAK,MAAM,OAAO,QAAQ,IAAI;AAC1C,MAAI,WAAY,QAAQ,MAAO,KAAK;AAKpC,MAAI,YAAY;AAChB,MAAI,YAAY;AAChB,MAAI,YAAY;AAChB,cAAY,QAAQ,SAAU,OAAO;AACnC,QAAI,SAAS,MAAM,WAAW,UAAU,KAAK;AAC7C,QAAI,YAAY,cAAc,UAAU,KAAK,GAAG,UAAU,UAAU,CAAC;AACrE,iBACE,KAAK;AAAA,MACH,UAAU,IAAI,KAAK,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK;AAAA,MAC5D;AAAA,IACF,IAAI;AACN,iBACE,KAAK;AAAA,MACH,UAAU,IAAI,KAAK,IAAI,KAAK,IAAI,UAAU,IAAI,KAAK,IAAI,KAAK;AAAA,MAC5D;AAAA,IACF,IAAI;AACN,iBAAa;AAAA,EACf,CAAC;AAED,MAAI,SAAS,KAAK,KAAM,IAAI,YAAa,SAAS;AAClD,MAAI,SAAS,KAAK,KAAM,IAAI,YAAa,SAAS;AAElD,MAAI,aAAa,QAAQ,YAAY,QAAQ,QAAQ;AAAA,IACnD,OAAO;AAAA,IACP,OAAO;AAAA,IACP;AAAA,IACA;AAAA,EACF,CAAC;AACD,MAAI,sBAAsB;AAAA,IACxB;AAAA,IACA,kBAAkB,CAAC,UAAU,CAAC;AAAA,EAChC;AACA,MAAI,uCAAuC;AAAA,IACzC,uBAAuB,UAAU,UAAU;AAAA,IAC3C,eAAe;AAAA,IACf,eAAe;AAAA,IACf;AAAA,IACA,OAAO;AAAA,IACP,yBACG,MAAM,SAAS,mBAAmB,EAAE,SAAU;AAAA,EACnD;AACA,aAAW,WAAW,6BACpB;AAEF,SAAO;AACT;AAzFS;AAmGT,SAAS,cAAc,aAAa,QAAQ;AAC1C,SAAO;AAAA,IACL,GAAG,YAAY,CAAC,IAAI,OAAO,CAAC;AAAA,IAC5B,GAAG,YAAY,CAAC,IAAI,OAAO,CAAC;AAAA,EAC9B;AACF;AALS;AAQT,IAAO,4CAAQ;","names":[]}

package/index.d.ts

@@ -11,7 +11,7 @@ import {
  * http://turfjs.org/docs/#standarddeviational-ellipse
  */
 
-export interface SDEProps {
+declare interface SDEProps {
   meanCenterCoordinates: Position;
   semiMajorAxis: number;
   semiMinorAxis: number;
@@ -20,14 +20,14 @@ export interface SDEProps {
   percentageWithinEllipse: number;
 }
 
-export interface StandardDeviationalEllipse extends Feature<Polygon> {
+declare interface StandardDeviationalEllipse extends Feature<Polygon> {
   properties: {
     standardDeviationalEllipse: SDEProps;
     [key: string]: any;
   };
 }
 
-export default function (
+declare function standardDeviationalEllipse(
   points: FeatureCollection<Point>,
   options?: {
     properties?: GeoJsonProperties;
@@ -35,3 +35,6 @@ export default function (
     steps?: number;
   }
 ): StandardDeviationalEllipse;
+
+export { SDEProps, StandardDeviationalEllipse, standardDeviationalEllipse };
+export default standardDeviationalEllipse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/standard-deviational-ellipse",
-  "version": "7.0.0-alpha.0",
+  "version": "7.0.0-alpha.110+1411d63a7",
   "description": "turf standard-deviational-ellipse module",
   "author": "Turf Authors",
   "contributors": [
@@ -25,46 +25,54 @@
     "geostatistics",
     "directional distribution"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "commonjs",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/cjs/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "index.d.ts",
   "sideEffects": false,
   "files": [
     "dist",
     "index.d.ts"
   ],
   "scripts": {
-    "bench": "node -r esm bench.js",
-    "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "node ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "node -r esm test.js",
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts",
     "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/random": "^7.0.0-alpha.0",
-    "@turf/truncate": "^7.0.0-alpha.0",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "rollup": "*",
-    "tape": "*",
-    "write-json-file": "*"
+    "@turf/random": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/truncate": "^7.0.0-alpha.110+1411d63a7",
+    "benchmark": "^2.1.4",
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/center-mean": "^7.0.0-alpha.0",
-    "@turf/ellipse": "^7.0.0-alpha.0",
-    "@turf/helpers": "^7.0.0-alpha.0",
-    "@turf/invariant": "^7.0.0-alpha.0",
-    "@turf/meta": "^7.0.0-alpha.0",
-    "@turf/points-within-polygon": "^7.0.0-alpha.0"
+    "@turf/center-mean": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/ellipse": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/helpers": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/invariant": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/meta": "^7.0.0-alpha.110+1411d63a7",
+    "@turf/points-within-polygon": "^7.0.0-alpha.110+1411d63a7"
   },
-  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
+  "gitHead": "1411d63a74c275c9216fe48e9d3cb2d48a359068"
 }

package/dist/es/index.js

@@ -1,151 +0,0 @@
-import { coordAll, featureEach } from '@turf/meta';
-import { getCoords } from '@turf/invariant';
-import { isObject, isNumber, featureCollection } from '@turf/helpers';
-import centerMean from '@turf/center-mean';
-import pointsWithinPolygon from '@turf/points-within-polygon';
-import ellipse from '@turf/ellipse';
-
-/**
- * Takes a {@link FeatureCollection} and returns a standard deviational ellipse,
- * also known as a “directional distribution.” The standard deviational ellipse
- * aims to show the direction and the distribution of a dataset by drawing
- * an ellipse that contains about one standard deviation’s worth (~ 70%) of the
- * data.
- *
- * This module mirrors the functionality of [Directional Distribution](http://desktop.arcgis.com/en/arcmap/10.3/tools/spatial-statistics-toolbox/directional-distribution.htm)
- * in ArcGIS and the [QGIS Standard Deviational Ellipse Plugin](http://arken.nmbu.no/~havatv/gis/qgisplugins/SDEllipse/)
- *
- * **Bibliography**
- *
- * • Robert S. Yuill, “The Standard Deviational Ellipse; An Updated Tool for
- * Spatial Description,” _Geografiska Annaler_ 53, no. 1 (1971): 28–39,
- * doi:{@link https://doi.org/10.2307/490885|10.2307/490885}.
- *
- * • Paul Hanly Furfey, “A Note on Lefever’s “Standard Deviational Ellipse,”
- * _American Journal of Sociology_ 33, no. 1 (1927): 94—98,
- * doi:{@link https://doi.org/10.1086/214336|10.1086/214336}.
- *
- *
- * @name standardDeviationalEllipse
- * @param {FeatureCollection<Point>} points GeoJSON points
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.weight] the property name used to weight the center
- * @param {number} [options.steps=64] number of steps for the polygon
- * @param {Object} [options.properties={}] properties to pass to the resulting ellipse
- * @returns {Feature<Polygon>} an elliptical Polygon that includes approximately 1 SD of the dataset within it.
- * @example
- *
- * var bbox = [-74, 40.72, -73.98, 40.74];
- * var points = turf.randomPoint(400, {bbox: bbox});
- * var sdEllipse = turf.standardDeviationalEllipse(points);
- *
- * //addToMap
- * var addToMap = [points, sdEllipse];
- *
- */
-function standardDeviationalEllipse(points, options) {
-  // Optional params
-  options = options || {};
-  if (!isObject(options)) throw new Error("options is invalid");
-  var steps = options.steps || 64;
-  var weightTerm = options.weight;
-  var properties = options.properties || {};
-
-  // Validation:
-  if (!isNumber(steps)) throw new Error("steps must be a number");
-  if (!isObject(properties)) throw new Error("properties must be a number");
-
-  // Calculate mean center & number of features:
-  var numberOfFeatures = coordAll(points).length;
-  var meanCenter = centerMean(points, { weight: weightTerm });
-
-  // Calculate angle of rotation:
-  // [X, Y] = mean center of all [x, y].
-  // theta = arctan( (A + B) / C )
-  // A = sum((x - X)^2) - sum((y - Y)^2)
-  // B = sqrt(A^2 + 4(sum((x - X)(y - Y))^2))
-  // C = 2(sum((x - X)(y - Y)))
-
-  var xDeviationSquaredSum = 0;
-  var yDeviationSquaredSum = 0;
-  var xyDeviationSum = 0;
-
-  featureEach(points, function (point) {
-    var weight = point.properties[weightTerm] || 1;
-    var deviation = getDeviations(getCoords(point), getCoords(meanCenter));
-    xDeviationSquaredSum += Math.pow(deviation.x, 2) * weight;
-    yDeviationSquaredSum += Math.pow(deviation.y, 2) * weight;
-    xyDeviationSum += deviation.x * deviation.y * weight;
-  });
-
-  var bigA = xDeviationSquaredSum - yDeviationSquaredSum;
-  var bigB = Math.sqrt(Math.pow(bigA, 2) + 4 * Math.pow(xyDeviationSum, 2));
-  var bigC = 2 * xyDeviationSum;
-  var theta = Math.atan((bigA + bigB) / bigC);
-  var thetaDeg = (theta * 180) / Math.PI;
-
-  // Calculate axes:
-  // sigmaX = sqrt((1 / n - 2) * sum((((x - X) * cos(theta)) - ((y - Y) * sin(theta)))^2))
-  // sigmaY = sqrt((1 / n - 2) * sum((((x - X) * sin(theta)) - ((y - Y) * cos(theta)))^2))
-  var sigmaXsum = 0;
-  var sigmaYsum = 0;
-  var weightsum = 0;
-  featureEach(points, function (point) {
-    var weight = point.properties[weightTerm] || 1;
-    var deviation = getDeviations(getCoords(point), getCoords(meanCenter));
-    sigmaXsum +=
-      Math.pow(
-        deviation.x * Math.cos(theta) - deviation.y * Math.sin(theta),
-        2
-      ) * weight;
-    sigmaYsum +=
-      Math.pow(
-        deviation.x * Math.sin(theta) + deviation.y * Math.cos(theta),
-        2
-      ) * weight;
-    weightsum += weight;
-  });
-
-  var sigmaX = Math.sqrt((2 * sigmaXsum) / weightsum);
-  var sigmaY = Math.sqrt((2 * sigmaYsum) / weightsum);
-
-  var theEllipse = ellipse(meanCenter, sigmaX, sigmaY, {
-    units: "degrees",
-    angle: thetaDeg,
-    steps: steps,
-    properties: properties,
-  });
-  var pointsWithinEllipse = pointsWithinPolygon(
-    points,
-    featureCollection([theEllipse])
-  );
-  var standardDeviationalEllipseProperties = {
-    meanCenterCoordinates: getCoords(meanCenter),
-    semiMajorAxis: sigmaX,
-    semiMinorAxis: sigmaY,
-    numberOfFeatures: numberOfFeatures,
-    angle: thetaDeg,
-    percentageWithinEllipse:
-      (100 * coordAll(pointsWithinEllipse).length) / numberOfFeatures,
-  };
-  theEllipse.properties.standardDeviationalEllipse = standardDeviationalEllipseProperties;
-
-  return theEllipse;
-}
-
-/**
- * Get x_i - X and y_i - Y
- *
- * @private
- * @param {Array} coordinates Array of [x_i, y_i]
- * @param {Array} center Array of [X, Y]
- * @returns {Object} { x: n, y: m }
- */
-function getDeviations(coordinates, center) {
-  return {
-    x: coordinates[0] - center[0],
-    y: coordinates[1] - center[1],
-  };
-}
-
-export default standardDeviationalEllipse;

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,160 +0,0 @@
-'use strict';
-
-var meta = require('@turf/meta');
-var invariant = require('@turf/invariant');
-var helpers = require('@turf/helpers');
-var centerMean = require('@turf/center-mean');
-var pointsWithinPolygon = require('@turf/points-within-polygon');
-var ellipse = require('@turf/ellipse');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var centerMean__default = /*#__PURE__*/_interopDefaultLegacy(centerMean);
-var pointsWithinPolygon__default = /*#__PURE__*/_interopDefaultLegacy(pointsWithinPolygon);
-var ellipse__default = /*#__PURE__*/_interopDefaultLegacy(ellipse);
-
-/**
- * Takes a {@link FeatureCollection} and returns a standard deviational ellipse,
- * also known as a “directional distribution.” The standard deviational ellipse
- * aims to show the direction and the distribution of a dataset by drawing
- * an ellipse that contains about one standard deviation’s worth (~ 70%) of the
- * data.
- *
- * This module mirrors the functionality of [Directional Distribution](http://desktop.arcgis.com/en/arcmap/10.3/tools/spatial-statistics-toolbox/directional-distribution.htm)
- * in ArcGIS and the [QGIS Standard Deviational Ellipse Plugin](http://arken.nmbu.no/~havatv/gis/qgisplugins/SDEllipse/)
- *
- * **Bibliography**
- *
- * • Robert S. Yuill, “The Standard Deviational Ellipse; An Updated Tool for
- * Spatial Description,” _Geografiska Annaler_ 53, no. 1 (1971): 28–39,
- * doi:{@link https://doi.org/10.2307/490885|10.2307/490885}.
- *
- * • Paul Hanly Furfey, “A Note on Lefever’s “Standard Deviational Ellipse,”
- * _American Journal of Sociology_ 33, no. 1 (1927): 94—98,
- * doi:{@link https://doi.org/10.1086/214336|10.1086/214336}.
- *
- *
- * @name standardDeviationalEllipse
- * @param {FeatureCollection<Point>} points GeoJSON points
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.weight] the property name used to weight the center
- * @param {number} [options.steps=64] number of steps for the polygon
- * @param {Object} [options.properties={}] properties to pass to the resulting ellipse
- * @returns {Feature<Polygon>} an elliptical Polygon that includes approximately 1 SD of the dataset within it.
- * @example
- *
- * var bbox = [-74, 40.72, -73.98, 40.74];
- * var points = turf.randomPoint(400, {bbox: bbox});
- * var sdEllipse = turf.standardDeviationalEllipse(points);
- *
- * //addToMap
- * var addToMap = [points, sdEllipse];
- *
- */
-function standardDeviationalEllipse(points, options) {
-  // Optional params
-  options = options || {};
-  if (!helpers.isObject(options)) throw new Error("options is invalid");
-  var steps = options.steps || 64;
-  var weightTerm = options.weight;
-  var properties = options.properties || {};
-
-  // Validation:
-  if (!helpers.isNumber(steps)) throw new Error("steps must be a number");
-  if (!helpers.isObject(properties)) throw new Error("properties must be a number");
-
-  // Calculate mean center & number of features:
-  var numberOfFeatures = meta.coordAll(points).length;
-  var meanCenter = centerMean__default['default'](points, { weight: weightTerm });
-
-  // Calculate angle of rotation:
-  // [X, Y] = mean center of all [x, y].
-  // theta = arctan( (A + B) / C )
-  // A = sum((x - X)^2) - sum((y - Y)^2)
-  // B = sqrt(A^2 + 4(sum((x - X)(y - Y))^2))
-  // C = 2(sum((x - X)(y - Y)))
-
-  var xDeviationSquaredSum = 0;
-  var yDeviationSquaredSum = 0;
-  var xyDeviationSum = 0;
-
-  meta.featureEach(points, function (point) {
-    var weight = point.properties[weightTerm] || 1;
-    var deviation = getDeviations(invariant.getCoords(point), invariant.getCoords(meanCenter));
-    xDeviationSquaredSum += Math.pow(deviation.x, 2) * weight;
-    yDeviationSquaredSum += Math.pow(deviation.y, 2) * weight;
-    xyDeviationSum += deviation.x * deviation.y * weight;
-  });
-
-  var bigA = xDeviationSquaredSum - yDeviationSquaredSum;
-  var bigB = Math.sqrt(Math.pow(bigA, 2) + 4 * Math.pow(xyDeviationSum, 2));
-  var bigC = 2 * xyDeviationSum;
-  var theta = Math.atan((bigA + bigB) / bigC);
-  var thetaDeg = (theta * 180) / Math.PI;
-
-  // Calculate axes:
-  // sigmaX = sqrt((1 / n - 2) * sum((((x - X) * cos(theta)) - ((y - Y) * sin(theta)))^2))
-  // sigmaY = sqrt((1 / n - 2) * sum((((x - X) * sin(theta)) - ((y - Y) * cos(theta)))^2))
-  var sigmaXsum = 0;
-  var sigmaYsum = 0;
-  var weightsum = 0;
-  meta.featureEach(points, function (point) {
-    var weight = point.properties[weightTerm] || 1;
-    var deviation = getDeviations(invariant.getCoords(point), invariant.getCoords(meanCenter));
-    sigmaXsum +=
-      Math.pow(
-        deviation.x * Math.cos(theta) - deviation.y * Math.sin(theta),
-        2
-      ) * weight;
-    sigmaYsum +=
-      Math.pow(
-        deviation.x * Math.sin(theta) + deviation.y * Math.cos(theta),
-        2
-      ) * weight;
-    weightsum += weight;
-  });
-
-  var sigmaX = Math.sqrt((2 * sigmaXsum) / weightsum);
-  var sigmaY = Math.sqrt((2 * sigmaYsum) / weightsum);
-
-  var theEllipse = ellipse__default['default'](meanCenter, sigmaX, sigmaY, {
-    units: "degrees",
-    angle: thetaDeg,
-    steps: steps,
-    properties: properties,
-  });
-  var pointsWithinEllipse = pointsWithinPolygon__default['default'](
-    points,
-    helpers.featureCollection([theEllipse])
-  );
-  var standardDeviationalEllipseProperties = {
-    meanCenterCoordinates: invariant.getCoords(meanCenter),
-    semiMajorAxis: sigmaX,
-    semiMinorAxis: sigmaY,
-    numberOfFeatures: numberOfFeatures,
-    angle: thetaDeg,
-    percentageWithinEllipse:
-      (100 * meta.coordAll(pointsWithinEllipse).length) / numberOfFeatures,
-  };
-  theEllipse.properties.standardDeviationalEllipse = standardDeviationalEllipseProperties;
-
-  return theEllipse;
-}
-
-/**
- * Get x_i - X and y_i - Y
- *
- * @private
- * @param {Array} coordinates Array of [x_i, y_i]
- * @param {Array} center Array of [X, Y]
- * @returns {Object} { x: n, y: m }
- */
-function getDeviations(coordinates, center) {
-  return {
-    x: coordinates[0] - center[0],
-    y: coordinates[1] - center[1],
-  };
-}
-
-module.exports = standardDeviationalEllipse;
-module.exports.default = standardDeviationalEllipse;