Merge pull request #441 from mapswipe/feature-tutorial-for-footprint-type

add workflow to create footprint project tutorial

Author: Hagellach37

mapswipe_workers/mapswipe_workers/definitions.py

@@ -145,6 +145,9 @@ def constructor(self):
     @property
     def tutorial(self):
         # Imports are first made once this method get called to avoid circular imports.
+        from mapswipe_workers.project_types.arbitrary_geometry.tutorial import (
+            Tutorial as ArbitraryGeometriesTutorial,
+        )
         from mapswipe_workers.project_types.tile_map_service_grid.tutorial import (
             Tutorial as tmsg_tutorial,
         )
@@ -156,7 +159,7 @@ def tutorial(self):
 
         project_type_classes = {
             1: tmsg_tutorial,
-            # 2: ArbitraryGeometriesTutorial,
+            2: ArbitraryGeometriesTutorial,
             3: tmsg_tutorial,
             4: tmsg_tutorial,
         }

mapswipe_workers/mapswipe_workers/project_types/arbitrary_geometry/group.py

@@ -9,7 +9,12 @@ def __init__(self, project: object, groupId: int) -> None:
         super().__init__(project, groupId)
 
     def create_tasks(
-        self, feature_ids: List, feature_geometries: List, center_points: List
+        self,
+        feature_ids: List,
+        feature_geometries: List,
+        center_points: List,
+        reference: List,
+        screen: List,
     ) -> None:
         """Create tasks for a group
 
@@ -19,6 +24,13 @@ def create_tasks(
         Every coordinate pair is a vertex.
         """
         for i in range(0, len(feature_ids)):
-            task = Task(self, feature_ids[i], feature_geometries[i], center_points[i])
+            task = Task(
+                self,
+                feature_ids[i],
+                feature_geometries[i],
+                center_points[i],
+                reference[i],
+                screen[i],
+            )
             self.tasks.append(task)
         self.numberOfTasks = len(self.tasks)

mapswipe_workers/mapswipe_workers/project_types/arbitrary_geometry/grouping_functions.py

@@ -66,6 +66,8 @@ def group_input_geometries(input_geometries_file, group_size):
                 "feature_ids": [],
                 "feature_geometries": [],
                 "center_points": [],
+                "reference": [],
+                "screen": [],
             }
 
         groups[group_id_string]["feature_ids"].append(feature.GetFID())
@@ -79,6 +81,16 @@ def group_input_geometries(input_geometries_file, group_size):
         except:  # noqa
             groups[group_id_string]["center_points"].append([])
 
+        # this is relevant for the tutorial
+        try:
+            reference = feature.GetFieldAsDouble("reference")
+            screen = feature.GetFieldAsDouble("screen")
+            groups[group_id_string]["reference"].append(reference)
+            groups[group_id_string]["screen"].append(screen)
+        except:  # noqa
+            groups[group_id_string]["reference"].append(None)
+            groups[group_id_string]["screen"].append(None)
+
     return groups
 
 

mapswipe_workers/mapswipe_workers/project_types/arbitrary_geometry/project.py

@@ -145,7 +145,11 @@ def create_groups(self):
         for group_id, item in raw_groups.items():
             group = Group(self, group_id)
             group.create_tasks(
-                item["feature_ids"], item["feature_geometries"], item["center_points"]
+                item["feature_ids"],
+                item["feature_geometries"],
+                item["center_points"],
+                item["reference"],
+                item["screen"],
             )
 
             # only append valid groups

mapswipe_workers/mapswipe_workers/project_types/arbitrary_geometry/task.py

