Merge pull request #11 from lukaspanni/AutoGreyscale

Auto greyscale

Author: lukaspanni

ImageCopy/ActionRunner.py

@@ -1,3 +1,4 @@
+from ImageCopy.Actions.AutoGreyscale import AutoGreyscale
 from ImageCopy.Actions.ExifEditing import ExifEditing
 from ImageCopy.Transformers.GroupingTransform import GroupingTransform
 from ImageCopy.Transformers.RawSeparateTransform import RawSeparateTransform
@@ -19,6 +20,8 @@ def __init__(self, config: Config):
             self.path_transformers.append(RawSeparateTransform(config.raw_separate))
         if self.config.exif is not None:
             self.after_actions.append(ExifEditing(self.config.exif))
+        if self.config.greyscale is not None:
+            self.after_actions.append(AutoGreyscale(self.config.greyscale))
 
     def execute_transform(self, images: dict):
         for transformer in self.path_transformers:

ImageCopy/Actions/AutoGreyscale.py

@@ -0,0 +1,34 @@
+import os
+import numpy as np
+from PIL import Image
+from ImageCopy.Actions.AfterCopyAction import AfterCopyAction
+from ImageCopy.Actions.GreyscaleConverter import GreyscaleConverter
+
+
+class AutoGreyscale(AfterCopyAction):
+    """
+    Creates a greyscale copy of copied images
+    """
+
+    def __init__(self, config: dict):
+        self.converter = GreyscaleConverter()
+        if 'algorithm' not in config:
+            self.converter.algorithm = "average"
+        else:
+            self.converter.algorithm = config['algorithm']
+        if 'file_name' not in config:
+            self.file_name = "greyscale"
+        else:
+            self.file_name = config['file_name']
+
+    def execute(self, images: dict):
+        for img in images:
+            if not img.is_raw():
+                pil_img = Image.open(images[img])
+                img_data = np.array(pil_img)
+                pil_img = None
+                greyscale_img = Image.fromarray(self.converter.execute(img_data))
+                path = os.path.splitext(images[img])
+                greyscale_img.save(path[0] + "_" + self.file_name + path[1])
+                img_data = None
+                greyscale_img = None

ImageCopy/Actions/ExifEditing.py

@@ -16,6 +16,9 @@ def _load_exif_config(config: dict):
 
 
 class ExifEditing(AfterCopyAction):
+    """
+    Sets Exif-Data in copied Images
+    """
 
     def __init__(self, exif_data: dict):
         self.exif_data = _load_exif_config(exif_data)

ImageCopy/Actions/GreyscaleConverter.py

@@ -0,0 +1,96 @@
+import numpy as np
+from numba import stencil, njit, cuda
+
+
+@stencil(neighborhood=((0, 0), (0, 0), (0, 2)))
+def stencil_avg(px):
+    return np.mean(px[0, 0, 0:3])
+
+
+@stencil(neighborhood=((0, 0), (0, 0), (0, 2)))
+def stencil_luminosity(px):
+    return px[0, 0, 0] * 0.21 + px[0, 0, 1] * 0.72 + px[0, 0, 2] * 0.07
+
+
+@stencil(neighborhood=((0, 0), (0, 0), (0, 2)))
+def stencil_lightness(px):
+    return 0.5 * (np.max(px[0, 0, 0:3]) + np.min(px[0, 0, 0:3]))
+
+
+@njit(parallel=True)
+def greyscale_avg(arr):
+    return stencil_avg(arr)
+
+
+@njit(parallel=True)
+def greyscale_luminosity(arr):
+    return stencil_luminosity(arr)
+
+
+@njit(parallel=True)
+def greyscale_lightness(arr):
+    return stencil_lightness(arr)
+
+
+@cuda.jit(device=True)
+def gpu_avg(px_val):
+    return (px_val[0] + px_val[1] + px_val[2]) // 3
+
+
+@cuda.jit(device=True)
+def gpu_luminosity(px_val):
+    return (px_val[0] * 0.21 + px_val[1] * 0.72 + px_val[2] * 0.07) // 1
+
+
+@cuda.jit(device=True)
+def gpu_lightness(px_val):
+    return (0.5 * (max(px_val[0], px_val[1], px_val[2]) + min(px_val[0], px_val[1], px_val[2]))) // 1
+
+
+@cuda.jit()
+def gpu_greyscale_avg(img):
+    x, y = cuda.grid(2)
+    d1, d2 = cuda.gridsize(2)
+    for i in range(x, img.shape[0], d1):
+        for j in range(y, img.shape[1], d2):
+            img[i][j] = gpu_avg(img[i][j])
+
+
+@cuda.jit()
+def gpu_greyscale_luminosity(img):
+    x, y = cuda.grid(2)
+    d1, d2 = cuda.gridsize(2)
+    for i in range(x, img.shape[0], d1):
+        for j in range(y, img.shape[1], d2):
+            img[i][j] = gpu_luminosity(img[i][j])
+
+
+@cuda.jit()
+def gpu_greyscale_lightness(img):
+    x, y = cuda.grid(2)
+    d1, d2 = cuda.gridsize(2)
+    for i in range(x, img.shape[0], d1):
+        for j in range(y, img.shape[1], d2):
+            img[i][j] = gpu_lightness(img[i][j])
+
+
+algorithms = {
+    "average": {"cpu": greyscale_avg, "gpu": gpu_greyscale_avg},
+    "luminosity": {"cpu": greyscale_luminosity, "gpu": gpu_greyscale_luminosity},
+    "lightness": {"cpu": greyscale_lightness, "gpu": gpu_greyscale_lightness}
+}
+
+
+class GreyscaleConverter:
+    algorithm: str
+
+    def __init__(self):
+        self.gpu = cuda.is_available()
+
+    def execute(self, img_data):
+        if not self.gpu:
+            return algorithms[self.algorithm]["cpu"](img_data).astype(np.uint8)[:, :, 0]
+        else:
+            dev_arr = cuda.to_device(img_data)
+            algorithms[self.algorithm]["gpu"][(32, 32), (16, 16)](dev_arr)
+            return dev_arr.copy_to_host()

