prtools 1.2.0__tar.gz → 1.3.0__tar.gz

prtools-1.3.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: prtools
+Version: 1.3.0
+Summary: Utility functions for image-based phase retrieval
+Author: Andy Kee
+License: MIT License
+        
+        Copyright (c) 2023 Andy Kee
+        
+        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/andykee/prtools
+Project-URL: Documentation, https://andykee.github.io/prtools/
+Project-URL: Bug Tracker, https://github.com/andykee/prtools/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Provides-Extra: jax
+Requires-Dist: jax; extra == "jax"
+Requires-Dist: optax; extra == "jax"
+Dynamic: license-file
+
+prtools
+=======
+|pypi version|
+
+The prtools package implements functionality and tools that may be helpful 
+when performing image-based phase retrieval including:
+
+* Image processing, reduction, and analysis
+* Creating, fitting, and removing Zernike polynomials
+* Drawing various shapes in arrays
+* Computing statistics and optical simulation parameters
+
+Installation
+------------
+Install and update prtools using `pip`_:
+
+.. code-block:: text
+
+    pip install prtools
+
+Links
+-----
+* **Docs:** https://andykee.github.io/prtools/
+* **Releases:** https://pypi.org/project/prtools/
+* **Source:** https://github.com/andykee/prtools/
+* **Issues:** https://github.com/andykee/prtools/issues/
+
+.. _pip: https://pip.pypa.io/en/stable/getting-started/
+
+.. |pypi version| image:: https://img.shields.io/pypi/v/prtools.svg
+    :target: https://pypi.python.org/pypi/prtools

{prtools-1.2.0 → prtools-1.3.0}/README.rst

@@ -20,7 +20,7 @@ Install and update prtools using `pip`_:
 
 Links
 -----
-* **Docs:** https://prtools.readthedocs.io/
+* **Docs:** https://andykee.github.io/prtools/
 * **Releases:** https://pypi.org/project/prtools/
 * **Source:** https://github.com/andykee/prtools/
 * **Issues:** https://github.com/andykee/prtools/issues/

prtools-1.3.0/prtools/__init__.py

@@ -0,0 +1,66 @@
+__version__ = '1.3.0'
+
+from prtools._backend import __backend__, use
+
+from prtools.array import (
+    centroid,
+    pad,
+    subarray,
+    boundary,
+    rebin,
+    rescale,
+    normpow,
+    shift,
+    register,
+    medfix
+)
+
+from prtools.cost import sserror
+
+from prtools.fourier import dft2, idft2
+
+from prtools.misc import (
+    calcpsf,
+    translation_defocus,
+    fft_shape,
+    min_sampling,
+    pixelscale_nyquist,
+    find_wrapped
+)
+
+from prtools.segmented import hex_segments
+
+from prtools.shape import (
+    mesh,
+    circle,
+    hexagon,
+    rectangle,
+    spider,
+    gauss,
+    sin,
+    waffle
+)
+
+from prtools.sparse import (
+    index,
+    dense,
+    sparse,
+    index_from_mask,
+    mask_from_index
+)
+
+from prtools.stats import (
+    ee,
+    pv,
+    rms,
+    radial_avg
+)
+
+from prtools.zernike import (
+    zernike,
+    zernike_compose,
+    zernike_basis,
+    zernike_fit,
+    zernike_remove,
+    zernike_coordinates
+)

prtools-1.3.0/prtools/_backend.py

@@ -0,0 +1,73 @@
+import sys
+import types
+
+from prtools.backend import registry
+from prtools.backend._base import _BackendLibrary
+
+
+class _BackendName:
+    """Helper class for storing the backend name - needed since strings are
+    immutable.
+    """
+
+    def __init__(self, name):
+        self.name = name
+
+    def __repr__(self):
+        return self.name
+
+    def __str__(self):
+        return self.name
+
+    def __eq__(self, other):
+        return self.name == other
+
+
+class _Backend(types.ModuleType):
+    __backend__ = _BackendName(None)
+    numpy = _BackendLibrary(None)
+    scipy = _BackendLibrary(None)
+
+    @classmethod
+    def use(cls, backend):
+        """Select the backend used for N-dimensional array operations.
+
+        Parameters
+        ----------
+        backend : str
+            The backend to use. This can be any of the following backends,
+            which are case-insensitive:
+            
+            * NumPy
+            * JAX
+        """
+        #if name in registry:
+        backend = backend.lower()
+        cls.__backend__.name = backend
+        cls.numpy.module = registry.load_numpy(backend)
+        cls.scipy.module = registry.load_scipy(backend)
+
+
+    @classmethod
+    def set_backend(cls, name, numpy_module, scipy_module):
+        """Change the backend
+
+        Parameters
+        ----------
+        name : str
+            Name of the backend.
+        numpy_module : module
+            Library providing numpy-like functionality
+        scipy_module : module
+            Library providing scipy-like functionality
+        """
+        cls.__backend__.name = name
+        cls.numpy.module = numpy_module
+        cls.scipy.module = scipy_module
+
+
+# use NumPy by default
+_Backend.use('numpy')
+
+# https://stackoverflow.com/a/72911884
+sys.modules[__name__].__class__ = _Backend