@@ -7,7 +7,13 @@
 
 class Task(BaseTask):
     def __init__(
-        self, group: object, featureId: int, featureGeometry: Dict, center: List
+        self,
+        group: object,
+        featureId: int,
+        featureGeometry: Dict,
+        center: List,
+        reference: int,
+        screen: int,
     ):
         """
         Parameters
@@ -21,7 +27,13 @@ def __init__(
         task_id = f"t{featureId}"
         super().__init__(group, taskId=task_id)
         self.geojson = featureGeometry
-        self.center = center
+
+        if center is not None:
+            self.center = center
+
+        if screen is not None:
+            self.screen = screen
+            self.reference = reference
 
         # Remove projectId and groupId for tasks of Footprint project type
         del self.projectId

mapswipe_workers/mapswipe_workers/project_types/arbitrary_geometry/tutorial.py

@@ -0,0 +1,72 @@
+import json
+
+from mapswipe_workers.definitions import DATA_PATH, logger
+from mapswipe_workers.project_types.arbitrary_geometry import grouping_functions as g
+from mapswipe_workers.project_types.arbitrary_geometry.group import Group
+from mapswipe_workers.project_types.base.tile_server import BaseTileServer
+from mapswipe_workers.project_types.base.tutorial import BaseTutorial
+
+
+class Tutorial(BaseTutorial):
+    """The subclass for an TMS Grid based Tutorial."""
+
+    def __init__(self, tutorial_draft):
+        # this will create the basis attributes
+        super().__init__(tutorial_draft)
+
+        self.projectType = tutorial_draft["projectType"]
+        self.zoomLevel = int(tutorial_draft.get("zoomLevel", 18))
+        self.tileServer = vars(BaseTileServer(tutorial_draft["tileServer"]))
+        self.tutorial_tasks = tutorial_draft["tutorialTasks"]
+        self.groups = dict()
+        self.tasks = []
+
+        # save tasks as geojson
+        self.inputGeometries = (
+            f"{DATA_PATH}/" f"input_geometries/valid_input_{self.projectId}.geojson"
+        )
+
+        with open(self.inputGeometries, "w") as f:
+            json.dump(self.tutorial_tasks, f)
+
+    def create_tutorial_groups(self):
+        """Create group for the tutorial based on provided examples in geojson file."""
+        # load examples/tasks from file
+
+        # create the groups dict to be uploaded in Firebase
+        self.groups = dict()
+
+        group = Group(self, groupId=101)
+        self.groups[101] = vars(group)
+
+        logger.info(
+            f"{self.projectId}"
+            f" - create_tutorial_groups - "
+            f"created groups dictionary"
+        )
+
+    def create_tutorial_tasks(self):
+        """Create the tasks dict based on provided examples in geojson file."""
+
+        raw_groups = g.group_input_geometries(
+            self.inputGeometries, len(self.tutorial_tasks) + 1
+        )
+        for group_id, item in raw_groups.items():
+            group = Group(self, groupId=101)
+            group.create_tasks(
+                item["feature_ids"],
+                item["feature_geometries"],
+                item["center_points"],
+                item["reference"],
+                item["screen"],
+            )
+
+        for task in group.tasks:
+            logger.info(task)
+            self.tasks.append(vars(task))
+
+        logger.info(
+            f"{self.projectId}"
+            f" - create_tutorial_tasks - "
+            f"created tasks dictionary"
+        )

mapswipe_workers/mapswipe_workers/project_types/base/tutorial.py

@@ -1,7 +1,10 @@
+import base64
+import json
 from abc import ABCMeta, abstractmethod
 
 from mapswipe_workers import auth
-from mapswipe_workers.definitions import CustomError, logger
+from mapswipe_workers.definitions import CustomError, ProjectType, logger
+from mapswipe_workers.utils import gzip_str
 
 
 class BaseTutorial(metaclass=ABCMeta):
@@ -46,6 +49,15 @@ def save_tutorial(self):
                     Project Id is invalid: {self.projectId}"""
             )
 
