numpyimage 2.8.0__tar.gz → 3.0.0__tar.gz

numpyimage-3.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jasper Phelps
+
+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.

numpyimage-3.0.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: numpyimage
+Version: 3.0.0
+Summary: Load, save, & manipulate image files as numpy arrays
+Author-email: Jasper Phelps <jasper.s.phelps@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Jasper Phelps
+        
+        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: Repository, https://github.com/jasper-tms/npimage
+Keywords: images,pixel arrays,image formats,convert,graphics,draw simple shapes
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pillow
+Requires-Dist: pillow-heif
+Requires-Dist: tifffile
+Requires-Dist: pynrrd
+Requires-Dist: matplotlib
+Requires-Dist: opencv-python-headless
+Provides-Extra: all
+Requires-Dist: tqdm; extra == "all"
+Requires-Dist: av; extra == "all"
+Dynamic: license-file
+
+# npimage
+Need to load pixel values from image files as numpy arrays, and hate having to remember whether you should use PIL, tifffile, matplotlib, or something else? Hate having to deal with the fact that those libraries all use different function names and syntaxes? Wish you could just provide a filename and get back a numpy array? This library's `imageio.py` does that, with `array = npimage.load(filename)`, `npimage.save(array, filename)`, and `npimage.show(array)` functions that let you easily handle a number of common image file formats without having to remember library-specific syntax. Additionally, `vidio.py` provides `array = npimage.load_video(filename)` and `npimage.save_video(array, filename)` for videos as well. (Another similar library to consider using is [imageio](https://pypi.org/project/imageio/).)
+
+Want to draw simple shapes like lines, triangles, and circles into 3D numpy arrays? Frustrated that the python libraries you can find online like `opencv` and `skimage.draw` work on 2D arrays but not 3D? I wrote some functions in `graphics.py` that do the trick in 3D. (If you know of another library that can do this, please let me know!)
+
+
+### Documentation
+- `imageio.py`: load, save, or show images.
+- `vidio.py`: load or save videos.
+- `graphics.py`: draw points, lines, triangles, circles, or spheres into 2D or 3D numpy arrays representing image volumes.
+- `nrrd_utils.py`: compress or read metadata from `.nrrd` files.
+- `operations.py`: perform operations on images.
+
+Check each function's docstring for more details.
+
+
+### Installation
+
+As is always the case in python, consider making a virtual environment (using your preference of conda, virtualenv, or virtualenvwrapper) before installing.
+
+**Option 1:** `pip install` from PyPI:
+
+    pip install numpyimage
+
+(Unfortunately the name `npimage` was already taken on PyPI, so `pip install npimage` will get you a different package.)
+
+**Option 2:** `pip install` directly from GitHub:
+    
+    pip install git+https://github.com/jasper-tms/npimage.git
+
+**Option 3:** First `git clone` this repo and then `pip install` it from your clone:
+
+    cd ~/repos  # Or wherever on your computer you want to download this code to
+    git clone https://github.com/jasper-tms/npimage.git
+    cd npimage
+    pip install .
+
+**After installing,** you can import this package in python using `import npimage` (not `import numpyimage`!)

{numpyimage-2.8.0 → numpyimage-3.0.0}/npimage/utils.py

@@ -11,8 +11,9 @@ Function list:
 - transpose_metadata (reverse the order of all per-axis metadata values)
 """
 
-from typing import Union
+from typing import Union, Optional
 from collections import OrderedDict
+from fractions import Fraction
 
 import numpy as np
 
@@ -111,8 +112,8 @@ def find_channel_axis(data,
     return None
 
 
-def transpose_metadata(metadata: dict or OrderedDict,
-                       inplace: bool = True) -> dict or OrderedDict or None:
+def transpose_metadata(metadata: Union[dict, OrderedDict],
+                       inplace: bool = True) -> Optional[Union[dict, OrderedDict]]:
     """
     Reverse the order of all metadata values that have a separate entry
     for each axis of the data.
@@ -202,3 +203,19 @@ def remove_out_of_bounds(coords, shape, allow_negative_wrapping=False,
                          convention='corner'):
     in_bounds = is_in_bounds(coords, shape, allow_negative_wrapping, convention)
     return coords[in_bounds]
+
+
+def limit_fraction(fraction: Union[Fraction, float], to: int = 2**31) -> Fraction:
+    """
+    Limit a Fraction to ensure both numerator and denominator are smaller than a given value.
+
+    This is useful for ensuring compatibility with FFmpeg, which expresses framerates
+    as ratios of two 32-bit signed integers.
+    """
+    fraction = Fraction(fraction)
+    new_fraction = fraction
+    limit = to
+    while abs(new_fraction.numerator) >= to or abs(new_fraction.denominator) >= to:
+        new_fraction = fraction.limit_denominator(limit)
+        limit = limit // 2
+    return new_fraction