Merge pull request #1 from ErickOF/feature-datagen

Adding datagen script

Author: ErickOF

.gitignore

@@ -1,3 +1,7 @@
+# Created by https://www.toptal.com/developers/gitignore/api/c++,python,jupyternotebooks
+# Edit at https://www.toptal.com/developers/gitignore?templates=c++,python,jupyternotebooks
+
+### C++ ###
 # Prerequisites
 *.d
 
@@ -30,3 +34,191 @@
 *.exe
 *.out
 *.app
+
+### JupyterNotebooks ###
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Remove previous ipynb_checkpoints
+#   git rm -r .ipynb_checkpoints/
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/c++,python,jupyternotebooks
+
+# Ignore generate images from datagen tool
+tools/datagen/src/imgs/*_grayscale_image*
+tools/datagen/src/imgs/*_sobel_*

tools/datagen/README.md

@@ -0,0 +1,56 @@
+# **SystemC Image Data Generation Tool for Project Testbench**
+
+This tool will help to generate the required data for the testbench. It
+generates grayscale, Sobel x, Sobel y, and combined Sobel x-y images.
+
+
+## **Installation**
+
+Before running, make sure you have installed Python OpenCV. You can run:
+```shell
+cd tools/datagen/
+chmod +x install_pyopencv.sh
+./install_pyopencv.sh
+```
+
+It will display the OpenCV version at the end of the installation.
+
+
+## **Usage**
+
+There are two versions of the script, a JupyterNotebook and a normal Python
+script. For both of them, in the main function, the variables `img_name` and
+`img_ext` must be updated. The `img_name` is only the name of the image that
+is saved in `tools/datagen/src/imgs` and the `img_ext` is the extension of the
+image. For instance:
+
+```python
+img_name: str = 'car'
+img_ext: str = 'jpg
+```
+
+will load `tools/datagen/src/imgs/car.jpg` image and generate:
+
+* tools/datagen/src/imgs/car\_grayscale\_image.jpg
+* tools/datagen/src/imgs/car\_sobel\_combined\_result.jpg
+* tools/datagen/src/imgs/car\_sobel\_x\_result.jpg
+* tools/datagen/src/imgs/car\_sobel\_y\_result.jpg
+
+These generated images are ignored and must not be committed to the repository.
+
+
+### **Python Script**
+
+To run the Python script:
+
+```shell
+cd tools/datagen/
+python3 datagen.py
+```
+
+
+### **JupyterNotebook**
+
+You can open the file from the JupyterNotebook app or upload it to
+[Google Colab](https://colab.research.google.com/).
+

tools/datagen/datagen.ipynb

@@ -0,0 +1,88 @@
+#!/usr/bin/python3
+"""
+Script to generate the data required for SystemC testbench.
+"""
+from typing import Tuple
+
+import cv2
+import numpy as np
+import matplotlib.pyplot as plt
+
+
+def apply_sobel_filter(image_path: str
+    )-> Tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray]:
+    """Applies the Sobel filter in X and Y to a input image and returns each
+    step.
+
+    Args:
+        image_path (str): Path to the input image
+
+    Returns:
+        Tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray]: A tuple
+            containing the gray image, the sobel in x, the sobel in y, and the
+            sobel combining x and y.
+    """
+    # Read the image
+    image: np.ndarray = cv2.imread(image_path)
+
+    # BGR to grayscale
+    gray_img: np.ndarray = cv2.cvtColor(image, cv2.COLOR_BGR2GRAY)
+
+    # Apply Sobel in x direction
+    sobel_x_img: np.ndarray = cv2.Sobel(gray_img, cv2.CV_64F, 1, 0, ksize=3)
+    sobel_x_uint8: np.ndarray = np.uint8(np.absolute(sobel_x_img))
+
+    # Apply Sobel in y direction
+    sobel_y_img: np.ndarray = cv2.Sobel(gray_img, cv2.CV_64F, 0, 1, ksize=3)
+    sobel_y_uint8: np.ndarray = np.uint8(np.absolute(sobel_y_img))
+
+    # Combine sobel
+    sobel_combined_img: np.ndarray = cv2.magnitude(sobel_x_img, sobel_y_img)
+
+    # Convert to 8-bit image
+    sobel_combined_uint8: np.ndarray = np.uint8(np.absolute(sobel_combined_img))
+
+    # Display the results
+    plt.figure(figsize=(10, 8))
+
+    plt.subplot(2, 2, 1)
+    plt.title('Original Image')
+    plt.imshow(cv2.cvtColor(image, cv2.COLOR_BGR2RGB))
+    plt.axis('off')
+
+    plt.subplot(2, 2, 2)
+    plt.title('Grayscale Image')
+    plt.imshow(gray_img, cmap='gray')
+    plt.axis('off')
+
+    plt.subplot(2, 2, 3)
+    plt.title('Sobel X')
+    plt.imshow(np.uint8(np.absolute(sobel_x_img)), cmap='gray')
+    plt.axis('off')
+
+    plt.subplot(2, 2, 4)
+    plt.title('Sobel Y')
+    plt.imshow(np.uint8(np.absolute(sobel_y_img)), cmap='gray')
+    plt.axis('off')
+
+    plt.figure(figsize=(5, 5))
+    plt.title('Sobel Combined')
+    plt.imshow(sobel_combined_uint8, cmap='gray')
+    plt.axis('off')
+
+    plt.show()
+
+    return (gray_img, sobel_x_uint8, sobel_y_uint8, sobel_combined_uint8)
+
+
+if __name__ == '__main__':
+    img_name: str = 'car'
+    img_ext: str = 'jpg'
+    img_path: str = f'src/imgs/{img_name}.{img_ext}'
+    gray, sobel_x, sobel_y, sobel_combined = apply_sobel_filter(img_path)
+
+    cv2.imwrite(f'src/imgs/{img_name}_grayscale_image.{img_ext}', gray)
+    cv2.imwrite(f'src/imgs/{img_name}_sobel_x_result.{img_ext}', np.uint8(np.absolute(sobel_x)))
+    cv2.imwrite(f'src/imgs/{img_name}_sobel_y_result.{img_ext}', np.uint8(np.absolute(sobel_y)))
+    cv2.imwrite(f'src/imgs/{img_name}_sobel_combined_result.{img_ext}', sobel_combined)
+

tools/datagen/datagen.py

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+sudo pip3 install opencv-python
+
+python3 -c "import cv2; print(f'OpenCV: {cv2.__version__}')"