work on tutorials and clean up #185

Author: Hagellach37

mapswipe_workers/mapswipe_workers/base/base_functions.py

@@ -20,6 +20,7 @@
         import FootprintProject
 from mapswipe_workers.project_types.change_detection.change_detection_project \
         import ChangeDetectionProject
+from mapswipe_workers.project_types.change_detection import change_detection_tutorial
 from mapswipe_workers.utils import user_management
 
 @click.group()
@@ -229,7 +230,8 @@ def run_create_tutorial(input_file):
 
         project_types_tutorial = {
             # Make sure to import all project types here
-            1: build_area_tutorial.create_tutorial
+            1: build_area_tutorial.create_tutorial,
+            3: change_detection_tutorial.create_tutorial
         }
 
         project_types_tutorial[project_type](tutorial)

mapswipe_workers/mapswipe_workers/mapswipe_workers.py

@@ -0,0 +1,138 @@
+import csv
+
+from mapswipe_workers.definitions import logger
+from mapswipe_workers import auth
+from mapswipe_workers.project_types.build_area import tile_functions as t
+
+
+def create_tutorial(tutorial):
+    tutorial, groups_dict, tasks_dict = generate_tutorial_data(tutorial)
+    upload_tutorial_to_firebase(tutorial, groups_dict, tasks_dict)
+
+
+def generate_tutorial_data(tutorial):
+    tutorial_id = tutorial['projectId']
+    categories = tutorial['categories'].keys()
+    logger.info(f'create tutorial for tutorial id: {tutorial_id}')
+
+    grouped_tasks = {
+        'building_easy_1': {},
+        'building_easy_2': {},
+        'no_building_easy_1': {},
+        'no_building_easy_2': {},
+        'bad_clouds_1': {},
+        'bad_clouds_2': {},
+        'bad_no_imagery_1': {},
+        'bad_no_imagery_2': {},
+    }
+
+    c = 0
+    with open(tutorial['examplesFile']) as csvDataFile:
+        logger.info(f'tutorial tasks are based on: {tutorial["examplesFile"]}')
+        csvReader = csv.reader(csvDataFile)
+        for row in csvReader:
+            c += 1
+            if c == 1:
+                header = row
+            else:
+                category = row[2]
+                if not row[3] in grouped_tasks[category].keys():
+                    grouped_tasks[category][row[3]] = {
+                        'task_id_list': [],
+                        'task_x_list': [],
+                        'task_y_list': [],
+                        'reference_answer_list': [],
+                        'category': category,
+                        'url_list': []
+                    }
+
+                grouped_tasks[category][row[3]]['task_id_list'].append(row[0])
+                zoom = row[0].split('-')[0]
+                task_x = int(row[0].split('-')[1])
+                task_y = int(row[0].split('-')[2])
+                grouped_tasks[category][row[3]]['task_x_list'].append(task_x)
+                grouped_tasks[category][row[3]]['task_y_list'].append(task_y)
+                url = t.tile_coords_zoom_and_tileserver_to_URL(task_x, task_y, zoom, tutorial['tileServer']['name'],
+                                                               auth.get_api_key(tutorial['tileServer']['name']), None,
+                                                               None)
+                grouped_tasks[category][row[3]]['url_list'].append(url)
+                grouped_tasks[category][row[3]]['reference_answer_list'].append(row[1])
+
+    groups_dict = {}
+    tasks_dict = {}
+
+    for i in range(0, 1):
+        print(i)
+        group_id = 101 + i
+        groups_dict[group_id] = {
+            "xMax": "115",
+            "xMin": "100",
+            "yMax": "202",
+            "yMin": "200",
+            "requiredCount": 5,
+            "finishedCount": 0,
+            "groupId": group_id,
+            "projectId": tutorial_id,
+            "numberOfTasks": 36,
+            "progress": 0
+        }
+
+        tasks_dict[group_id] = {}
+        # select 6 tasks for each category and add to group
+        counter = -1
+        task_x = 100
+        task_y = 200
+        for category in categories:
+            # print(category)
+            keys = list(grouped_tasks[category].keys())
+            tasks = grouped_tasks[category][keys[i]]
+
+            x_min = min(tasks['task_x_list'])
+            y_min = min(tasks['task_y_list'])
+
+            # replace taskX and TaskY
+            # TaskY between 0 and 2
+            # TaskX between 0 and 11
+            for j in range(0, len(tasks['task_id_list'])):
+                counter += 1
+                task = {
+                    'taskId_real': tasks['task_id_list'][j],
+                    'groupId': group_id,
+                    'projectId': tutorial_id,
+                    'referenceAnswer': tasks['reference_answer_list'][j],
+                    'category': tasks['category'],
+                    'url': tasks['url_list'][j]
+                }
+
+                if tasks['task_x_list'][j] == x_min:
+                    task['taskX'] = str(task_x)
+                elif tasks['task_x_list'][j] == (x_min + 1):
+                    task['taskX'] = str(task_x + 1)
+
+                if tasks['task_y_list'][j] == y_min:
+                    task['taskY'] = str(task_y)
+                elif tasks['task_y_list'][j] == (y_min + 1):
+                    task['taskY'] = str(task_y + 1)
+                elif tasks['task_y_list'][j] == (y_min + 2):
+                    task['taskY'] = str(task_y + 2)
+
+                task['taskId'] = '18-{}-{}'.format(task['taskX'], task['taskY'])
+                tasks_dict[group_id][counter] = task
+
+            task_x += 2
+
+    return tutorial, groups_dict, tasks_dict
+
+
+def upload_tutorial_to_firebase(tutorial, groups_dict, tasks_dict):
+    # upload groups and tasks to firebase
+    tutorial_id = tutorial['projectId']
+
+    fb_db = auth.firebaseDB()
+    ref = fb_db.reference('')
+    ref.update({
+        'v2/projects/{}'.format(tutorial_id): tutorial,
+        'v2/groups/{}'.format(tutorial_id): groups_dict,
+        'v2/tasks/{}'.format(tutorial_id): tasks_dict,
+    })
+    logger.info(f'uploaded tutorial data to firebase for {tutorial_id}')