ImageCopy/config.example.yml

@@ -2,6 +2,7 @@ modules:
   - grouping
   - raw_separate
   - exif
+  - greyscale
 input-output:
   input_dir: G:/
   output_dir: E:/Images/2020
@@ -10,6 +11,12 @@ raw_separate:
   raw_dir_name: RAW
 grouping:
   year: yes
-  month: yes
-  month_named: yes
-  day: no
+  month: no
+  month_named: no
+  day: no
+exif:
+  artist: Lukas Panni
+  copyright: Lukas Panni
+greyscale:
+  algorithm: average
+  file_name: greyscale

README.md

@@ -6,7 +6,7 @@
 
 Tool for fast and easy copying of RAW/JPG images from a camera to a hard drive.
 
-## Features
+## Features (version 2.0)
 
 - Search and copy all image files automatically.
 - Separate RAW and JPG images in different folders.
@@ -16,6 +16,8 @@ Tool for fast and easy copying of RAW/JPG images from a camera to a hard drive.
     - Month (either 1-12 or January-December)
     - Day
 
+- Set EXIF Data in JPG images (artist and copyright)
+- Create a greyscale copy of JPG images
 
 ## Planned Features
 
@@ -28,43 +30,90 @@ Tool for fast and easy copying of RAW/JPG images from a camera to a hard drive.
 
 **Reccomendation:** rename the config.example.yml and adjust settings there.
 
+**Module config:** list of modules to use.
+````yaml
+modules:
+  - grouping
+  - raw_separate
+  - exif
+  - greyscale
+````
+  
 Basic Config (copies all images from `input_dir` including all subdirectories to `output_dir`): 
 ```yaml
 input-output:
-    input_dir: /SD/DCIM/
-    output_dir: /home/img/
-    separate_raw: no
+  input_dir: /SD/DCIM/
+  output_dir: /home/img/
 ```
-To create a separate folder for RAW-Images you have to set `separate_raw` to `yes` and provide a name for `raw_dir_name`.
 
-Additionally there is the option to group images by creation date.
-You can choose to group images based on **year**, **month** and/or **date**. 
-If you choose to group by month you can enable `month_named`. This will create directories with the months name instead of its number.
-The following example shows how to use the grouping-feature:
-```yaml
-grouping:
-  year: yes
-  month: yes
-  month_named: yes
-  day: no
-```
+#### Modules
+
+Currently (Version 2.0) available: 
+
+- grouping 
+    
+    Group images by creation date.
+    You can choose to group images based on **year**, **month** and/or **date**. 
+    If you choose to group by month you can enable `month_named`. This will create directories with the months name instead of its number.
+    The following example shows how to use the grouping-feature:
+    ```yaml
+    grouping:
+      year: yes
+      month: yes
+      month_named: yes
+      day: no
+    ```
+  
+     The resulting directory structure will look something like this:
+     
+    ```
+    /
+    ├── 2019
+    │   └── May
+    |       └── DSC00192.JPG
+    |       └── DSC00193.JPG
+    |   └── November
+    |       └── DSC01337.JPG
+    |       └── DSC01342.JPG
+    ├── 2020
+    │   └── March
+    |       └── DSC00042.JPG
+    ```
+       
+- raw_separate
+    
+    Separate RAW Images in different directory specified by `raw_dir_name`. Example usage:
+    ````yaml
+    raw_separate:
+      separate_raw: yes
+      raw_dir_name: RAW
+    ````
+    
+- exif
+    
+    Set Artist and Copyright in JPG images, RAW images are not affected. Example usage:
+    
+    ```yaml
+    exif:
+      artist: Lukas Panni
+      copyright: Lukas Panni
+    ```
+    
+- greyscale
+
+    Create a greyscale copy of every JPG image. Can use one of three different algorithms (average, luminosity, lightness) default: average.
+    `file_name` specifies a string that is appended to the original file name to identify the greyscale copy.
+
+    ```yaml
+    greyscale:
+      algorithm: average
+      file_name: greyscale
+    ```
+
+
+
 
-The resulting directory structure will look something like this:
-```
-/
-├── 2019
-│   └── May
-|       └── DSC00192.JPG
-|       └── DSC00193.JPG
-|   └── November
-|       └── DSC01337.JPG
-|       └── DSC01342.JPG
-├── 2020
-│   └── March
-|       └── DSC00042.JPG
-```
-   
 ### Execute
 
-If the configuration file is set up you can execute the `image_copy.py` script.
+If the configuration file is set up you can execute the `image_copy.py` script or the bundled executable for your platform.
 When the input and output directories stay the same and you don't want to group differently you can execute it as often as you want wihtout changing the config.

requirements.txt

@@ -1,3 +1,6 @@
 piexif==1.1.3
 PyYAML==5.3.1
 pytest==5.4.3
+Pillow==7.2.0
+numba==0.50.0
+numpy==1.19.0