Skip to content

Commit

Permalink
docs: add DEM docs (#60)
Browse files Browse the repository at this point in the history
* docs: add DEM docs

* docs: migrate DEM catalog v1 profile to docusaurus format

* docs: remove unnecessary documentation

* docs: use correct banner for information

* docs: organize tags for DEM

* chore: remove docsify-ignore

* chore: move DEM images into dedicated folder

* docs: add images for 2D DEM
  • Loading branch information
shimoncohen authored Sep 5, 2023
1 parent 9d255ee commit 6dfcbc7
Show file tree
Hide file tree
Showing 15 changed files with 173 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/MapColonies/DEM/Guides/DEM_getting_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: dem-getting-started
slug: dem-getting-started
title: Getting started
tags:
- guide
- DEM
- DTM
- DSM
- terrain
- getting-started
---

## Developer Guide step-by-step
The following guide will help you understand how to work with the DEM sub-system of Map Colonies and how to consume DEM data.
9 changes: 9 additions & 0 deletions docs/MapColonies/DEM/Guides/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "Guides",
"position": 3,
"collapsed": "true",
"link": {
"type": "generated-index",
"description": "DEM Guides"
}
}
44 changes: 44 additions & 0 deletions docs/MapColonies/DEM/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: DEM-overview
slug: dem-overview
title: DEM
sidebar_position: 1
tags:
- DEM
- overview
---

## DEM (DTM / DSM)
A **Digital Elevation Model** is a representation of elevation data that maps the surface of the earth, above a certain datum. There are essentially 2 types of DEM:

* The **Digital Terrain Model (DTM)** represents the raw elevation of the bare earth ground without considering any over-ground features like plants and buildings.

* The **Digital Surface Model (DSM)** represents the elevation of the earth's surface that a remote sensing system will first meet (2.5D “blanket”). Thus, the resulting DSM includes the elevation of the bare earth terrain plus the natural (e.g. trees, shrubs) and artificial man-made features (e.g. buildings, bridges).

<figure>
<img src={require("/img/dem/dtm_dsm.png").default} style={{"display":"block","marginLeft":"auto","marginRight": "auto","width":"90%"}} />
</figure>

DEM can be represented as raster or vector data:

* **Raster** DEM is represented as a 2D grid of uniform sized squares, where each square in the grid has a value that represents the height of the corresponding geographical point (also known as heightmap). This is actually a “2.5D” model, because there is only one height measure for each surface point. Raster DEM can be stored in a number of file formats but is mostly delivered as **GeoTIFF**, a format which in addition to the data contains the size of the raster and the position in geo coordinates, plus projection information.

* **Vector** DEM / Quanitized Mesh is a representation of a continuous surface consisting a mesh of triangular facets. The most common format for Vector DEM is **Triangulated Irregular Network (TIN)**, which contains irregularly distributed nodes and lines (vertices) with X,Y,Z coordinates arranged in a network of non-overlapping triangles. These are meshes that contain only vertices where they define meaningful change in surface height. Vector DEM tiles are rendered more efficiently for displaying it in a 3D view.
<figure>
<img src={require("/img/dem/terrain_tin.png").default} style={{"display": "block","marginLeft": "auto","marginRight": "auto","width":"90%"}} />
</figure>

DEM can be rendered as 2D (raster) or 3D maps:

* In **2D** view, the heights can be rendered as colors (based on some coloring scheme) or displayed as contour lines with hill shades.

<figure>
<img src={require("/img/dem/hillshade_on_raster.png").default} style={{"display": "block","marginLeft": "auto","marginRight": "auto","width": "90%"}} /><br/>
<img src={require("/img/dem/hillshade.png").default} style={{"display": "block","marginLeft": "auto","marginRight": "auto","width": "90%"}} />
</figure>

* In **3D** view, the terrain surface is visualized in an oblique three-dimensional perspective, using raster tiles or TIN mesh tiles. It can be augmented with a satellite imagery to make it look realistic.

<figure>
<img src={require("/img/dem/terrain_on_raster.png").default} style={{"display": "block","marginLeft": "auto","marginRight": "auto","width": "90%"}} />
</figure>
9 changes: 9 additions & 0 deletions docs/MapColonies/DEM/Services/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "Services",
"position": 5,
"collapsed": "false",
"link": {
"type": "generated-index",
"description": "View all DEM Services"
}
}
24 changes: 24 additions & 0 deletions docs/MapColonies/DEM/Services/catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: dem-catalog-service
slug: dem-catalog
title: Catalog 🗃️
tags:
- DEM
- DTM
- DSM
- catalog
- csw
- API
---

# Catalog Service 🗃️
[Catalogue Service for the Web (CSW)](/ogc-protocols/ogc-csw.md) is a standard for exposing a catalogue of geospatial records in XML on the Internet (over HTTP). The catalogue is made up of records that describe geospatial data, geospatial services (e.g. [WMTS](/ogc-protocols/ogc-wmts.md)), and related resources.

