You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@ Given any GeoJSON data, generate a `BitBox` with the provided options.
15
15
Supported options:
16
16
17
17
*`resolution` - The size (width and height) of a "cell" in the same units as the input data.
18
+
*`origin` - By default, `[0, 0]` is considered the origin.
18
19
19
20
### `bitgeo.or(datas, options)`
20
21
@@ -32,14 +33,14 @@ var bitbox = bitgeo(data, options);
32
33
33
34
A bitbox is a (conceptually) rasterized representation of vector data containing information about where data is present and absent.
34
35
35
-
#### `bitbox.getArea()`
36
-
37
-
Returns the area of the bitbox where data is present (this will be an integer multiple of `resolution * resolution`).
38
-
39
36
#### `bitbox.get(i, j)`
40
37
41
38
Test if data is present at the provided location. The `i` and `j` values are offsets from the origin in terms of the bitbox resolution. For example, if a bitbox is created with `resolution: 10`, then `bitbox.get(1, 2)` would return `true` if there is data between `[10, 20]` and `[20, 30]` (with upper bounds being exclusive).
42
39
40
+
#### `bitbox.forEach(callback)`
41
+
42
+
Calls the provided callback for each `true` bit in the bitbox. The callback will be called with `i` and `j` as arguments. If the callback returns `false`, iteration will stop.
43
+
43
44
#### `bitbox.contains(minI, minJ, maxI, maxJ)`
44
45
45
46
Determine if all, some, or none of a range of bits are `true`. Returns `bitgeo.ALL` if all of the bits in the provided range are `true`, `bitgeo.SOME` if some bits are `true` and some are `false`, and `bitgeo.NONE` if all of the bits in the range are `false`. Ranges are inclusive (both min and max values are tested).
@@ -51,3 +52,7 @@ Return a bitbox that is the union of two bitboxes (`bitbox` and `other`).
51
52
#### `bitbox.and(other)`
52
53
53
54
Return a bitbox that is the intersection of two bitboxes (`bitbox` and `other`).
55
+
56
+
#### `bitbox.getArea()`
57
+
58
+
Returns the area of the bitbox where data is present (this will be an integer multiple of `resolution * resolution`).
0 commit comments