Skip to content

Commit 2d6b911

Browse files
ElJochoElJocho
committed
project type descriptions
1 parent 126756c commit 2d6b911

File tree

5 files changed

+90
-51
lines changed

5 files changed

+90
-51
lines changed

‎docs/source/index.rst‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,3 @@ Welcome to MapSwipe Back-End's documentation!
4545
installation
4646
debugging
4747
backup
48-
49-
50-
Indices and tables
51-
==================
52-
53-
* :ref:`genindex`
54-
* :ref:`modindex`
55-
* :ref:`search`

‎docs/source/project_type-buildArea.md‎

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Below you can find an example for a created Build Area project in firebase.
6969
"resultCount": 0,
7070
"status": "active",
7171
"tileServer": {
72-
"apiKey": "AopsdXjtTu-IwNoCTiZBtgRJ1g7yPkzAi65nXplc-eLJwZHYlAIf2yuSY_Kjg3Wn",
72+
"apiKey": "",
7373
"credits": "imagery credits of project",
7474
"name": "bing",
7575
"url": "https://ecn.t0.tiles.virtualearth.net/tiles/a{quad_key}.jpeg?g=1&token={key}"
@@ -79,25 +79,57 @@ Below you can find an example for a created Build Area project in firebase.
7979
"zoomLevel": 18
8080
}
8181
```
82+
83+
### Groups
84+
85+
The grouping algorithm uses the extent of a project as an input and generates chunks of tasks lying next to each other.
86+
Each group has a height of three tasks and a width of approximately 40 tasks.
87+
88+
| Parameter | Description |
89+
|--------------|------------------------------------------------------------------------------------------------------|
90+
| **Geometry** | The Build Area groups save the bounding box coordinates in fields labeled xMax, xMin, yMax and yMin. |
91+
92+
```json
93+
{
94+
"finishedCount" : 0,
95+
"groupId" : "g101",
96+
"numberOfTasks" : 54,
97+
"progress" : 0,
98+
"projectId" : "-MrbXgHx8YJDt6cTIyGA",
99+
"requiredCount" : 3,
100+
"xMax" : "160239",
101+
"xMin" : "160222",
102+
"yMax" : "129763",
103+
"yMin" : "129761"
104+
}
105+
```
106+
82107
### Tasks
83108

109+
Tasks are only saved for tutorials, since their spatial inforamtion can be derived from the spatial extent of the corresponding group.
110+
84111
| Parameter | Description |
85112
|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
86113
| *Project Type Specific Information* | |
87-
| **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. |
88114
| **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. |
89115
| **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. |
90116
| **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. |
91117
| **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). |
92118

93-
### Groups
94-
95-
The grouping algorithm uses the extent of a project as an input and generates chunks of tasks lying next to each other.
96-
Each group has a height of three tasks and a width of approximately 40 tasks.
97-
98-
| Parameter | Description |
99-
|--------------|------------------------------------------------------------------------------------------------------|
100-
| **Geometry** | The Build Area groups save the bounding box coordinates in fields labeled xMax, xMin, yMax and yMin. |
119+
Below is an example json for a tutorial project, as can be seen on the three extra attributes screen, referenceAnswer and taskID_real.
120+
```json
121+
{
122+
"groupId" : 101,
123+
"projectId" : "tutorial_-MGwrwsP9cTYf6c_Nbg3",
124+
"referenceAnswer" : 0,
125+
"screen" : 1,
126+
"taskId" : "18-100-131072",
127+
"taskId_real" : "18-65040-120545",
128+
"taskX" : 100,
129+
"taskY" : 131072,
130+
"url" : "https://ecn.t0.tiles.virtualearth.net/tiles/a023313133022210002.jpeg?g=7505&mkt=en-US"
131+
}
132+
```
101133

102134
### Results
103135

‎docs/source/project_type-changeDetection.md‎

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,31 +61,44 @@ Project Structure example for a project which was created via HOT Tasking Manage
6161
"resultCount" : 0,
6262
"status" : "inactive",
6363
"tileServer" : {
64-
"apiKey" : "f57b8754-0d70-4439-bdb4-641beea5c2ec",
64+
"apiKey" : "",
6565
"credits" : "© 2019 Maxar",
6666
"name" : "maxar_premium",
6767
"url" : "https://services.digitalglobe.com/earthservice/tmsaccess/tms/1.0.0/DigitalGlobe%3AImageryTileService@EPSG%3A3857@jpg/{z}/{x}/{y}.jpg?connectId={key}"
6868
},
6969
"tileServerB" : {
7070
"credits" : "© Maxar, MapBox",
7171
"name" : "custom",
72-
"url" : "https://api.mapbox.com/v4/mapboxsatellite.haiti-post-2021/{z}/{x}/{y}.webp?sku=101Fw3jtBuWI5&access_token=pk.eyJ1IjoibWFwYm94c2F0ZWxsaXRlIiwiYSI6ImNqZWZ0MHg0djFqZWoyeG9kN3ZiMmkyd3cifQ.y2HNjGo7FcKQ7psI_BfGqQ"
72+
"url" : "https://api.mapbox.com/v4/mapboxsatellite.haiti-post-2021/{z}/{x}/{y}.webp?sku=101Fw3jtBuWI5"
7373
},
7474
"tutorialId" : "tutorial_-MhJtd9ePFOw8Vs6xwZ2",
7575
"verificationNumber" : 3,
7676
"zoomLevel" : 19
7777
}
7878
```
7979