| **Request** | **HTTP method binding(s)** |
| ----------- | ----------- |
| GetCapabilities | GET (KVP) / POST (XML) / SOAP |
| DescribeRecord | GET (KVP) / POST (XML) / SOAP |
| GetRecords | GET (KVP) / POST (XML) / SOAP |
| GetRecordById | GET (KVP) / POST (XML) / SOAP |
| GetRepositoryItem | GET (KVP) |
| GetDomain | GET (KVP) / POST (XML) / SOAP |
51 changes: 51 additions & 0 deletions docs/MapColonies/DEM/Services/catalog/profile_v1_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
id: dem-profile-v1
slug: catalog-profile-v1
description: v1 Profile
title: Profile v1
tags:
- DEM
- catalog
- v1
---

# DEM Catalog Profile Information

1. **typename** = `mc:MCDEMRecord`
2. **main_namespace** = `http://schema.mapcolonies.com/dem`
3. The **DEM** sub-system Catalog profile fields with information of each of them:

| **PYCSW Queryable/XML <br/> Element Name** | **Type** | **Description** |
| ----------- | ----------- | ----------- |
| mc:id | text | unique internal catalog item id |
| mc:productId | text | unique external product id |
| mc:productName | text | the product name |
| [mc:productType](#productType) | enum | **Valid Values**: <br/> DTM / DSM / QuantizedMesh / QuantizedMeshDTMBest / QuantizedMeshDSMBest |
| mc:description | text | the product description |
| mc:imagingTimeBeginUTC | date | start imaging date of raw product <br/> supported format: **dd/mm/yyyy (not later than "End date")** |
| mc:imagingTimeEndUTC | date | end imaging date of raw product <br/> supported format: **dd/mm/yyyy (not earlier than "Begin date")** |
| mc:resolutionDeg | double | the product resolution in degrees <br/> double unsigned valid: **0.00000009 to 0.072** |
| mc:resolutionMeter | double | the product resolution in meters <br/> double unsigned valid: **0.01 to 8000** |
| mc:absoluteAccuracyLEP90 | double | LEP90 maximum absolute vertical plane accuracy range in meters |
| mc:relativeAccuracyLEP90 | double | LEP90 maximum relative vertical plane accuracy range in meters |
| mc:sensors | text | list of sensors used as a source for the product <br/> comma separated list |
| mc:layerPolygonParts | geojson | polygons of the discrete parts (versions) and the list of layers in the best converted to Geojson |
| mc:footprint | geojson | geographical delineation of the product / model trace |
| mc:heightRangeFrom | double | **minimum** height range in Meters (not greater than "heightRangeTo") <br /> valid: **-500 to 9000** |
| mc:heightRangeTo | double | **maximum** height range in Meters (not less than "heightRangeFrom") <br /> valid: **-500 to 9000** |
| mc:SRS | int | reference System ID (EPSG), <br /> ex: 4326 / 3857 |
| mc:SRSName | text | name of reference system |
| mc:verticalDatum | enum | **Valid Values**: <br/> WGS 1984 / WGS 1972 / Pulkovo 1942 / Palestine 1923 / MSL Height / Israel / ED 1950 IDF |
| mc:region | text | sector / countries <br/> comma separated list |
| mc:classification | enum | product classification / confidentiality <br /> [Classification values](/classified/dem/classification_table.md) |
| mc:producerName | text | manufacturer / organization that produced / supplied the product |
| mc:units | enum | **Valid Values**: <br/> METER / DD / DMS / ARC_SECONDS / UNKNOWN |
| mc:geographicArea | text | geographic area cities |
| mc:undulationModel | enum | **Valid Values**: <br/> MSL EGM96 / MSL EGM2008 / MSL DMA10 / ILUM |
| mc:dataType | enum | **Valid Values**: <br/> FLOAT64 / FLOAT32 / FLOAT16 / INT64 / INT32 / INT16 / INT8 |
| mc:noDataValue | enum | **Valid Values**: <br/> -32768 / -326767 / -999 |
| mc:productBBox | text | the bounding box of the product minX,minY,maxX,maxY |
| mc:insertDate | date | the date when item was added to catalog |
| mc:keywords | text | list of key words relevant for product |
| mc:updateDateUTC | date | date the record got and update in catalog <br/> supported format: **dd/mm/yyyy** |
| mc:type | enum | type of the catalog <br /> **Valid values**: RECORD_RASTER / RECORD_3D / RECORD_DEM <br /> default: ***RECORD_DEM***|
4 changes: 4 additions & 0 deletions docs/MapColonies/DEM/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 6,
"collapsed": "true"
}
4 changes: 4 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ const config = {
label: '3D',
to: '/docs/MapColonies/3D/3d-overview'
},
{
label: 'DEM',
to: '/docs/MapColonies/DEM/dem-overview'
},
],
},
{
Expand Down
13 changes: 13 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,19 @@ const sidebars = {
},
]
},
{
type: 'category',
label: 'DEM',
collapsed: false,
collapsible: true,
items: [
{
type: 'doc',
label: 'Getting Started',
id: 'MapColonies/DEM/Guides/dem-getting-started'
},
]
},
]
}
]
Expand Down
File renamed without changes
File renamed without changes
Binary file added static/img/dem/hillshade.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/dem/hillshade_on_raster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes

0 comments on commit 6dfcbc7

Please sign in to comment.