Revamp grid modules #1029

stebogit · 2017-10-18T06:59:08Z

Ref #1019

Removed @turf/square-grid completelyWithin parameter
Renamed cellDiameter to cellSide in all grid modules (Question: what does 'cellSize' geometrically measure in the resulting hex_grid #460)
Centered output of all grid modules (Centered turf-point-grid #613)
Added input validation to @turf/square-grid and @turf/hex-grid
Added properties parameter (passed to the output) to @turf/square-grid and @turf/hex-grid
refactored test for @turf/hex-grid
improve mask option for @turf/point-grid (isobands documentation clarity #1021 (comment))
create Mercator friendly grid features

New ⚠️

Modules which input Point data can simply use an Array<number>.
Optional parameters should be declared initially options.mask => mask
options.mask should have (Multi)Polygon geometry type validation.
Add @turf/truncate to output test results to prevent any precision decimal errors.

New - Improvements ⚠️

Add translate properties to grid features (options.properties)
Add mask to each grid module (options.mask)
Use @turf/boolean-within or @turf/intersect for options.mask

Update fixtures for

@turf/interpolate
@turf/transform-scale

stebogit · 2017-10-18T07:20:42Z

@DenisCarriere I noticed all the grid have projection distortion because of the way the grid elements are created:

Should we modify that and have Mercator-projected grids or we consider these correct outputs?

DenisCarriere · 2017-10-18T15:33:06Z

Should we modify that and have Mercator-projected grids or we consider these correct outputs

👍 Yes I think we should make it Mercator friendly since 98% of users will be using a Leaflet type map to display their geojson.

DenisCarriere · 2017-10-18T15:34:44Z

🤔 ... @stebogit might be best to use a new branch.. lots of conflicts and might be just easier to start a new PR based on the master branch.

I think these conflicts are caused from the @turf/distance earth radius update.

stebogit · 2017-10-19T07:20:02Z

@DenisCarriere I'm not sure what's the correct type definition for mask here, kind of confused between Polygon and Feature<Polygon> 🤔 :

DenisCarriere · 2017-10-21T03:46:34Z

@stebogit Sorry been busy the past days, I'm in Boulder at SOTM now.

The difference between Polygon & Feature<Polygon>:

Polygon is the same as Geometry<Polygon> which would look like this:

{
  type: "Polygon",
  coordinates: Array<number>
}

Feature<Polygon> is the Feature wrapped with the Polygon Geometry.

You can always look at the @types/geojson file to decipher how the GeoJSON.Polygon & GeoJSON.Feature<GeoJSON.Polygon> have been created:
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/geojson/index.d.ts#L68-L71

@turf/helpers tries to replicate an exact match of the GeoJSON type definition, except you don't have to add GeoJSON.<type> you can simply just import it from @turf/helpers.

import {Polygon, Feature} from '@turf/helpers'

DenisCarriere · 2017-10-21T03:53:36Z

packages/turf-point-grid/types.ts

 import pointGrid from './';

 const cellSide = 50;
 const bbox: BBox = [-95, 30, -85, 40];
+const poly: Polygon = polygon([[[20, 30], [10, 10], [20, 20], [20, 30]]]);


@stebogit This is my bad... Polygon was short for Feature<Polygon>, however now Polygon from @turf/helpers is now equivalent to Geometry<Polygon>.

The reason for the error is because mask doesn't handle adding Geometry<Polygon> (which should be a valid input, both Geometry & Feature).

DenisCarriere · 2017-10-21T03:56:06Z

packages/turf-point-grid/index.d.ts

    cellSide: number,
    options?: {
        units?: Units,
        properties?: Properties,
-        bboxIsMask?: boolean;
+        mask?: Polygon|MultiPolygon;


The correct definition would be:

To support both Geometry<Polygon|MultiPolygon> & Feature<Polygon|MultiPolygon>

export default function pointGrid( bbox: BBox, cellSide: number, options?: { units?: Units, properties?: Properties, mask?: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon; } ): FeatureCollection<Point>;

DenisCarriere · 2017-10-21T03:57:06Z

packages/turf-point-grid/index.js

 * @param {Object} [options={}] Optional parameters
 * @param {string} [options.units="kilometers"] used in calculating cellSide, can be degrees, radians, miles, or kilometers
- * @param {number} [options.bboxIsMask=false] if true, and bbox is a Polygon or MultiPolygon, the grid Point will be created
+ * @param {Feature<Polygon|MultiPolygon>} [options.mask=undefined] if passed a Polygon or MultiPolygon, the grid Points will be created only inside it


No need to define the option as undefined, [options.mask] is perfectly fine.

DenisCarriere · 2017-10-21T04:33:11Z

packages/turf-point-grid/index.js

-    var  cellWidth = xFraction * (east - west);
-    var  yFraction = cellSide / (distance(point([west, south]), point([west, north]), options));
-    var  cellHeight = yFraction * (north - south);
+    var xFraction = cellSide / (distance(point([west, south]), point([east, south]), units));


Distance no longer requires the input data to be Point, it can be an Array of numbers.

distance([west, south], [east, south], options)

Also, all modules have changed to the options param syntax, even the ones with 1 param.

DenisCarriere · 2017-10-21T04:34:46Z

packages/turf-point-grid/index.js

-    var properties = options.properties || {};
+    if (!isObject(options)) throw new Error('options is invalid');
+    var units = options.units;
+    var maskIsPoly = options.mask && (getType(options.mask) === 'Polygon' || getType(options.mask) === 'MultiPolygon');


I wouldn't use a maskIsPoly approach, instead add some type validation for the input and call it mask.

DenisCarriere · 2017-10-21T04:36:19Z

packages/turf-point-grid/index.js

-                if (inside(pt, bboxMask)) {
+            var pt = point([currentX, currentY], properties);
+            if (maskIsPoly) {
+                if (inside(pt, options.mask)) {


For all optional parameters, you should use the param name mask instead of options.mask.

stebogit · 2017-10-21T15:30:24Z

Thanks @DenisCarriere! I'll work on Mercator friendly outputs 👍

I'm in Boulder at SOTM now.

How's it goin'?
I'd love to attend one of those meetings, somewhere sometime

DenisCarriere · 2017-10-21T16:52:32Z

at SOTM now.
@stebogit Definitely awesome talks and great people, you should definitely come to the next US one.

DenisCarriere · 2017-10-21T16:52:46Z

I'll work on Mercator friendly outputs

👍 Nice!

DenisCarriere · 2017-10-21T16:58:08Z

Add translate properties to grid features (options.properties)
Add mask to each grid module (options.mask)
Use @turf/boolean-inside and/or @turf/boolean-touches for options.mask

DenisCarriere · 2017-10-23T14:10:07Z

@stebogit Woot 🎉 First passing commit.

Next thing to implement is the Mercator outputs and then I think we are ready to merge this PR.

DenisCarriere · 2017-10-25T15:00:14Z

@stebogit Going to merge this PR, we can do the mercator part on a different PR.

stebogit added 4 commits October 11, 2017 00:35

renames cellDiameter to cellSide; refactored tests;

d7b7fd4

refactores square-grid test; uniforms params acrodd grid modules

b10f448

fixes hex-grid adjusts; fixes tests;

fbff9e7

adds forgotten parenthesis

5707d95

stebogit added breaking-change enhancement major-release refactoring labels Oct 18, 2017

stebogit added this to the 5.0.0 milestone Oct 18, 2017

stebogit self-assigned this Oct 18, 2017

stebogit requested a review from DenisCarriere October 18, 2017 06:59

fises hex-grid types

2a5c4aa

adds big-bbox test to point-grid

34b6fb9

stebogit added 3 commits October 18, 2017 23:17

set bbox type as array for grid modules; refactored test for point-grid;

5aaf371

refactores and fixes test for square-grid;

018a988

Merge branch 'master' into hex-grid

18fb02b

Merge branch 'master' into hex-grid

881b55b

DenisCarriere reviewed Oct 21, 2017

View reviewed changes

DenisCarriere added 2 commits October 20, 2017 21:59

Update typescript definition

07cfbdc

Update cellSide param name & update docs

1e54867

DenisCarriere reviewed Oct 21, 2017

View reviewed changes

Add options.mask validation

2ea3973

DenisCarriere added 6 commits October 21, 2017 11:19

merge maskIsPoly to Input validation

7ebdd2a

Replace inside with boolean-within

d96213e

square-grid - truncate results & add mask

3e7d840

Update test fixtures

3ec679b

Refactor triangle-grid

9e45214

Add boolean-overlap to triangle-grid

3a51a4c

DenisCarriere mentioned this pull request Oct 22, 2017

hex-grid generates unexpected shapes at bounding box size greater than 180 degrees #1035

Closed

DenisCarriere added 9 commits October 22, 2017 23:25

Update hex-grid

8923345

Add contains + overlap

28a59ae

Add contains + overlap square grid

1788bf7

Switch contain + overlap => intersect

c133d06

Add intersect to hex-grid

5c20db3

Add outline to mask

61686bc

Update README's

a2b1651

Fix transform-scale hex output fixture

366eeed

Update interpolate fixtures

49dfb65

Merge branch 'master' into hex-grid

bbdc218

DenisCarriere merged commit d2db3b5 into master Oct 25, 2017

DenisCarriere deleted the hex-grid branch October 25, 2017 15:00

stebogit mentioned this pull request Oct 30, 2017

Unespected scale behavior for large areas that intersect WGS84 boundaries #1059

Open

This was referenced Nov 8, 2017

Question: what does 'cellSize' geometrically measure in the resulting hex_grid #460

Closed

Remove @turf/square-grid "completelyWithin" #1019

Closed

DenisCarriere mentioned this pull request Nov 9, 2017

New major release! Turf 5.0 🎉 #1082

Closed

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revamp grid modules #1029

Revamp grid modules #1029

stebogit commented Oct 18, 2017 •

edited by DenisCarriere

Loading

stebogit commented Oct 18, 2017

DenisCarriere commented Oct 18, 2017 •

edited

Loading

DenisCarriere commented Oct 18, 2017

stebogit commented Oct 19, 2017

DenisCarriere commented Oct 21, 2017

DenisCarriere Oct 21, 2017

DenisCarriere Oct 21, 2017

DenisCarriere Oct 21, 2017

DenisCarriere Oct 21, 2017

DenisCarriere Oct 21, 2017

DenisCarriere Oct 21, 2017

stebogit commented Oct 21, 2017 •

edited

Loading

DenisCarriere commented Oct 21, 2017

DenisCarriere commented Oct 21, 2017

DenisCarriere commented Oct 21, 2017

DenisCarriere commented Oct 23, 2017

DenisCarriere commented Oct 25, 2017

Revamp grid modules #1029

Revamp grid modules #1029

Conversation

stebogit commented Oct 18, 2017 • edited by DenisCarriere Loading

stebogit commented Oct 18, 2017

DenisCarriere commented Oct 18, 2017 • edited Loading

DenisCarriere commented Oct 18, 2017

stebogit commented Oct 19, 2017

DenisCarriere commented Oct 21, 2017

DenisCarriere Oct 21, 2017

Choose a reason for hiding this comment

DenisCarriere Oct 21, 2017

Choose a reason for hiding this comment

DenisCarriere Oct 21, 2017

Choose a reason for hiding this comment

DenisCarriere Oct 21, 2017

Choose a reason for hiding this comment

DenisCarriere Oct 21, 2017

Choose a reason for hiding this comment

DenisCarriere Oct 21, 2017

Choose a reason for hiding this comment

stebogit commented Oct 21, 2017 • edited Loading

DenisCarriere commented Oct 21, 2017

DenisCarriere commented Oct 21, 2017

DenisCarriere commented Oct 21, 2017

DenisCarriere commented Oct 23, 2017

DenisCarriere commented Oct 25, 2017

stebogit commented Oct 18, 2017 •

edited by DenisCarriere

Loading

DenisCarriere commented Oct 18, 2017 •

edited

Loading

stebogit commented Oct 21, 2017 •

edited

Loading