Skip to content

Commit

Permalink
project type descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@ElJocho
ElJocho committed Mar 29, 2022
1 parent 126756c commit 2d6b911
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 51 deletions.
8 changes: 0 additions & 8 deletions docs/source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,3 @@ Welcome to MapSwipe Back-End's documentation!
installation
debugging
backup


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
52 changes: 42 additions & 10 deletions docs/source/project_type-buildArea.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Below you can find an example for a created Build Area project in firebase.
"resultCount": 0,
"status": "active",
"tileServer": {
"apiKey": "AopsdXjtTu-IwNoCTiZBtgRJ1g7yPkzAi65nXplc-eLJwZHYlAIf2yuSY_Kjg3Wn",
"apiKey": "",
"credits": "imagery credits of project",
"name": "bing",
"url": "https://ecn.t0.tiles.virtualearth.net/tiles/a{quad_key}.jpeg?g=1&token={key}"
Expand All @@ -79,25 +79,57 @@ Below you can find an example for a created Build Area project in firebase.
"zoomLevel": 18
}
```

### Groups

The grouping algorithm uses the extent of a project as an input and generates chunks of tasks lying next to each other.
Each group has a height of three tasks and a width of approximately 40 tasks.

| Parameter | Description |
|--------------|------------------------------------------------------------------------------------------------------|
| **Geometry** | The Build Area groups save the bounding box coordinates in fields labeled xMax, xMin, yMax and yMin. |

```json
{
"finishedCount" : 0,
"groupId" : "g101",
"numberOfTasks" : 54,
"progress" : 0,
"projectId" : "-MrbXgHx8YJDt6cTIyGA",
"requiredCount" : 3,
"xMax" : "160239",
"xMin" : "160222",
"yMax" : "129763",
"yMin" : "129761"
}
```

### Tasks

Tasks are only saved for tutorials, since their spatial inforamtion can be derived from the spatial extent of the corresponding group.

| Parameter | Description |
|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *Project Type Specific Information* | |
| **Tile Z** | The z coordinate of the tile defines the zoom level. Greater values for z will correspond to higher spatial resolution of the corresponding image. For most regions Bing provides images up to zoom level 18. For aerial imagery or images captured by UAVs even higher z values are valid. |
| **Tile X** | The x coordinate characterises the longitudinal position of the tile in the overall tile map system taken the zoom level into account. The x coordinates increase from west to east starting at a longitude of -180 degrees. |
| **Tile Y** | The y coordinate characterises the latitudinal position of the tile in the overall tile map system taken the zoom level into account. The latitude is clipped to range from circa -85 to 85 degrees. The y coordinates increase from north to south starting at a latitude of around 85 degrees. |
| **Geometry** | Each task has a polygon geometry, which can be generated by its x, y and z coordinates. At the equator the task geometry is a square with an edge length of around 150 metres covering circa 0.0225 square kilometres. Due to the web Mercator projector the task geometry will be clinched with increasing distance to the equator. At the same time the area per task will decrease. |
| **Tile URL** | The tile URL points to the specific tile image described by the x, y, and z coordinates. Usually, the image has a resolution of 256 x 256 pixels. However, some providers also generate image tiles with higher resolution (e.g. 512 x 512 pixels). |

### Groups

The grouping algorithm uses the extent of a project as an input and generates chunks of tasks lying next to each other.
Each group has a height of three tasks and a width of approximately 40 tasks.

| Parameter | Description |
|--------------|------------------------------------------------------------------------------------------------------|
| **Geometry** | The Build Area groups save the bounding box coordinates in fields labeled xMax, xMin, yMax and yMin. |
Below is an example json for a tutorial project, as can be seen on the three extra attributes screen, referenceAnswer and taskID_real.
```json
{
"groupId" : 101,
"projectId" : "tutorial_-MGwrwsP9cTYf6c_Nbg3",
"referenceAnswer" : 0,
"screen" : 1,
"taskId" : "18-100-131072",
"taskId_real" : "18-65040-120545",
"taskX" : 100,
"taskY" : 131072,
"url" : "https://ecn.t0.tiles.virtualearth.net/tiles/a023313133022210002.jpeg?g=7505&mkt=en-US"
}
```

### Results

Expand Down
47 changes: 30 additions & 17 deletions docs/source/project_type-changeDetection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,31 +61,44 @@ Project Structure example for a project which was created via HOT Tasking Manage
"resultCount" : 0,
"status" : "inactive",
"tileServer" : {
"apiKey" : "f57b8754-0d70-4439-bdb4-641beea5c2ec",
"apiKey" : "",
"credits" : "© 2019 Maxar",
"name" : "maxar_premium",
"url" : "https://services.digitalglobe.com/earthservice/tmsaccess/tms/1.0.0/DigitalGlobe%3AImageryTileService@EPSG%3A3857@jpg/{z}/{x}/{y}.jpg?connectId={key}"
},
"tileServerB" : {
"credits" : "© Maxar, MapBox",
"name" : "custom",
"url" : "https://api.mapbox.com/v4/mapboxsatellite.haiti-post-2021/{z}/{x}/{y}.webp?sku=101Fw3jtBuWI5&access_token=pk.eyJ1IjoibWFwYm94c2F0ZWxsaXRlIiwiYSI6ImNqZWZ0MHg0djFqZWoyeG9kN3ZiMmkyd3cifQ.y2HNjGo7FcKQ7psI_BfGqQ"
"url" : "https://api.mapbox.com/v4/mapboxsatellite.haiti-post-2021/{z}/{x}/{y}.webp?sku=101Fw3jtBuWI5"
},
"tutorialId" : "tutorial_-MhJtd9ePFOw8Vs6xwZ2",
"verificationNumber" : 3,
"zoomLevel" : 19
}
```


