Merge pull request #60 from jonathanrocher/fix/consistent_image_folder

Make the `ImageFolder` model consistent across stages

Author: jonathanrocher

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):

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):

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):

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):

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 -----------------------------------------------------------
@@ -52,4 +50,4 @@ def open_in_central_pane(self, filepath):
             obj = ImageFile(filepath=filepath)
             self.central_pane.edit(obj, factory=ImageFileEditor)
         else:
-            print("Unsupported file format: {}".format(file_ext))
+            print("Unsupported file format: '{}'".format(file_ext))

stage5.1_fuller_application/README.md

@@ -1,3 +1,3 @@
 # Second real version of the pycasa ETS pyface application!
-Building on the application state 4.2, this version simply adds an editor and a 
-view for a folder to be visualized.
+Building on the application state 4.1, this version adds a model and view for
+a folder of image files.

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):

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
+        ])

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)

stage5.1_fuller_application/pycasa/ui/image_folder_view.py

@@ -1,12 +1,18 @@
-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
+# Local imports
+from pycasa.model.image_folder import FILENAME_COL, ImageFolder, NUM_FACE_COL
 
-DISPLAYED_COLUMNS = [
+
+DISPLAYED_COLUMNS = [FILENAME_COL, NUM_FACE_COL] + [
     'ApertureValue', 'ExifVersion', 'Model', 'Make', 'LensModel', 'DateTime',
-    'ShutterSpeedValue', 'XResolution', 'YResolution'
+    'ShutterSpeedValue', 'ExposureTime', 'XResolution', 'YResolution',
+    'Orientation', 'GPSInfo', 'DigitalZoomRatio', 'FocalLengthIn35mmFilm',
+    'ISOSpeedRatings', 'SceneType'
 ]
 
 
@@ -15,23 +21,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',
+            'model.data',
             editor=DataFrameEditor(columns=DISPLAYED_COLUMNS),
             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