Make ImageFolder consistent across stages

siddhantwahal · siddhantwahal · commit 8f69c8513e3f · 2022-07-10T14:25:10.000-05:00
diff --git a/stage2.1_traited_script/traited_face_detect.py b/stage2.1_traited_script/traited_face_detect.py
@@ -15,7 +15,7 @@
     Array, cached_property, Dict, File, HasStrictTraits, List, Property
 )
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]
+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
 
 
 class ImageFile(HasStrictTraits):
diff --git a/stage3.0_first_views/traited_face_detect.py b/stage3.0_first_views/traited_face_detect.py
@@ -15,7 +15,7 @@
 )
 from traitsui.api import Item, OKButton, View
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]
+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
 
 
 class ImageFile(HasStrictTraits):
diff --git a/stage3.1_first_views/traited_face_detect.py b/stage3.1_first_views/traited_face_detect.py
@@ -18,7 +18,7 @@
 # Local imports
 from ets_tutorial.util.mpl_figure_editor import MplFigureEditor
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]
+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
 
 
 class ImageFile(HasStrictTraits):
diff --git a/stage4.1_first_application/pycasa/model/image_file.py b/stage4.1_first_application/pycasa/model/image_file.py
@@ -11,7 +11,7 @@
     Array, cached_property, Dict, File, HasStrictTraits, List, Property
 )
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]
+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
 
 
 class ImageFile(HasStrictTraits):
diff --git a/stage4.1_first_application/pycasa/ui/tasks/pycasa_task.py b/stage4.1_first_application/pycasa/ui/tasks/pycasa_task.py
@@ -7,11 +7,9 @@
 
 # Local imports
 from .pycasa_browser_pane import PycasaBrowserPane
-from ...model.image_file import ImageFile
+from ...model.image_file import ImageFile, SUPPORTED_FORMATS
 from ..image_file_editor import ImageFileEditor
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]
-
 
 class PycasaTask(Task):
     # 'Task' traits -----------------------------------------------------------
diff --git a/stage5.1_fuller_application/pycasa/model/image_file.py b/stage5.1_fuller_application/pycasa/model/image_file.py
@@ -11,7 +11,7 @@
     Array, cached_property, Dict, File, HasStrictTraits, List, Property
 )
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]
+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
 
 
 class ImageFile(HasStrictTraits):
diff --git a/stage5.1_fuller_application/pycasa/model/image_folder.py b/stage5.1_fuller_application/pycasa/model/image_folder.py
@@ -1,8 +1,9 @@
 
 # General imports
 import glob
-from os.path import expanduser, isdir, split
+from os.path import basename, expanduser, isdir
 
+import numpy as np
 import pandas as pd
 
 # ETS imports
@@ -11,9 +12,10 @@
 )
 
 # Local imports
-from pycasa.model.image_file import ImageFile
+from pycasa.model.image_file import ImageFile, SUPPORTED_FORMATS
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
+FILENAME_COL = "filename"
+NUM_FACE_COL = "Num. faces"
 
 
 class ImageFolder(HasStrictTraits):
@@ -23,23 +25,38 @@ class ImageFolder(HasStrictTraits):
 
     images = List(Instance(ImageFile))
 
+    data = Instance(pd.DataFrame)
+
     def __init__(self, **traits):
+        # Don't forget this!
         super(ImageFolder, self).__init__(**traits)
         if not isdir(self.directory):
             msg = f"The provided directory isn't a real directory: " \
                   f"{self.directory}"
             raise ValueError(msg)
+        self.data = self._create_metadata_df()
 
     @observe("directory")
-    def _get_images(self, event):
+    def _update_images(self, event):
         self.images = [
             ImageFile(filepath=file)
             for fmt in SUPPORTED_FORMATS
             for file in glob.glob(f"{self.directory}/*{fmt}")
         ]
 
