Skip to main content

A python package to support essential trasformations on image datasets

Project description

Documentation Status codecov

ImaGenie

ImaGenie is a Python package for image augmentation and modification, providing a variety of functions to manipulate images for machine learning, computer vision, or creative purposes. Whether you need to flip, scale, convert to grayscale, or blur images, ImaGenie is your one-stop solution for fast and efficient image manipulation.

Features

  • flip(image, direction=0): Flips the input image either horizontally or vertically. Useful for augmenting datasets by introducing mirror-image variations. 0 = horizontal flip, 1 = vertical flip
  • scale(image, N): Resizes the input image by a given scale factor N. This is crucial for normalizing or creating variations in image resolution.
  • blur(image, stdev=1.0): Applies a Gaussian blur effect to the image. Helps simulate real-world noise or reduce sharpness for specific use cases.
  • greyscale(image): Converts the image to grayscale. Ideal for models that only require intensity information, excluding color features.
  • augment(image): Applies a sequence of user-defined augmentation operations to a list of images. Useful for image generating images for computer vision tasks.

Installation

To install from pypi:

$ pip install imagenie

To build from the github repo follow the following steps: Clone the repository using the following command :

$ git clone https://github.com/UBC-MDS/ImaGenie.git

then navigate to the repository by running the following command

$ cd ImaGenie

Then run the following command:

$ poetry install

Running test Suite

In the package directory run the following command to run the test suit for this package:

$ pytest

Python Ecosystem Integration

ImaGenie fits well within the Python ecosystem by providing functionality for image manipulation and augmentation. There are several popular libraries for image processing, that offer more complex functionalities, but this package provides a simple, user-friendly interface for common operations tailored for specific image manipulation tasks.

Reference for other image processing libraries:

Contributors

  • Agam Sanghera
  • Gurmehak Kaur
  • Yuhan Fan
  • Yichun Liu

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

imagenie was created by Agam Sanghera, Gurmehak Kaur, Yuhan Fan, Yichun Liu. It is licensed under the terms of the MIT license.

Credits

imagenie was created with cookiecutter and the py-pkgs-cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imagenie-1.1.0.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imagenie-1.1.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file imagenie-1.1.0.tar.gz.

File metadata

  • Download URL: imagenie-1.1.0.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for imagenie-1.1.0.tar.gz
Algorithm Hash digest
SHA256 138f3ce4e46ca38bff261f43a4476d8fdf84f036ba17d40315da64c46e8faba8
MD5 2924933705669048a090623aabfcce21
BLAKE2b-256 b401891254c41a45c1f27ba01a436a79abd091f21407ac7aa785aab28e94751e

See more details on using hashes here.

File details

Details for the file imagenie-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: imagenie-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for imagenie-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 997274300cff71033f844cff3ddfaa820059e82a08a3ad75014788df6713b856
MD5 623e4d073f6c1fdbeda7fc1c881bf03b
BLAKE2b-256 24308e0028a4f6a2b4d64035684dd44b1e723e51301ca335984f6c19b8b653f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page