Update README.md

README.md

@@ -27,9 +27,96 @@ A summary of the dataset, grouped by disaster and ordered by area, is included b
 | Champlain Towers Collapse | 0.041536185     | 0.246084846     | 4                 | 1             | Train         |
 | **Total**                 | **67.97693173** | **70.64586393** | **122502**        | **265**       | **N/A**       |
 
-## Dataset Structure
-A complete description of the format of this dataset, and its various files, can be found in [schemas.md](https://huggingface.co/datasets/CRASAR/CRASAR-U-DROIDs/blob/main/schemas.md).
-If you have any questions do not hesitate to contact the authors.
+## Dataset Format
+
+At the top level, the dataset contains a statistics.csv file, with summary statistics of the dataset, and two folders, train and test. 
+Each folder has imagery (which contains all of the geo.tif files) and annotations.
+The imagery folder contains four folders for four sources of imagery: UAS, UAS_DSM, SATELLITE, and CREWED. All imagery is provided as *.geo.tif files at their maximum available resolution. UAS_DSM are digital surface maps (DSMs) generated by the UAS mapping software. Not all runs of the mapping software resulted in valid DSMs, and so only some sUAS imagery have parallel DSMs.
+The annotations folder then contains one folder for each source of imagery (and therefore labels): UAS, SATELLITE, and CREWED. These folders contain the imagery-derived labels from the imagery associated with each of the imagery sources. UAS_DSM imagery was not labeled.
+These folders contain two groups of data: building_alignment_adjustments, and building_damage_assessment.
+These two groups of data contain JSON data that represent the annotations for both building damage assessment and the translational alignments necessary to align the building polygons with the imagery.
+These data sources and schemas are discussed in the [schemas.md](https://huggingface.co/datasets/CRASAR/CRASAR-U-DROIDs/blob/main/schemas.md).
+
+### Building Damage Assessment (BDA)
+A sample of a building damage assessment JSON file is as follows... 
+```json
+[
+  {
+    "view_id": "a75d08c2bcaf852707c66464f5a4abc6",
+    "building_id": "3441f4d81904563bba38da0fd8cea8b4",
+    "label": "major damage",
+    "source": "Microsoft",
+    "boundary": "0827-B-02.geo.tif",
+    "filename": "0827-B-02.geo.tif.json",
+    "jds_version": "1.1",
+    "payload_version": "2.0"
+    "EPSG:4326": [
+      {
+        "lat": 30.092885,
+        "lon": -93.728311
+      },
+      {
+        "lat": 30.092886,
+        "lon": -93.7284
+      },
+      {
+        "lat": 30.092953,
+        "lon": -93.7284
+      },
+      {
+        "lat": 30.092885,
+        "lon": -93.728311
+      }
+    ],
+    "pixels": [
+      {
+        "x": 1999,
+        "y": 13267
+      },
+      {
+        "x": 1776,
+        "y": 13263
+      },
+      {
+        "x": 1777,
+        "y": 13070
+      },
+      {
+        "x": 1999,
+        "y": 13267
+      }
+    ]
+  },
+  ...
+]
+```
+
+Each JSON file contains a list where each entry is a labeled view of a building polygon and contains the following information...
+- The "view_id" field is a string that uniquely identifies this specific view of the building. As the same building may appear in multiple orthomosaics with different labels, the view_id uniquely identifies this specific view and label of the building.
+- The "building_id" field is a string that uniquely identifies this building. As the same building may appear in multiple orthomosaics, this "building_id" can be used to correlate buildings across orthomosaics.
+- The "label" field corresponds to the values of the Joint Damage Scale (JSD). The possible options are "no damage", "minor damage", "major damage", "destroyed", "un-classified", and "obscured". While the JDS does not contain the "obscured" label, this label was added to handle cases where buildings were obscured by clouds, smoke, trees, or other buildings.
+- The "source" field describes the provenance of the building polygon. The possible options are "Microsoft," indicating the building polygon was sourced from the Microsoft Building Footprints dataset, and "custom," indicating the polygons were manually added by the authors.
+- The "boundary" field describes the orthomosaic imagery that was used to define a boundary that determined the inclusion of this polygon in the dataset.
+- The "filename" field describes the json file in which you should find this entry.
+- The "jds_version" field describes the version of JDS that is expected to appear in the "label" field.
+- The "payload_version" field describes the version of the json payload. Previous versions of the dataset did not contain a "payload_version" and this field is used to ensure consistent parsing of dataset content across revisions.
+- The "pixels" field corresponds to the coordinates of the building polygon in the pixel coordinate space of the orthomosaic.
+- The "EPSG:4326" field corresponds to the coordinates of the building polygon in the EPSG:4326 coordinate space.
+
+### Alignment Adjustments for BDA & RDA
+A sample of the alignment adjustment JSON file is as follows...
+```json
+[[[4739.728, 4061.728], [4542.137, 3962.933]], ... ]
+```
+
+Each JSON file is a list of lines, each with a length of two, defined by a 2D coordinate corresponding to an x, y pixel coordinate in the orthomosaic.
+The first list represents all the alignment adjustments for the given orthomosaic.
+The second list represents a set of two points, forming a line, that describes the translational adjustment needed to bring the nearby building polygons or road line vertices into alignment with the imagery.
+
+Each translational adjustment starts with the position in the unadjusted coordinate space that needs to be moved to the following position in order to align the building polygons.
+These translational adjustments are applied to the building polygons and road line vertices by applying the nearest adjustment to each building polygon or road line vertex. 
+Functionally, this forms a vector field that describes the adjustments for an entire orthomosaic.
+This process is described in detail in [[3](https://arxiv.org/abs/2405.06593)].
 
 ## Publications & Documentation