Name | image-functions JSON |
Version |
0.1.8
JSON |
| download |
home_page | None |
Summary | Image Processing Functions |
upload_time | 2024-11-04 04:29:51 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.7 |
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. |
keywords |
image processing
digital image
image functions
machine learning data preparation
artificial intelligence data preparation
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Image Functions Library
Library for image pre-processing, with functions to handle and prepare images for machine learning and image processing. This library accounts for functions to load and plot a group of images, pre-processing, choose ROI regions (even polygonal), choose points, get image properties, align and transform images (including rotate, scale, etc.), filter signals and images (2D data), among others. All the functions with GUI (stands for graphical user interface) have an interface to interact with the user.
### 1. Functions to Load and Plot
- `load_gray_images`: loads all images from a folder, in grayscale
- `load_color_images`: loads all color images from a folder
- `plot_gray_images`: prints all grayscale images from a variable 'I'
- `plot_color_images`: prints all color images from a variable 'I'
- `plot_gray`: prints a grayscale image
- `plot_bgr`: prints a color image in BGR format
- `list_folders`: list all folders inside a directory
- `list_images`: list all images inside a folder
- `read_lsm`: reading and mounting images of '.lsm' extension from Zeiss microscope
### 2. Pre-Processing for Machine Learning and Computer Vision
#### 2.1. ROI and Handling (*Most Important Ones*)
- `polyroi`: GUI to create a polygonal region of interest (ROI)
- `crop_image`: GUI to create a rectangular crop in an image
- `crop_multiple`: crops multiple images using the same crop from 1st image
- `crop_poly_multiple`: polygonal crop multiple images based on 1st cropping
- `choose_points`: GUI to interact with the user to choose points in an image
- `imchoose`: function to choose images in a given set of images (with GUI)
- `imroiprop`: getting properties from an image ROI
- `roi_stats`: get statistics from a region choosen by the user, for images of multiple experiments (important!)
- `roi_stats_in_detph`: choose a region, and get the detailed statistics of this region, as a function of a given direction defined by the user. Applications: statistics of pixels from a tumor, from surface to the depth, e.g. in microscope fluorescence of histological slides (see an example in the next gif image):
<p align="center">
<img src="https://raw.githubusercontent.com/MarlonGarcia/imfun/main/media/roi_stats_in_detph.gif" alt="me" width="320" />
</p>
#### 2.2. Image Alignment and Transformation
- `rotate2D`: rotate points by an angle about a center
- `flat2im`: transforms a flat vector into a 2D image
- `im2flat`: transforms a 2D image in a flat vector
- `im2label`: GUI to transform images in labels for image segmentation (very automated function)
- `scale255`: scales an image to the [0, 255] range
- `align_features`: Align images with Feature-Based algorithm, from OpenCV (maybe not working)
- `align_ECC`: image alignment using ECC algorithm from OpenCV (diffuse image)
- `imwarp`: function to warp a set of images using a warp matrix (maybe not working)
### 3. Filtering Images and Signals
- `filter_finder`: study and find which filter to use (for signals, 1D)
- `highpass_gauss`: high-pass Gaussian filter for images (2D)
- `highpass_fft`: high-pass image (2D) filter based on FFT
- `lowpass_fft`: low-pass image (2D) filter based on FFT
- `filt_hist`: filtering histograms with zero/null values (removing zeros)
### 4. Bonus Functions
- `beep`: making 'beeps' to help warn when a long algorithm has finished
- `isoareas`: complex function to measure pixels' intensity in adjacent areas. This is a very specific function to process fluorescence intensities of cells in confocal microscopy images
- `good_colormaps`: visualizing the best Matplotlib colormaps in an image
- `improfile`: finds the pixels' intensity profile between two points (GUI) (maybe not working)
### 5. Tutorials and Examples
Inside the `tutorials` folder there are some examples of using the functions of this library. In this folder, the files with name `imex_name.py` present an example of using the function indicated by the `name` part.
### 6. How to Install
You can install using `pip`:
```
pip install image-functions==0.1.8
```
*OBS*: some functions use the 'pynput' and 'windsound' libraries, which may be difficult to install and do not works on non-windows platforms. Comment on these library imports if there are problems during installation or loading.
- author: Marlon Rodrigues Garcia
- contact: marlon.garcia@unesp.br
- institution: Sao Paulo State University (Unesp)
### 7. Scientific Research
This work is the product of the research being conducted at two universities in Brazil:
#### Sao Paulo State University (Unesp)
- Dept. of Electronic and Telecommunication Engineering
- School of Engineering, Campus of Sao Joao da Boa Vista
- website: https://www.sjbv.unesp.br/
#### University of São Paulo (USP)
- Biophotonics Laboratory, Optics Group (GO)
- São Carlos Institute of Physics (IFSC)
- website: https://www2.ifsc.usp.br/english/
Raw data
{
"_id": null,
"home_page": null,
"name": "image-functions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "image processing, digital image, image functions, machine learning data preparation, artificial intelligence data preparation",
"author": null,
"author_email": "Marlon Rodrigues Garcia <marlon.garcia@unesp.br>",
"download_url": "https://files.pythonhosted.org/packages/7e/f2/c8aaa53fc0e76f58f9db11b3b4bad9be100221dd516c1bef83441b0cee93/image_functions-0.1.8.tar.gz",
"platform": null,
"description": "# Image Functions Library\r\n\r\nLibrary for image pre-processing, with functions to handle and prepare images for machine learning and image processing. This library accounts for functions to load and plot a group of images, pre-processing, choose ROI regions (even polygonal), choose points, get image properties, align and transform images (including rotate, scale, etc.), filter signals and images (2D data), among others. All the functions with GUI (stands for graphical user interface) have an interface to interact with the user.\r\n\r\n\r\n### 1. Functions to Load and Plot\r\n\r\n- `load_gray_images`: loads all images from a folder, in grayscale\r\n- `load_color_images`: loads all color images from a folder\r\n- `plot_gray_images`: prints all grayscale images from a variable 'I'\r\n- `plot_color_images`: prints all color images from a variable 'I'\r\n- `plot_gray`: prints a grayscale image\r\n- `plot_bgr`: prints a color image in BGR format\r\n- `list_folders`: list all folders inside a directory\r\n- `list_images`: list all images inside a folder\r\n- `read_lsm`: reading and mounting images of '.lsm' extension from Zeiss microscope \r\n\r\n\r\n### 2. Pre-Processing for Machine Learning and Computer Vision\r\n\r\n#### 2.1. ROI and Handling (*Most Important Ones*)\r\n\r\n- `polyroi`: GUI to create a polygonal region of interest (ROI)\r\n- `crop_image`: GUI to create a rectangular crop in an image\r\n- `crop_multiple`: crops multiple images using the same crop from 1st image\r\n- `crop_poly_multiple`: polygonal crop multiple images based on 1st cropping\r\n- `choose_points`: GUI to interact with the user to choose points in an image\r\n- `imchoose`: function to choose images in a given set of images (with GUI)\r\n- `imroiprop`: getting properties from an image ROI\r\n- `roi_stats`: get statistics from a region choosen by the user, for images of multiple experiments (important!)\r\n- `roi_stats_in_detph`: choose a region, and get the detailed statistics of this region, as a function of a given direction defined by the user. Applications: statistics of pixels from a tumor, from surface to the depth, e.g. in microscope fluorescence of histological slides (see an example in the next gif image):\r\n\r\n<p align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/MarlonGarcia/imfun/main/media/roi_stats_in_detph.gif\" alt=\"me\" width=\"320\" />\r\n</p>\r\n \r\n#### 2.2. Image Alignment and Transformation\r\n\r\n- `rotate2D`: rotate points by an angle about a center\r\n- `flat2im`: transforms a flat vector into a 2D image\r\n- `im2flat`: transforms a 2D image in a flat vector\r\n- `im2label`: GUI to transform images in labels for image segmentation (very automated function)\r\n- `scale255`: scales an image to the [0, 255] range\r\n- `align_features`: Align images with Feature-Based algorithm, from OpenCV (maybe not working)\r\n- `align_ECC`: image alignment using ECC algorithm from OpenCV (diffuse image)\r\n- `imwarp`: function to warp a set of images using a warp matrix (maybe not working)\r\n \r\n \r\n### 3. Filtering Images and Signals\r\n\r\n- `filter_finder`: study and find which filter to use (for signals, 1D)\r\n- `highpass_gauss`: high-pass Gaussian filter for images (2D)\r\n- `highpass_fft`: high-pass image (2D) filter based on FFT\r\n- `lowpass_fft`: low-pass image (2D) filter based on FFT\r\n- `filt_hist`: filtering histograms with zero/null values (removing zeros)\r\n\r\n\r\n### 4. Bonus Functions\r\n\r\n- `beep`: making 'beeps' to help warn when a long algorithm has finished\r\n- `isoareas`: complex function to measure pixels' intensity in adjacent areas. This is a very specific function to process fluorescence intensities of cells in confocal microscopy images\r\n- `good_colormaps`: visualizing the best Matplotlib colormaps in an image\r\n- `improfile`: finds the pixels' intensity profile between two points (GUI) (maybe not working)\r\n\r\n\r\n\r\n### 5. Tutorials and Examples\r\n\r\nInside the `tutorials` folder there are some examples of using the functions of this library. In this folder, the files with name `imex_name.py` present an example of using the function indicated by the `name` part.\r\n\r\n\r\n\r\n### 6. How to Install\r\n\r\nYou can install using `pip`:\r\n\r\n```\r\npip install image-functions==0.1.8\r\n```\r\n\r\n*OBS*: some functions use the 'pynput' and 'windsound' libraries, which may be difficult to install and do not works on non-windows platforms. Comment on these library imports if there are problems during installation or loading.\r\n\r\n- author: Marlon Rodrigues Garcia\r\n- contact: marlon.garcia@unesp.br\r\n- institution: Sao Paulo State University (Unesp)\r\n\r\n\r\n### 7. Scientific Research\r\n\r\nThis work is the product of the research being conducted at two universities in Brazil:\r\n\r\n#### Sao Paulo State University (Unesp)\r\n- Dept. of Electronic and Telecommunication Engineering\r\n- School of Engineering, Campus of Sao Joao da Boa Vista\r\n- website: https://www.sjbv.unesp.br/\r\n\r\n#### University of S\u00e3o Paulo (USP)\r\n- Biophotonics Laboratory, Optics Group (GO)\r\n- S\u00e3o Carlos Institute of Physics (IFSC)\r\n- website: https://www2.ifsc.usp.br/english/\r\n",
"bugtrack_url": null,
"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. ",
"summary": "Image Processing Functions",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/MarlonGarcia/imfun"
},
"split_keywords": [
"image processing",
" digital image",
" image functions",
" machine learning data preparation",
" artificial intelligence data preparation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4653d3df18e0b8c8363d1c1f8d7608e3038fb1edc640c8c0667ae462101004ea",
"md5": "a471b6f6265562b67cabb3811d7eaa61",
"sha256": "f95d7690162abfa966a0b2b71a3b4d55aae9a6841462209abc5a0833cdfcf335"
},
"downloads": -1,
"filename": "image_functions-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a471b6f6265562b67cabb3811d7eaa61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 37531,
"upload_time": "2024-11-04T04:29:49",
"upload_time_iso_8601": "2024-11-04T04:29:49.749777Z",
"url": "https://files.pythonhosted.org/packages/46/53/d3df18e0b8c8363d1c1f8d7608e3038fb1edc640c8c0667ae462101004ea/image_functions-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ef2c8aaa53fc0e76f58f9db11b3b4bad9be100221dd516c1bef83441b0cee93",
"md5": "ab79ff2dd02ed27ea07c293def175314",
"sha256": "a386f9bdc73d14e1e119314fbe712ffe2702a347bc03412f5c5e1bccbce5d3a9"
},
"downloads": -1,
"filename": "image_functions-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "ab79ff2dd02ed27ea07c293def175314",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 35118,
"upload_time": "2024-11-04T04:29:51",
"upload_time_iso_8601": "2024-11-04T04:29:51.334904Z",
"url": "https://files.pythonhosted.org/packages/7e/f2/c8aaa53fc0e76f58f9db11b3b4bad9be100221dd516c1bef83441b0cee93/image_functions-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 04:29:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarlonGarcia",
"github_project": "imfun",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "image-functions"
}