+        if self.projectType in [ProjectType.FOOTPRINT.value]:
+            # we compress tasks for footprint project type using gzip
+            json_string_tasks = json.dumps(tasks).replace(" ", "").replace("\n", "")
+            compressed_tasks = gzip_str.gzip_str(json_string_tasks)
+            # we need to decode back, but only when using Python 3.6
+            # when using Python 3.7 it just works
+            # Unfortunately the docker image uses Python 3.7
+            tasks = {"101": base64.b64encode(compressed_tasks).decode("ascii")}
+
         ref.update(
             {
                 f"v2/projects/{self.projectId}": tutorial,

mapswipe_workers/sample_data/footprint/wsf_validation_tutorial_screens.json

@@ -0,0 +1,87 @@
+{
+  "1": {
+    "hint" : {
+      "description" : "Can you see a building?",
+      "icon" : "swipe-left",
+      "title" : "You are looking for buildings."
+    },
+    "instructions" : {
+      "description" : "Tap on the yes button.",
+      "icon" : "tap",
+      "title" : "There is a part of a building here."
+    },
+    "success" : {
+      "description" : "Swipe to the next screen to look for more.",
+      "icon" : "check",
+      "title" : "You found your first building!"
+    }
+  },
+  "2": {
+    "hint" : {
+      "description" : "Check the imagery.",
+      "icon" : "swipe-left",
+      "title" : "Still looking for buildings"
+    },
+    "instructions" : {
+      "description" : "Again select 'YES' if you see a building",
+      "icon" : "tap",
+      "title" : "Building Building Buildings"
+    },
+    "success" : {
+      "description" : "Swipe to the next screen to learn more.",
+      "icon" : "check",
+      "title" : "Nice. You got it know!"
+    }
+  },
+  "3": {
+    "hint" : {
+      "description" : "Here we can't find any building",
+      "icon" : "swipe-left",
+      "title" : "There is no building?"
+    },
+    "instructions" : {
+      "description" : "Select 'No'.",
+      "icon" : "tap",
+      "title" : "Nothing to map here."
+    },
+    "success" : {
+      "description" : "Swipe to keep on going",
+      "icon" : "check",
+      "title" : "Great work!"
+    }
+  },
+  "4": {
+    "hint" : {
+      "description" : "There's no building in this screen.",
+      "icon" : "swipe-left",
+      "title" : "This is easy."
+    },
+    "instructions" : {
+      "description" : "Again select 'No'.",
+      "icon" : "tap",
+      "title" : "There’s no building in this image"
+    },
+    "success" : {
+      "description" : "Swipe to keep on going",
+      "icon" : "check",
+      "title" : "Great stuff!"
+    }
+  },
+  "5": {
+    "hint" : {
+      "description" : "This one was difficult to judge.",
+      "icon" : "swipe-left",
+      "title" : "We’ve marked the correct answers"
+    },
+    "instructions" : {
+      "description" : "Select 'Not sure' if you can't say if there is a building.",
+      "icon" : "tap",
+      "title" : "This one is difficult to decide."
+    },
+    "success" : {
+      "description" : "Swipe to practice some more.",
+      "icon" : "check",
+      "title" : "Well done, you got it right!"
+    }
+  }
+}

mapswipe_workers/sample_data/footprint/wsf_validation_tutorial_tasks.geojson

@@ -0,0 +1,12 @@
+{
+"type": "FeatureCollection",
+"name": "tutorial_tasks",
+"crs": { "type": "name", "properties": { "name": "urn:ogc:def:crs:OGC:1.3:CRS84" } },
+"features": [
+{ "type": "Feature", "properties": { "id": 1543, "reference": 1, "screen": 1 }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 36.952541, -1.196843 ], [ 36.9526309, -1.196843 ], [ 36.9526309, -1.1967531 ], [ 36.952541, -1.1967531 ], [ 36.952541, -1.196843 ] ] ] } },
+{ "type": "Feature", "properties": { "id": 1599, "reference": 0, "screen": 3 }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 36.9537088, -1.1994481 ], [ 36.9537987, -1.1994481 ], [ 36.9537987, -1.1993582 ], [ 36.9537088, -1.1993582 ], [ 36.9537088, -1.1994481 ] ] ] } },
+{ "type": "Feature", "properties": { "id": 1621, "reference": 1, "screen": 2 }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 36.9532597, -1.1998972 ], [ 36.9533495, -1.1998972 ], [ 36.9533495, -1.1998074 ], [ 36.9532597, -1.1998074 ], [ 36.9532597, -1.1998972 ] ] ] } },
+{ "type": "Feature", "properties": { "id": 1639, "reference": 0, "screen": 4 }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 36.9483189, -1.1999871 ], [ 36.9484088, -1.1999871 ], [ 36.9484088, -1.1998972 ], [ 36.9483189, -1.1998972 ], [ 36.9483189, -1.1999871 ] ] ] } },
+{ "type": "Feature", "properties": { "id": 1641, "reference": 2, "screen": 5 }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 36.9483189, -1.2001667 ], [ 36.9484088, -1.2001667 ], [ 36.9484088, -1.2000769 ], [ 36.9483189, -1.2000769 ], [ 36.9483189, -1.2001667 ] ] ] } }
+]
+}