-    def create_metadata_df(self):
-        return pd.DataFrame(
-            [img.metadata for img in self.images],
-            index=[split(img.filepath)[1] for img in self.images]
-        )
+    @observe("images.items")
+    def _update_metadata(self, event):
+        self.data = self._create_metadata_df()
+
+    def _create_metadata_df(self):
+        if not self.images:
+            return pd.DataFrame({FILENAME_COL: [], NUM_FACE_COL: []})
+        return pd.DataFrame([
+                {
+                    FILENAME_COL: basename(img.filepath),
+                    NUM_FACE_COL: np.nan,
+                    **img.metadata
+
+                }
+                for img in self.images
+        ])
diff --git a/stage5.1_fuller_application/pycasa/model/tests/test_image_folder.py b/stage5.1_fuller_application/pycasa/model/tests/test_image_folder.py
@@ -1,7 +1,7 @@
 from os.path import dirname, join, split
 import unittest
 
-from pycasa.model.image_folder import ImageFolder
+from pycasa.model.image_folder import FILENAME_COL, ImageFolder
 
 import ets_tutorial
 
@@ -24,8 +24,8 @@ def test_filters_images(self):
             set(self.filenames)
         )
 
-    def test_create_metadata_df(self):
-        df = self.img_folder.create_metadata_df()
-        self.assertEqual(set(df.index), set(self.filenames))
+    def test_data_correct(self):
+        df = self.img_folder.data
+        self.assertEqual(set(df[FILENAME_COL]), set(self.filenames))
         self.assertIn("ExifVersion", df)
         self.assertIn("ApertureValue", df)
diff --git a/stage5.1_fuller_application/pycasa/ui/image_folder_view.py b/stage5.1_fuller_application/pycasa/ui/image_folder_view.py
@@ -1,5 +1,7 @@
-from traits.api import cached_property, Instance, Property
-from traitsui.api import Item, ModelView, View
+from traits.api import Instance
+from traitsui.api import (
+    HGroup, Item, Label, ModelView, Spring, View
+)
 from traitsui.ui_editors.data_frame_editor import DataFrameEditor
 
 from pycasa.model.image_folder import ImageFolder
@@ -15,23 +17,23 @@ class ImageFolderView(ModelView):
     """
     model = Instance(ImageFolder)
 
-    metadata_df = Property(depends_on="model.images.items")
-
     view = View(
         Item('model.directory', style="readonly", show_label=False),
         Item(
-            'metadata_df',
-            editor=DataFrameEditor(columns=DISPLAYED_COLUMNS),
+            'model.data',
+            editor=DataFrameEditor(),
             show_label=False,
-            width=1200,
+            visible_when="len(model.data) > 0",
+        ),
+        HGroup(
+            Spring(),
+            Label("No images found. No data to show"),
+            Spring(),
+            visible_when="len(model.data) == 0",
         ),
         resizable=True
     )
 
-    @cached_property
-    def _get_metadata_df(self):
-        return self.model.create_metadata_df()
-
 
 if __name__ == '__main__':
     from os.path import dirname, join
diff --git a/stage5.1_fuller_application/pycasa/ui/tests/test_image_folder_view.py b/stage5.1_fuller_application/pycasa/ui/tests/test_image_folder_view.py
@@ -17,5 +17,5 @@ def test_image_folder_view(self):
         view = ImageFolderView(model=ImageFolder(directory=SAMPLE_IMG_DIR))
         tester = UITester()
         with tester.create_ui(view) as ui:
-            df = tester.find_by_name(ui, "metadata_df")
+            df = tester.find_by_name(ui, "data")
             df.inspect(IsVisible())
diff --git a/stage5.2_fuller_application/pycasa/model/image_file.py b/stage5.2_fuller_application/pycasa/model/image_file.py
@@ -11,7 +11,7 @@
     Array, cached_property, Dict, File, HasStrictTraits, List, Property
 )
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]
+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
 
 
 class ImageFile(HasStrictTraits):
diff --git a/stage5.2_fuller_application/pycasa/model/image_folder.py b/stage5.2_fuller_application/pycasa/model/image_folder.py
@@ -1,24 +1,28 @@
 # General imports
-import os
+import glob
+from os.path import basename, expanduser, isdir
 
-import pandas as pd
 import numpy as np
+import pandas as pd
 
 # ETS imports
-from traits.api import Directory, Event, HasStrictTraits, Instance
+from traits.api import (
+    Directory, Event, HasStrictTraits, Instance, List, observe,
+)
 
 # Local imports
-from .image_file import ImageFile, SUPPORTED_FORMATS
+from pycasa.model.image_file import ImageFile, SUPPORTED_FORMATS
 
 FILENAME_COL = "filename"
-
 NUM_FACE_COL = "Num. faces"
 
 
 class ImageFolder(HasStrictTraits):
-    """ Model to hold an image folder.
+    """ Model for a folder of images.
     """
