phasecongruency 0.2.3__tar.gz

phasecongruency-0.2.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Peter Kovesi
+
+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.

phasecongruency-0.2.3/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+include logo.png
+recursive-include phasecongruency *.py

phasecongruency-0.2.3/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: phasecongruency
+Version: 0.2.3
+Summary: Phase based feature detection and image enhancement
+Author: Peter Kovesi
+Maintainer: sigjhl
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sigjhl/ImagePhaseCongruency.py
+Project-URL: Repository, https://github.com/sigjhl/ImagePhaseCongruency.py
+Project-URL: Issues, https://github.com/sigjhl/ImagePhaseCongruency.py/issues
+Keywords: image-processing,phase-congruency,feature-detection,computer-vision
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20
+Requires-Dist: scipy>=1.7
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# phasecongruency
+
+Python package for phase-congruency-based feature detection and phase-preserving image enhancement.
+
+## Installation
+
+From source with pip:
+
+```bash
+pip install .
+```
+
+Editable install for development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Or with uv:
+
+```bash
+uv sync --extra dev
+```
+
+## Quick Start
+
+```python
+from phasecongruency import phasecongmono, phasecong3, phasesym, step2line
+
+img = step2line(256)
+
+# Fast monogenic phase congruency (defaults)
+PC, orientation, phase_type, T = phasecongmono(img)
+
+# Tuned monogenic phase congruency (all key parameters configurable)
+PC2, orientation2, phase_type2, T2 = phasecongmono(
+    img,
+    nscale=5,
+    minwavelength=3,
+    mult=2.1,
+    sigmaonf=0.55,
+    k=3.0,
+    noisemethod=-1,
+    cutoff=0.5,
+    g=10.0,
+    deviationgain=1.5,
+)
+
+# Oriented phase congruency (edge/corner moments)
+M, m, or_, feat_type, EO, T3 = phasecong3(
+    img,
+    nscale=4,
+    norient=6,
+    minwavelength=3,
+    mult=2.1,
+    sigmaonf=0.55,
+    k=2.0,
+    cutoff=0.5,
+    g=10.0,
+    noisemethod=-1,
+)
+
+# Phase symmetry (blob/line-like structures)
+phSym, orient, totalEnergy, Tps = phasesym(img)
+```
+
+## Parameter Configurability
+
+Core algorithm parameters are exposed as keyword arguments in Python.
+
+- Use keyword arguments on: `phasecongmono`, `phasecong3`, `phasesymmono`, `phasesym`, `ppdrc`, `ppdenoise`, `monofilt`, `gaborconvolve`, `highpassmonogenic`, and `bandpassmonogenic`.
+- Default values are defined in each function signature.
+- Inspect any callable signature directly:
+
+```python
+from inspect import signature
+from phasecongruency import phasecongmono
+print(signature(phasecongmono))
+```
+
+## Run Tests
+
+```bash
+UV_CACHE_DIR=.uv-cache uv run pytest tests -q
+# or
+pytest tests -q
+```
+
+## Scope
+
+This repository now maintains the Python implementation only. The historical Julia transpilation/validation workflow has been retired from the active tree.
+
+## Validation Provenance
+
+A Julia-vs-Python fidelity validation was completed before this cleanup. See:
+
+- `docs/validation.md`
+
+## Attribution
+
+This work is based on Peter Kovesi's phase congruency methods and was originally transpiled from:
+
+- [ImagePhaseCongruency.jl](https://github.com/peterkovesi/ImagePhaseCongruency.jl)

phasecongruency-0.2.3/README.md

@@ -0,0 +1,103 @@
+# phasecongruency
+
+Python package for phase-congruency-based feature detection and phase-preserving image enhancement.
+
+## Installation
+
+From source with pip:
+
+```bash
+pip install .
+```
+
+Editable install for development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Or with uv:
+
+```bash
+uv sync --extra dev
+```
+
+## Quick Start
+
+```python
+from phasecongruency import phasecongmono, phasecong3, phasesym, step2line
+
+img = step2line(256)
+
+# Fast monogenic phase congruency (defaults)
+PC, orientation, phase_type, T = phasecongmono(img)
+
+# Tuned monogenic phase congruency (all key parameters configurable)
+PC2, orientation2, phase_type2, T2 = phasecongmono(
+    img,
+    nscale=5,
+    minwavelength=3,
+    mult=2.1,
+    sigmaonf=0.55,
+    k=3.0,
+    noisemethod=-1,
+    cutoff=0.5,
+    g=10.0,
+    deviationgain=1.5,
+)
+
+# Oriented phase congruency (edge/corner moments)
+M, m, or_, feat_type, EO, T3 = phasecong3(
+    img,
+    nscale=4,
+    norient=6,
+    minwavelength=3,
+    mult=2.1,
+    sigmaonf=0.55,
+    k=2.0,
+    cutoff=0.5,
+    g=10.0,
+    noisemethod=-1,
+)
+
+# Phase symmetry (blob/line-like structures)
+phSym, orient, totalEnergy, Tps = phasesym(img)
+```
+
+## Parameter Configurability
+
+Core algorithm parameters are exposed as keyword arguments in Python.
+
+- Use keyword arguments on: `phasecongmono`, `phasecong3`, `phasesymmono`, `phasesym`, `ppdrc`, `ppdenoise`, `monofilt`, `gaborconvolve`, `highpassmonogenic`, and `bandpassmonogenic`.
+- Default values are defined in each function signature.
+- Inspect any callable signature directly:
+
+```python
+from inspect import signature
+from phasecongruency import phasecongmono
+print(signature(phasecongmono))
+```
+
+## Run Tests
+
+```bash
+UV_CACHE_DIR=.uv-cache uv run pytest tests -q
+# or
+pytest tests -q
+```
+
+## Scope
+
+This repository now maintains the Python implementation only. The historical Julia transpilation/validation workflow has been retired from the active tree.
+
+## Validation Provenance
+
+A Julia-vs-Python fidelity validation was completed before this cleanup. See:
+
+- `docs/validation.md`
+
+## Attribution
+
+This work is based on Peter Kovesi's phase congruency methods and was originally transpiled from:
+
+- [ImagePhaseCongruency.jl](https://github.com/peterkovesi/ImagePhaseCongruency.jl)

phasecongruency-0.2.3/phasecongruency/__init__.py

@@ -0,0 +1,107 @@
+"""
+Image Phase Congruency
+
+Phase based feature detection and image enhancement.
+
+Peter Kovesi
+peterkovesi.com
+"""
+
+# Phase congruency and feature detection
+from .phasecongruency import (
+    phasecongmono,
+    phasesymmono,
+    ppdrc,
+    highpassmonogenic,
+    bandpassmonogenic,
+    gaborconvolve,
+    monofilt,
+    phasecong3,
+    phasesym,
+    ppdenoise,
+)
+
+# Frequency domain filters
+from .frequencyfilt import (
+    filtergrid,
+    filtergrids,
+    gridangles,
+    cosineangularfilter,
+    gaussianangularfilter,
+    lowpassfilter,
+    highpassfilter,
+    bandpassfilter,
+    highboostfilter,
+    loggabor,
+    monogenicfilters,
+    packedmonogenicfilters,
+    perfft2,
+    geoseries,
+)
+
+# Synthetic test images
+from .syntheticimages import (
+    step2line,
+    circsine,
+    starsine,
+    noiseonf,
+    nophase,
+    quantizephase,
+    swapphase,
+)
+
+# Utilities
+from .utilities import (
+    replacenan,
+    fillnan,
+    hysthresh,
+    imgnormalise,
+    imgnormalize,
+    histtruncate,
+)
+
+__version__ = "0.2.3"
+
+__all__ = [
+    # Phase congruency
+    "phasecongmono",
+    "phasesymmono",
+    "ppdrc",
+    "highpassmonogenic",
+    "bandpassmonogenic",
+    "gaborconvolve",
+    "monofilt",
+    "phasecong3",
+    "phasesym",
+    "ppdenoise",
+    # Frequency filters
+    "filtergrid",
+    "filtergrids",
+    "gridangles",
+    "cosineangularfilter",
+    "gaussianangularfilter",
+    "lowpassfilter",
+    "highpassfilter",
+    "bandpassfilter",
+    "highboostfilter",
+    "loggabor",
+    "monogenicfilters",
+    "packedmonogenicfilters",
+    "perfft2",
+    "geoseries",
+    # Synthetic images
+    "step2line",
+    "circsine",
+    "starsine",
+    "noiseonf",
+    "nophase",
+    "quantizephase",
+    "swapphase",
+    # Utilities
+    "replacenan",
+    "fillnan",
+    "hysthresh",
+    "imgnormalise",
+    "imgnormalize",
+    "histtruncate",
+]