80-
8180
## Group structure
8281

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

87-
## Task structure
86+
```json
87+
{
88+
"finishedCount" : 0,
89+
"groupId" : "g101",
90+
"numberOfTasks" : 24,
91+
"progress" : 0,
92+
"projectId" : "-Mrbd5ArF4lb_GoYG2I5",
93+
"requiredCount" : 3,
94+
"xMax" : "154722",
95+
"xMin" : "154715",
96+
"yMax" : "235151",
97+
"yMin" : "235149"
98+
}
99+
```
88100

101+
## Task structure
89102

90103
| Parameter | Description |
91104
|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -96,19 +109,19 @@ Project Structure example for a project which was created via HOT Tasking Manage
96109
| **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. |
97110
| **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. |
98111

99-
100-
## Result Structure
101112
```json
102-
{"OzDyJJ8su8TQtctYVIg9w5tplaX2":
103-
{"data":
104-
{"device":"6a39e920622c4fbb",
105-
"id":"13555_105_298",
106-
"item":"Buildings",
107-
"projectId":13555,
108-
"result":1,
109-
"timestamp":1544613097198,
110-
"user":"OzDyJJ8su8TQtctYVIg9w5tplaX2"
111-
}
112-
}
113+
{
114+
"groupId" : "g101",
115+
"projectId" : "-Mrbd5ArF4lb_GoYG2I5",
116+
"taskId" : "19-154715-235149",
117+
"taskX" : "154715",
118+
"taskY" : "235149",
119+
"url" : "https://services.digitalglobe.com/earthservice/tmsaccess/tms/1.0.0/DigitalGlobe%3AImageryTileService@EPSG%3A3857@jpg/19/154715/289138.jpg",
120+
"urlB" : "https://api.mapbox.com/v4/mapboxsatellite.haiti-post-2021/19/154715/235149.webp?sku=101Fw3jtBuWI5"
113121
}
114122
```
123+
124+
## Result Structure
125+
126+
Results contain information on the user classifications. However, only “Yes” (1), “Maybe” (2) and “Bad Imagery” (3) classifications are stored as results.
127+
Whenever users indicate “No Change” by just swiping to the next task, no data entry is created.

‎docs/source/project_type-footprint.md‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Project Structure example for a project which was created via HOT Tasking Manage
5656
"filter" : "building=* and geometry:polygon",
5757
"groupMaxSize" : 0,
5858
"groupSize" : 30,
59-
"image" : "https://firebasestorage.googleapis.com/v0/b/dev-mapswipe.appspot.com/o/projectImages%2Fimage.jpeg?alt=media&token=c57beac5-6c6f-4d8f-85e5-9543e5bbeeab",
59+
"image" : "https://firebasestorage.googleapis.com/v0/b/dev-mapswipe.appspot.com/o/projectImages%2Fimage.jpeg?alt=media",
6060
"inputType" : "TMId",
6161
"isFeatured" : false,
6262
"lookFor" : "Buildings",
@@ -88,9 +88,24 @@ Project Structure example for a project which was created via HOT Tasking Manage
8888
## Group structure
8989

9090
The footprint groups follow the standard group structure.
91+
```json
92+
{
93+
"finishedCount" : 0,
94+
"groupId" : "g100",
95+
"numberOfTasks" : 30,
96+
"progress" : 0,
97+
"projectId" : "-Mq_FxTdV2QJHsxQcvFk",
98+
"requiredCount" : 3
99+
}
100+
```
91101

92102
## Task structure
93103

104+
| Parameter | Description |
105+
|-------------------------------------|----------------------------------------------------------------------------------------|
106+
| *Project Type Specific Information* | |
107+
| **GeoJSON** | Each task has a polygon geometry, which usually outlines a building or another object. |
108+
94109
```json
95110
{
96111
"feature_id" : 0,
@@ -104,17 +119,5 @@ The footprint groups follow the standard group structure.
104119
```
105120

106121
## Result Structure
107-
```json
108-
{"OzDyJJ8su8TQtctYVIg9w5tplaX2":
109-
{"data":
110-
{"device":"6a39e920622c4fbb",
111-
"id":"13555_105_298",
112-
"item":"Buildings",
113-
"projectId":13555,
114-
"result":1,
115-
"timestamp":1544613097198,
116-
"user":"OzDyJJ8su8TQtctYVIg9w5tplaX2"
117-
}
118-
}
119-
}
120-
```
122+
123+
The Result for a footprint project are explicitly given via the "yes", "no" and "not sure" buttons.

‎docs/source/project_type.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ They are the key to distribute tasks to MapSwipe users in a way that we can ensu
9898
| *Basic Information* | |
9999
| groupId | ID of the group. |
100100
| numberOfTasks | How many tasks are in each group. |
101-
| progress | |
102101
| projectId | ID of the project the group belongs to. |
103102
| 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 |
104103
| requiredCount | How many volunteers have to map a group. |

0 commit comments

Comments
 (0)