-    path = Directory
+    directory = Directory(expanduser("~"))
+
+    images = List(Instance(ImageFile))
 
     data = Instance(pd.DataFrame)
 
@@ -27,39 +31,39 @@ class ImageFolder(HasStrictTraits):
     def __init__(self, **traits):
         # Don't forget this!
         super(ImageFolder, self).__init__(**traits)
-        if not os.path.isdir(self.path):
-            msg = f"Unable to create an ImageFolder from {self.path} since" \
-                  f" it is not a valid directory."
+        if not isdir(self.directory):
+            msg = f"The provided directory isn't a real directory: " \
+                  f"{self.directory}"
             raise ValueError(msg)
+        self.data = self._create_metadata_df()
 
-        self.data = self.to_dataframe()
+    @observe("directory")
+    def _update_images(self, event):
+        self.images = [
+            ImageFile(filepath=file)
+            for fmt in SUPPORTED_FORMATS
+            for file in glob.glob(f"{self.directory}/*{fmt}")
+        ]
 
-    def to_dataframe(self):
-        if not self.path:
-            return pd.DataFrame({FILENAME_COL: [], NUM_FACE_COL: []})
+    @observe("images.items")
+    def _update_metadata(self, event):
+        self.data = self._create_metadata_df()
 
-        data = []
-        for filename in os.listdir(self.path):
-            file_ext = os.path.splitext(filename)[1].lower()
-            if file_ext in SUPPORTED_FORMATS:
-                filepath = os.path.join(self.path, filename)
-                img_file = ImageFile(filepath=filepath)
-                file_data = {FILENAME_COL: filename, NUM_FACE_COL: np.nan}
-                try:
-                    file_data.update(img_file.metadata)
-                except Exception:
-                    pass
-                data.append(file_data)
+    def _create_metadata_df(self):
+        if not self.images:
+            return pd.DataFrame({FILENAME_COL: [], NUM_FACE_COL: []})
+        return pd.DataFrame([
+                {
+                    FILENAME_COL: basename(img.filepath),
+                    NUM_FACE_COL: np.nan,
+                    **img.metadata
 
-        return pd.DataFrame(data)
+                }
+                for img in self.images
+        ])
 
     def compute_num_faces(self, **kwargs):
-        cols = list(self.data.columns)
-        for i, filename in enumerate(self.data[FILENAME_COL]):
-            print(filename)
-            filepath = os.path.join(self.path, filename)
-            img_file = ImageFile(filepath=filepath)
-            faces = img_file.detect_faces(**kwargs)
-            j = cols.index(NUM_FACE_COL)
-            self.data.iloc[i, j] = len(faces)
+        for i, image in enumerate(self.images):
+            faces = image.detect_faces(**kwargs)
+            self.data[NUM_FACE_COL].iat[i] = len(faces)
             self.data_updated = True
diff --git a/stage5.2_fuller_application/pycasa/model/tests/test_image_folder.py b/stage5.2_fuller_application/pycasa/model/tests/test_image_folder.py
@@ -17,21 +17,19 @@
 class TestImageFolder(TestCase):
     def test_no_folder(self):
         with self.assertRaises(ValueError):
-            ImageFolder()
+            ImageFolder(directory="path/to/nonexistent/dir")
 
     def test_with_file(self):
         with self.assertRaises(ValueError):
-            ImageFolder(path=__file__)
+            ImageFolder(directory=__file__)
 
     def test_empty_folder(self):
-        img = ImageFolder(path=HERE)
-        data = img.to_dataframe()
-        self.assertIsInstance(data, pd.DataFrame)
-        self.assertEqual(len(data), 0)
+        img_folder = ImageFolder(directory=HERE)
+        self.assertIsInstance(img_folder.data, pd.DataFrame)
+        self.assertEqual(len(img_folder.data), 0)
 
     def test_real_folder(self):
