From f8c66835a3158aa56fd66561fcd49bfb0f0c3b82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Vitor=20Leal?= Date: Wed, 30 Oct 2024 13:44:12 -0300 Subject: [PATCH 1/3] Update README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f984923c6..eef49d4d6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ # package_name Description. -The package package_name is used to: - - - - +Fork of the original image manipulation repository, aimed at adding new features, improving algorithm efficiency, and adapting the package for specific projects. Includes updates, tests, and documentation enhancements. ## Installation @@ -24,4 +22,4 @@ file1_name.my_function() My_name ## License -[MIT](https://choosealicense.com/licenses/mit/) \ No newline at end of file +[MIT](https://choosealicense.com/licenses/mit/) From 6e3e35bffa07ae32325fa3fcc4145e03d6960d14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Vitor=20Leal?= Date: Wed, 30 Oct 2024 13:45:01 -0300 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eef49d4d6..df4afc556 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ file1_name.my_function() ``` ## Author -My_name +João Vitor Leal de Castro ## License [MIT](https://choosealicense.com/licenses/mit/) From 3ca9a08308c7fef26af92a3a9585649ed8dec3ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Vitor=20Leal=20de=20Castro?= Date: Wed, 30 Oct 2024 17:53:07 -0300 Subject: [PATCH 3/3] Improve project organization by renaming modules, updating README, and adding .gitignore --- .gitignore | 3 ++ README.md | 47 +++++++++++++++---- .../__init__.py | 0 .../processing/__init__.py | 0 .../processing/combination.py | 0 .../processing/transformation.py | 0 .../utils/__init__.py | 0 .../utils/io.py | 0 .../utils/plot.py | 0 requirements.txt | 3 ++ setup.py | 20 ++++++++ 11 files changed, 65 insertions(+), 8 deletions(-) create mode 100644 .gitignore rename {image_processing => image_processing_jvlc}/__init__.py (100%) rename {image_processing => image_processing_jvlc}/processing/__init__.py (100%) rename {image_processing => image_processing_jvlc}/processing/combination.py (100%) rename {image_processing => image_processing_jvlc}/processing/transformation.py (100%) rename {image_processing => image_processing_jvlc}/utils/__init__.py (100%) rename {image_processing => image_processing_jvlc}/utils/io.py (100%) rename {image_processing => image_processing_jvlc}/utils/plot.py (100%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..358f9bfe2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/dist/ +/build/ +/*.egg-info/ diff --git a/README.md b/README.md index df4afc556..bdc0bf5ee 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,56 @@ -# package_name +# image-processing-jvlc -Description. -Fork of the original image manipulation repository, aimed at adding new features, improving algorithm efficiency, and adapting the package for specific projects. Includes updates, tests, and documentation enhancements. +## Description +The **image-processing-jvlc** package provides tools for image processing, including operations for adjustment and visualization. The package’s main functionalities include: + +### Main Features +- **Histogram Matching**: Matches the histogram of an image to that of another image. +- **Structural Similarity**: Computes the structural similarity between two images, ideal for detailed comparisons. +- **Resize Image**: Resizes images to specified dimensions. + +### Utilities +- **Read Image**: Loads an image from a file. +- **Save Image**: Saves the processed image to a file. +- **Plot Image**: Displays an image. +- **Plot Result**: Compares and displays images side-by-side. +- **Plot Histogram**: Shows the histogram of an image for pixel distribution analysis. ## Installation -Use the package manager [pip](https://pip.pypa.io/en/stable/) to install package_name +Use the package manager [pip](https://pip.pypa.io/en/stable/) to install **image-processing-jvlc**: ```bash -pip install package_name +# With PyPi test +pip install -i https://test.pypi.org/simple/ image-processing-jvlc==0.0.1 + +# or + +# Directly Pypi +pip install image-processing-jvlc ``` ## Usage - +- **Here’s an example of how to use the package to resize an image and display the result:** ```python -from package_name.module1_name import file1_name -file1_name.my_function() +from image_processing_jvlc.processing import transformation +from image_processing_jvlc.utils import io, plot + +# Load an image +image = io.read_image("path/to/image.jpg") + +# Resize the image +resized_image = transformation.resize_image(image, (200, 200)) + +# Display the original and resized images +plot.plot_image(image, title="Original Image") +plot.plot_image(resized_image, title="Resized Image") + ``` ## Author João Vitor Leal de Castro ## License +This project is licensed under the MIT license. + [MIT](https://choosealicense.com/licenses/mit/) diff --git a/image_processing/__init__.py b/image_processing_jvlc/__init__.py similarity index 100% rename from image_processing/__init__.py rename to image_processing_jvlc/__init__.py diff --git a/image_processing/processing/__init__.py b/image_processing_jvlc/processing/__init__.py similarity index 100% rename from image_processing/processing/__init__.py rename to image_processing_jvlc/processing/__init__.py diff --git a/image_processing/processing/combination.py b/image_processing_jvlc/processing/combination.py similarity index 100% rename from image_processing/processing/combination.py rename to image_processing_jvlc/processing/combination.py diff --git a/image_processing/processing/transformation.py b/image_processing_jvlc/processing/transformation.py similarity index 100% rename from image_processing/processing/transformation.py rename to image_processing_jvlc/processing/transformation.py diff --git a/image_processing/utils/__init__.py b/image_processing_jvlc/utils/__init__.py similarity index 100% rename from image_processing/utils/__init__.py rename to image_processing_jvlc/utils/__init__.py diff --git a/image_processing/utils/io.py b/image_processing_jvlc/utils/io.py similarity index 100% rename from image_processing/utils/io.py rename to image_processing_jvlc/utils/io.py diff --git a/image_processing/utils/plot.py b/image_processing_jvlc/utils/plot.py similarity index 100% rename from image_processing/utils/plot.py rename to image_processing_jvlc/utils/plot.py diff --git a/requirements.txt b/requirements.txt index e69de29bb..8f4c47090 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1,3 @@ +matplotlib +numpy +scikit-image >= 0.16.1 \ No newline at end of file diff --git a/setup.py b/setup.py index e69de29bb..05d27ac77 100644 --- a/setup.py +++ b/setup.py @@ -0,0 +1,20 @@ +from setuptools import setup, find_packages + +with open("README.md", "r") as file: + page_description = file.read() + +with open("requirements.txt") as file: + requirements = file.read().splitlines() + +setup( + name="image_processing_jvlc", + version="0.0.2", + author="João Leal", + description="Image Processing Package using Skimage", + long_description=page_description, + long_description_content_type="text/markdown", + url="https://github.com/joaoVitorLeal/image-processing-package", + packages=find_packages(), + install_requires=requirements, + python_requires=">=3.5" +) \ No newline at end of file