mapswipe_workers/mapswipe_workers/project_types/build_area/build_area_tutorial.py

@@ -0,0 +1,107 @@
+import csv
+import json
+
+from mapswipe_workers.definitions import logger
+from mapswipe_workers import auth
+from mapswipe_workers.project_types.change_detection import tile_functions as t
+
+
+def create_tutorial(tutorial):
+    tutorial, groups_dict, tasks_dict = generate_tutorial_data(tutorial)
+    upload_tutorial_to_firebase(tutorial, groups_dict, tasks_dict)
+
+
+def generate_tutorial_data(tutorial):
+    tutorial_id = tutorial['projectId']
+    logger.info(f'create tutorial for tutorial id: {tutorial_id}')
+
+    groups_dict = {}
+    tasks_dict = {}
+
+    with open(tutorial['examplesFile']) as json_file:
+        tutorial_tasks = json.load(json_file)
+        print(len(tutorial_tasks))
+        print(tutorial_tasks)
+
+        for feature in tutorial_tasks['features']:
+
+            print(feature)
+
+            category = feature['properties']['category']
+            group_id = 100 + feature['properties']['id']
+
+            if not group_id in groups_dict.keys():
+                groups_dict[group_id] = {
+                    "xMax": "104",
+                    "xMin": "100",
+                    "yMax": "200",
+                    "yMin": "200",
+                    "requiredCount": 5,
+                    "finishedCount": 0,
+                    "groupId": group_id,
+                    "projectId": tutorial_id,
+                    "numberOfTasks": 4,
+                    "progress": 0
+                }
+
+            reference = feature['properties']['reference']
+            zoom = feature['properties']['TileZ']
+            task_x = feature['properties']['TileX']
+            task_y = feature['properties']['TileY']
+            task_id_real = '{}-{}-{}'.format(zoom, task_x, task_y)
+
+            urlA = t.tile_coords_zoom_and_tileserver_to_URL(
+                task_x,
+                task_y,
+                zoom,
+                tutorial['tileServerA']['name'],
+                tutorial['tileServerA']['apiKey'],
+                tutorial['tileServerA']['url'],
+                None,
+            )
+            urlB = t.tile_coords_zoom_and_tileserver_to_URL(
+                task_x,
+                task_y,
+                zoom,
+                tutorial['tileServerB']['name'],
+                tutorial['tileServerB']['apiKey'],
+                tutorial['tileServerB']['url'],
+                None,
+            )
+
+            if not group_id in tasks_dict.keys():
+                tasks_dict[group_id] = {}
+                task_id = '{}-{}-{}'.format(16, 100, 200)
+            else:
+                task_id = '{}-{}-{}'.format(16, 100 + len(tasks_dict[group_id].keys()), 200)
+
+            task = {
+                'taskId_real': task_id_real,
+                'taskId': task_id,
+                'taskX': 100 + len(tasks_dict[group_id].keys()),
+                'taskY': 200,
+                'groupId': group_id,
+                'projectId': tutorial_id,
+                'referenceAnswer': reference,
+                'category': category,
+                'urlA': urlA,
+                'urlB': urlB,
+            }
+
+            tasks_dict[group_id][len(tasks_dict[group_id].keys())] = task
+
+    return tutorial, groups_dict, tasks_dict
+
+
+def upload_tutorial_to_firebase(tutorial, groups_dict, tasks_dict):
+    # upload groups and tasks to firebase
+    tutorial_id = tutorial['projectId']
+
+    fb_db = auth.firebaseDB()
+    ref = fb_db.reference('')
+    ref.update({
+        'v2/projects/{}'.format(tutorial_id): tutorial,
+        'v2/groups/{}'.format(tutorial_id): groups_dict,
+        'v2/tasks/{}'.format(tutorial_id): tasks_dict,
+    })
+    logger.info(f'uploaded tutorial data to firebase for {tutorial_id}')