-        img = ImageFolder(path=SAMPLE_IMG_DIR)
-        data = img.to_dataframe()
-        self.assertEqual(len(data), 2)
+        img_folder = ImageFolder(directory=SAMPLE_IMG_DIR)
+        self.assertEqual(len(img_folder.data), 2)
         for key in ['ExifVersion', 'ExifImageWidth', 'ExifImageHeight']:
-            self.assertIn(key, data.columns)
+            self.assertIn(key, img_folder.data.columns)
diff --git a/stage5.2_fuller_application/pycasa/ui/image_folder_editor.py b/stage5.2_fuller_application/pycasa/ui/image_folder_editor.py
@@ -30,7 +30,7 @@ def create(self, parent):
     # -------------------------------------------------------------------------
 
     def _get_name(self):
-        return self.obj.path[:25]
+        return self.obj.directory[:25]
 
     def _get_tooltip(self):
-        return self.obj.path
+        return self.obj.directory
diff --git a/stage5.2_fuller_application/pycasa/ui/image_folder_view.py b/stage5.2_fuller_application/pycasa/ui/image_folder_view.py
@@ -16,9 +16,12 @@ class ImageFolderView(ModelView):
     scan = Button("Scan for faces...")
 
     view = View(
-        Item("model.path", style="readonly", show_label=False),
-        Item("model.data", editor=DataFrameEditor(update="data_updated"),
-             show_label=False, visible_when="len(model.data) > 0"),
+        Item("model.directory", style="readonly", show_label=False),
+        Item(
+            "model.data",
+            editor=DataFrameEditor(update="data_updated"),
+            show_label=False,
+            visible_when="len(model.data) > 0"),
         HGroup(
             Spring(),
             Label("No images found. No data to show"),
diff --git a/stage5.2_fuller_application/pycasa/ui/tasks/pycasa_task.py b/stage5.2_fuller_application/pycasa/ui/tasks/pycasa_task.py
@@ -52,7 +52,7 @@ def open_in_central_pane(self, filepath):
             obj = ImageFile(filepath=filepath)
             self.central_pane.edit(obj, factory=ImageFileEditor)
         elif file_ext == "":
-            obj = ImageFolder(path=filepath)
+            obj = ImageFolder(directory=filepath)
             self.central_pane.edit(obj, factory=ImageFolderEditor)
         else:
             print("Unsupported file format: {}".format(file_ext))
diff --git a/stage5.3_fuller_application/pycasa/model/image_file.py b/stage5.3_fuller_application/pycasa/model/image_file.py
@@ -11,7 +11,7 @@
     Array, cached_property, Dict, File, HasStrictTraits, List, Property
 )
 
-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]
+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]
 
 
 class ImageFile(HasStrictTraits):
diff --git a/stage5.3_fuller_application/pycasa/model/image_folder.py b/stage5.3_fuller_application/pycasa/model/image_folder.py
diff --git a/stage5.3_fuller_application/pycasa/model/tests/test_image_folder.py b/stage5.3_fuller_application/pycasa/model/tests/test_image_folder.py
diff --git a/stage5.3_fuller_application/pycasa/ui/image_folder_editor.py b/stage5.3_fuller_application/pycasa/ui/image_folder_editor.py
diff --git a/stage5.3_fuller_application/pycasa/ui/image_folder_view.py b/stage5.3_fuller_application/pycasa/ui/image_folder_view.py
diff --git a/stage5.3_fuller_application/pycasa/ui/tasks/pycasa_task.py b/stage5.3_fuller_application/pycasa/ui/tasks/pycasa_task.py

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`Array, cached_property, Dict, File, HasStrictTraits, List, Property`
`16`	`16`	`)`
`17`	`17`
`18`		`-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]`
	`18`	`+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]`
`19`	`19`
`20`	`20`
`21`	`21`	`class ImageFile(HasStrictTraits):`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`Array, cached_property, Dict, File, HasStrictTraits, List, Property`
`12`	`12`	`)`
`13`	`13`
`14`		`-SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg"]`
	`14`	`+SUPPORTED_FORMATS = [".png", ".jpg", ".jpeg", ".PNG", ".JPG", ".JPEG"]`
`15`	`15`
`16`	`16`
`17`	`17`	`class ImageFile(HasStrictTraits):`