-
Notifications
You must be signed in to change notification settings - Fork 29
[DOCS] Add bathymetry guide page documenting deeper-than coverage semantics #480
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+46
−2
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
62c7c1e
Add bathymetry guide page documenting deeper-than coverage semantics
atiannicelli 5d4d4ee
Remove pipeline implementation detail from bathymetry guide
atiannicelli f224314
Potential fix for pull request finding
atiannicelli 7143623
Exclude terminology false positives in textlint config
atiannicelli e782fa3
Merge remote-tracking branch 'origin/main' into atiannicelli-bathymet…
atiannicelli 08fa0d8
Update docs/guides/base/bathymetry.mdx
atiannicelli 710eae7
Update docs/guides/base/bathymetry.mdx
atiannicelli e9d6b23
Update docs/guides/base/bathymetry.mdx
atiannicelli File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| title: Bathymetry | ||
| description: Underwater depth features in the base theme and how their coverage is defined | ||
| pagination_label: Base Bathymetry | ||
| --- | ||
|
|
||
| # Bathymetry | ||
|
|
||
| The base theme's **bathymetry** feature type provides topographic representations of underwater areas, such as parts of lake beds or ocean floors. The geometries are derived from vectorized bathymetric data products built from [ETOPO1](https://www.ncei.noaa.gov/products/etopo-global-relief-model) and [GLOBathy](https://www.nature.com/articles/s41597-022-01132-9) data. | ||
|
|
||
| Bathymetry features carry Polygon or MultiPolygon geometries and a single classifying property, `depth`, which gives the depth level of the feature in meters below the water surface. See the [bathymetry schema reference](/schema/reference/base/bathymetry/) for the full column definitions. | ||
|
|
||
| ## Stacked depth levels | ||
|
|
||
| Bathymetry is delivered as a set of **stacked depth levels**. Each depth level is a coverage polygon set: the features with `depth = d` together cover every point of the earth's surface where the water is **deeper than** `d` meters. | ||
|
|
||
| Practically, this means entities with a lower `depth` will always totally cover entities with a higher `depth`: | ||
|
|
||
| - `depth = 0` covers all water — oceans and the lakes captured by GLOBathy. | ||
| - `depth = 200` covers only the water that is deeper than 200 m. | ||
| - `depth = 4000` covers only the water that is deeper than 4000 m. | ||
|
|
||
| A point on the ocean floor at 3,500 m depth is therefore covered by every level from 0 up to the deepest level shallower than 3,500 m. Land is not covered by any level. | ||
|
|
||
| To render a classic bathymetric tint map, draw the levels stacked from shallow to deep: paint `depth = 0` first in the lightest color, then paint each successively deeper level on top in a darker color. The `cartography.sort_key` property encodes this recommended stacking — features with a lower `sort_key` should be drawn in front of features with a higher `sort_key`. To extract a single disjoint depth *band* instead (for example, water between 200 m and 1000 m deep), subtract the deeper level's coverage from the shallower level's coverage. | ||
|
|
||
| ## Takeaways | ||
|
|
||
| - **Land is not covered.** Bathymetry polygons only exist over water; no masking against land or water layers is needed. | ||
| - **Geometries are grid chips.** Instead of a small number of world-spanning multipolygons, each depth level is delivered as many polygons chipped to a roughly 1° grid, the same way Overture's ocean water polygons are delivered. Spatial filters (for example, `bbox` predicates) are much more effective as a result. | ||
| - **Semantics are "deeper than."** A feature with `depth = d` means "the water here is deeper than `d` meters," and levels overlap by design. Count on multiple features covering the same point — one per depth level shallower than the water at that point. | ||
|
|
||
| ## Data access | ||
|
|
||
| Bathymetry data is available at: | ||
|
|
||
| | provider | location | | ||
| | --- | --- | | ||
| | Amazon S3 | `s3://overturemaps-us-west-2/release/<release>/theme=base/type=bathymetry/*` | | ||
| | Azure Blob Storage | `https://overturemapswestus2.blob.core.windows.net/release/<release>/theme=base/type=bathymetry/*` | | ||
|
|
||
| See the [base guide overview](./index.mdx) for general information about the base theme, including licensing and release cadence. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.