Metadata-Version: 2.1
Name: image-functions
Version: 0.1.0
Summary: Image Processing Functions
Author-email: Marlon Rodrigues Garcia <marlon.garcia@unesp.br>
License: MIT License
        
        Copyright (c) 2023 Marlon Rodrigues Garcia
        
        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.
        
Project-URL: Homepage, https://github.com/MarlonGarcia/imfun
Keywords: image processing,digital image,image functions
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE.rst
Requires-Dist: numpy
Requires-Dist: opencv-contrib-python
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: pynput

# Image Functions Library

This is a library to apply simple to complex functions to treat, transform and
prepare images. This library helps to prepare image data for machine learning,
for example, but also helps in simple functions, like image transformation,
loading, and printing. Next are an example of functions.


These are an example of simple functions:
- load_color_images: function to load all color images from a folder
- plot_color_images: function to print all color images from a folder
- highpass_fft: high-pass frequency filter using FFT algorithm
- highpass_gaus: high-pass frequency filter using Gaussian equation.
- flat2im: transform an image in flattened data, e.g. to enter machine-learning
algorithms (like Random Forest).
- beep: make a beep sequence to signalize.
- good_colormaps: show different colormaps to choose one to highlight features.


Examples of more complex functions:
- align_ECC: align images using ECC algorithm from OpenCV
- isoareas measure and statistics pixel's intensity by depth in a preferential
direction.
- im2label: transform an image to a segmented image label
- crop_multiple: crop multiple images with the same cropping area.
- polyroi: make a polygonal ROI in an image.
- crop_poly_multiple: make polygonal ROI and replicate the same ROI in other
images, changing its position.
- choose_points: choose points in an image, and retrieve its indexes.

OBS: some functions use libraries pynput and windsound, which some times are
difficult to install and do not works on non-windows platforms. Comment on
these imports if there are problems during installation.

Author: Marlon Rodrigues Garcia  
Institution:  São Paulo State University  
Contact: marlonrg@gmail.com
