Merge pull request #3 from renan-siqueira/develop

Merge develop into main

Author: renan-siqueira

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 renan-siqueira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,77 @@
+# X-ray Image Effect Project
+
+This project applies an X-ray effect to images using Python and the Python Imaging Library (PIL). It is a useful tool for creating datasets with characteristics of x-ray images.
+
+---
+
+## Environment Setup
+
+### Prerequisites
+
+- Python 3.x
+- pip (Python package manager)
+
+### Setting Up a Virtual Environment
+
+1. **Create a Virtual Environment**:
+
+In your terminal, navigate to your project directory and run:
+
+```bash
+python -m venv .venv
+```
+
+This will create a virtual environment named `.venv` in your project directory.
+
+2. **Activate the Virtual Environment**:
+- On Windows, run:
+  ```
+  .\venv\Scripts\activate
+  ```
+- On Linux or macOS, run:
+  ```
+  source venv/bin/activate
+  ```
+
+### Installing Dependencies
+
+With the virtual environment activated, install the necessary dependencies by running:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Project Configuration
+
+1. **Application Settings**:
+
+Configure the input and output paths in the `src/config.py` file. For example:
+```python
+APP_PATH_INPUT_IMAGES = 'path/to/input/images/directory'
+APP_PATH_OUTPUT_IMAGES = 'path/to/output/images/directory'
+```
+
+---
+
+## Usage
+
+To use the application, ensure the virtual environment is activated. In the root directory of the project, run:
+
+```bash
+python main.py
+```
+
+This will process all images in the specified input directory and save the X-ray effect images to the output directory.
+
+---
+
+## Additional Notes
+
+- Ensure the input directory contains images in supported formats (`.png`, `.jpg`, `.jpeg`, `.webp`).
+- The script will create the output directory if it does not exist.
+
+---
+
+## License
+
+This project is open-sourced and available to everyone under the [MIT License](LICENSE).

main.py

@@ -0,0 +1,71 @@
+import os
+from PIL import Image, ImageOps
+from src.settings import config
+
+
+def get_image_paths(directory):
+    """
+    Returns a list of file paths for all images in the given directory.
+
+    Parameters:
+    directory (str): Path to the directory to scan for images.
+
+    Returns:
+    list: A list of paths to the images in the directory.
+    """
+    image_extensions = ['.png', '.jpg', '.jpeg', '.webp']
+    return [os.path.join(directory, file) for file in os.listdir(directory)
+            if os.path.splitext(file)[1].lower() in image_extensions]
+
+def xray_effect(image_path, output_dir):
+    """
+    Applies an X-ray effect to the provided image and saves it to the output directory.
+
+    Parameters:
+    image_path (str): The path to the input image.
+    output_dir (str): The directory where the X-ray effect image will be saved.
+    """
+    try:
+        with Image.open(image_path) as img:
+            inverted_image = ImageOps.invert(img)
+            grayscale_image = inverted_image.convert("L")
+            contrasted_image = ImageOps.autocontrast(grayscale_image)
+
+            output_path = os.path.join(output_dir, get_output_filename(image_path))
+            contrasted_image.save(output_path)
+            return f"X-ray effect image saved as {output_path}"
+    except Exception as e:
+        return f"An error occurred: {e}"
+
+def get_output_filename(input_path):
+    """
+    Generates the output filename for the X-ray effect image based on the input image path.
+
+    Parameters:
+    input_path (str): The path to the input image.
+
+    Returns:
+    str: The output filename for the X-ray effect image.
+    """
+    base_name = os.path.basename(input_path)
+    name, ext = os.path.splitext(base_name)
+    return f"{name}_x-ray{ext}"
+
+def main(input_dir, output_dir):
+    """
+    Main function to apply X-ray effect to all images in the input directory and save them to the output directory.
+
+    Parameters:
+    input_dir (str): Path to the directory containing input images.
+    output_dir (str): Path to the directory where the X-ray effect images will be saved.
+    """
+    if not os.path.exists(output_dir):
+        os.makedirs(output_dir)
+
+    image_paths = get_image_paths(input_dir)
+    for path in image_paths:
+        print(xray_effect(path, output_dir))
+
+
+if __name__ == '__main__':
+    main(config.APP_PATH_INPUT_IMAGES, config.APP_PATH_OUTPUT_IMAGES)

requirements.txt

@@ -0,0 +1 @@
+Pillow==10.1.0

src/settings/__init__.py

@@ -0,0 +1,2 @@
+APP_PATH_INPUT_IMAGES = 'data/input'
+APP_PATH_OUTPUT_IMAGES = 'data/output'