Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/dist/
/build/
/*.egg-info/
53 changes: 41 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,56 @@
# package_name
# image-processing-jvlc

Description.
The package package_name is used to:
-
-
## 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
My_name
João Vitor Leal de Castro

## License
[MIT](https://choosealicense.com/licenses/mit/)
This project is licensed under the MIT license.

[MIT](https://choosealicense.com/licenses/mit/)
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
matplotlib
numpy
scikit-image >= 0.16.1
20 changes: 20 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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"
)