Included config for source_id=1

README.md

@@ -18,32 +18,33 @@ Please add a small reasoning around the following points for each proposed merge
 
 ####  `obm_tiles` - Main `OBM Tiles` information
 
-| column_name  | data_type          | description                                    |
+| Column name  | Data type          | Description                                    |
 |--------------|--------------------|------------------------------------------------|
 | quadkey      | text (primary key) | Tile quadkey on a map in EPSG:3857 projection. |
 | completeness | smallint           | Completeness status of the tile.               |
 
 #### `obm_tiles_geometry` - Geometry information about tiles in WGS84
 
-| column_name | data_type               | description                                    |
+| Column name | Data type               | Description                                    |
 |-------------|-------------------------|------------------------------------------------|
 | quadkey     | text (primary key)      | Tile quadkey on a map in EPSG:3857 projection. |
 | geometry    | geometry(Polygon, 4326) | Tile geometry in WGS84 coordinate system.      |
 
 #### `obm_built_area_assessments` - Completeness assessments information.
 
-| column_name     | data_type               | description                                                 |
-|-----------------|-------------------------|-------------------------------------------------------------|
+| Column name     | Data type                | Description                                                        |
+|-----------------|--------------------------|--------------------------------------------------------------------|
 | quadkey         | text (primary key)       | Tile identifier as quadkey.                                        |
 | source_id       | smallint                 | Identifier of the data source.                                     |
 | built_area      | geometry(Geometry, 4326) | Calculated built up geometry in CRS WGS84.                         |
-| built_area_size | float                   | Estimated bult-up area projected to Albers Equal Area.      |
-| built_up_ratio  | float                   | Estimated bult-up ratio compared to source_id = 0 (OBM)     |
+| built_area_size | float                    | Estimated built-up area (Albers Equal Area projection).            |
+| built_up_ratio  | float                    | Estimated built-up ratio compared to source_id = 0 (OBM)           |
+| completeness    | smallint                 | Binary completeness classification (0 = incomplete, 1 = complete)  |
 | last_update     | timestamp                | Date of last update of the record.                                 |
 
 #### `obm_sources` - Completeness assessments information.
 
-| column_name      | data_type       | description                                           |
+| Column name      | Data type       | Description                                           |
 |------------------|-----------------|-------------------------------------------------------|
 | source_id        | smallint        | Continuous number to identify the data source.        |
 | name             | varchar         | Datasource abbreviated name.                          |
@@ -54,7 +55,7 @@ Please add a small reasoning around the following points for each proposed merge
 
 Created and managed by [inyuu](https://git.gfz-potsdam.de/dynamicexposure/openbuildingmap/inyuu):
 
-| column_name | data_type    |
+| Column name | Data type    | 
 |-------------|--------------|
 | name        | varchar(100) |
 | hash        | varchar(60)  |
@@ -66,7 +67,7 @@ Created and managed by [inyuu](https://git.gfz-potsdam.de/dynamicexposure/openbu
 
 The `completeness` value expresses the state of building completeness for a tile.
 
-| value | meaning         |
+| Value | Meaning         |
 |-------|-----------------|
 | `0`   | unknown         |
 | `1`   | complete        |

docs/01_obm_built_area_assessments.md

+# obm_built_area_assessments
+
+The `obm_built_area_assessments` table contains built-up area estimations and automatic completeness assessments based on the output of the [obmgapanalysis](https://git.gfz-potsdam.de/dynamicexposure/openbuildingmap/obmgapanalysis) software. These assessments may come from different source datasets. Currently, the completeness is calculated by comparing the buildings in the [OSM replication database](https://git.gfz-potsdam.de/dynamicexposure/openbuildingmap/database-osmreplication) with the `GHS_BUILT_LDSMT_GLOBE_R2018A` (`source_id = 1`) dataset. More datasources may be added at a later stage.
+
+The quadkeys to be processed with [obmgapanalysis](https://git.gfz-potsdam.de/dynamicexposure/openbuildingmap/obmgapanalysis) were defined by running each country with the [quadtreegrid](https://git.gfz-potsdam.de/dynamicexposure/openbuildingmap/quadtreegrid) package, which makes use of the country boundaries from the [GADM 3.6](https://gadm.org/) dataset. Quadkeys for which the built-up area is zero both in the [GHS_BUILT_LDSMT_GLOBE_R2018A](https://git.gfz-potsdam.de/dynamicexposure/datasources/-/tree/master/GHS_BUILT_LDSMT_GLOBE_R2018A) dataset and the `osm_building_polygons` table of the [OSM replication database](https://git.gfz-potsdam.de/dynamicexposure/openbuildingmap/database-osmreplication) are not stored in `obm_built_area_assessments`.
+
+The `GHS_config.yml` file contains the configuration used to process the quadtiles with the `GHS_BUILT_LDSMT_GLOBE_R2018A`. The most important aspects of it are the usage of all the possible built-up pixel values `[6, 5, 4, 3]`, which means that all construction epochs from GHS are considered together, as well as the integration with the OBM roads database, where all road lines are buffered by 4 meters to each side and then subtracted from the GHS areas.

docs/GHS_config.yml

+datasource:
+  crs: epsg:3857
+  pathname: /app/data/input_datasource
+  raster_files_index: GHS_BUILT_LDSMT_GLOBE_R2018A_3857_30_V2_0.shp
+  built_pixel_values: [6, 5, 4, 3]
+  source_id: 1
+
+tiles:
+  use_txt: True
+  tiles_list: ['122100200320321022']
+  txt_filepath: /app/data/config/tiles_list.txt # point to any tiles list
+
+output_pathname: /app/data/output/csv_results
+obm_output_pathname: /app/data/output/obm_results
+number_cores: 62
+number_cores_import: 4
+batch_size: 10000
+get_geometry: False
+
+roads_database:
+  host: komachi.gfz-potsdam.de
+  dbname: osm_replication
+  port: 5433
+  username: consumer
+  password: # password here
+  roads_table:
+    tablename: osm_roads
+    geometry_field: geometry
+  process_buffer_magnitude: 4.0 # 4.0 meters buffer in crs=epsg:3857
+
+buildings_database:
+  host: komachi.gfz-potsdam.de
+  dbname: osm_replication
+  port: 5433
+  username: consumer
+  password: # password here
+  buildings_table:
+    tablename: osm_building_polygons
+    geometry_field: geometry
+
+target_database:
+  host: nozomi.gfz-potsdam.de
+  dbname: obm_tiles
+  port: 5432
+  username: contributor
+  password: # password here
+  tiles_table:
+    tablename: obm_built_area_assessments
+    geometry_field: built_area