## Group structure

| Parameter | Description |
|--------------|------------------------------------------------------------------------------------------------------------|
| **Geometry** | The Change Detection groups save the bounding box coordinates in fields labeled xMax, xMin, yMax and yMin. |

## Task structure
```json
{
"finishedCount" : 0,
"groupId" : "g101",
"numberOfTasks" : 24,
"progress" : 0,
"projectId" : "-Mrbd5ArF4lb_GoYG2I5",
"requiredCount" : 3,
"xMax" : "154722",
"xMin" : "154715",
"yMax" : "235151",
"yMin" : "235149"
}
```

## Task structure

| Parameter | Description |
|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -96,19 +109,19 @@ Project Structure example for a project which was created via HOT Tasking Manage
| **URL** | Image for the tile at timestamp A. The tile URL points to the specific tile image described by the x, y, and z coordinates. |
| **URL 2** | Image for the tile after timestamp A. The tile URL points to the specific tile image described by the x, y, and z coordinates. |


## Result Structure
```json
{"OzDyJJ8su8TQtctYVIg9w5tplaX2":
{"data":
{"device":"6a39e920622c4fbb",
"id":"13555_105_298",
"item":"Buildings",
"projectId":13555,
"result":1,
"timestamp":1544613097198,
"user":"OzDyJJ8su8TQtctYVIg9w5tplaX2"
}
}
{
"groupId" : "g101",
"projectId" : "-Mrbd5ArF4lb_GoYG2I5",
"taskId" : "19-154715-235149",
"taskX" : "154715",
"taskY" : "235149",
"url" : "https://services.digitalglobe.com/earthservice/tmsaccess/tms/1.0.0/DigitalGlobe%3AImageryTileService@EPSG%3A3857@jpg/19/154715/289138.jpg",
"urlB" : "https://api.mapbox.com/v4/mapboxsatellite.haiti-post-2021/19/154715/235149.webp?sku=101Fw3jtBuWI5"
}
```

## Result Structure

Results contain information on the user classifications. However, only “Yes” (1), “Maybe” (2) and “Bad Imagery” (3) classifications are stored as results.
Whenever users indicate “No Change” by just swiping to the next task, no data entry is created.
33 changes: 18 additions & 15 deletions docs/source/project_type-footprint.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Project Structure example for a project which was created via HOT Tasking Manage
"filter" : "building=* and geometry:polygon",
"groupMaxSize" : 0,
"groupSize" : 30,
"image" : "https://firebasestorage.googleapis.com/v0/b/dev-mapswipe.appspot.com/o/projectImages%2Fimage.jpeg?alt=media&token=c57beac5-6c6f-4d8f-85e5-9543e5bbeeab",
"image" : "https://firebasestorage.googleapis.com/v0/b/dev-mapswipe.appspot.com/o/projectImages%2Fimage.jpeg?alt=media",
"inputType" : "TMId",
"isFeatured" : false,
"lookFor" : "Buildings",
Expand Down Expand Up @@ -88,9 +88,24 @@ Project Structure example for a project which was created via HOT Tasking Manage
## Group structure

The footprint groups follow the standard group structure.
```json
{
"finishedCount" : 0,
"groupId" : "g100",
"numberOfTasks" : 30,
"progress" : 0,
"projectId" : "-Mq_FxTdV2QJHsxQcvFk",
"requiredCount" : 3
}
```

## Task structure

| Parameter | Description |
|-------------------------------------|----------------------------------------------------------------------------------------|
| *Project Type Specific Information* | |
| **GeoJSON** | Each task has a polygon geometry, which usually outlines a building or another object. |

```json
{
"feature_id" : 0,
Expand All @@ -104,17 +119,5 @@ The footprint groups follow the standard group structure.
```

## Result Structure
```json
{"OzDyJJ8su8TQtctYVIg9w5tplaX2":
{"data":
{"device":"6a39e920622c4fbb",
"id":"13555_105_298",
"item":"Buildings",
"projectId":13555,
"result":1,
"timestamp":1544613097198,
"user":"OzDyJJ8su8TQtctYVIg9w5tplaX2"
}
}
}
```

The Result for a footprint project are explicitly given via the "yes", "no" and "not sure" buttons.
1 change: 0 additions & 1 deletion docs/source/project_type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ They are the key to distribute tasks to MapSwipe users in a way that we can ensu
| *Basic Information* | |
| groupId | ID of the group. |
| numberOfTasks | How many tasks are in each group. |
| progress | |
| projectId | ID of the project the group belongs to. |
| finishedCount | Once a group has been completely mapped by a volunteer the completed count of the corresponding group will be raised by one. The completed count of the group is used to assess the overall progress of each project. <br/>For doing so the completed count is compared to the redundancy required (see Table 2). During the mapping process groups will be served in ascending completed count order. Thus, groups with low completed count will be served first |
| requiredCount | How many volunteers have to map a group. |
Expand Down

0 comments on commit 2d6b911

Please sign in to comment.