Skip to main content

A simple plugin to interact with images Fourier transforms

Project description

napari-ft

License BSD-3 PyPI Python Version tests codecov napari hub npe2 Copier

A napari plugin for interactive Fourier transform filtering


This napari plugin was generated with copier using the napari-plugin-template (None).

Features

Interactive Fourier Transform Filter Widget

This widget allows you to:

  • Select a 2D image from the napari viewer
  • View its FFT-shifted Fourier transform (log magnitude) in the widget
  • Interactively draw rectangular or circular regions on the Fourier transform
    • Left-click and drag: Create inclusion regions (frequencies to keep)
    • Right-click and drag: Create exclusion regions (frequencies to remove)
    • Middle-click and drag: Pan the view
    • Mouse wheel: Zoom in/out
  • Toggle between rectangle and circle shape modes
  • Apply inverse Fourier transform with frequency masking
  • See real-time updates of the filtered image as you draw new regions
  • Reset boxes or view independently

The filtered image automatically updates as you draw, providing immediate visual feedback. The widget tracks changes to the source image data and scale, keeping everything synchronized.

How to Use

  1. Load a 2D image into napari viewer
  2. Open the widget: Plugins -> napari-ft -> Fourier Transform Filter
  3. Select your image from the dropdown menu
  4. The FFT-shifted Fourier transform appears in the widget
  5. Draw regions on the Fourier transform:
    • Left-click and drag to select frequencies to keep
    • Right-click and drag to exclude specific frequencies
    • Use "Shape" button to toggle between rectangles and circles
  6. The filtered image appears automatically and updates in real-time
  7. Use mouse wheel to zoom, middle-click to pan
  8. Click "Reset Boxes" to clear all regions or "Reset View" to reset zoom/pan

Installation

You can install napari-ft via pip:

pip install napari-ft

If napari is not already installed, you can install napari-ft with napari and Qt via:

pip install "napari-ft[all]"

Testing

To test the widget, run the included test script:

python test_ft_widget.py

This will open napari with a test image containing multiple frequency components.

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "napari-ft" is free and open source software

Issues

If you encounter any problems, please [file an issue] along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari_ft-0.1.2.tar.gz (23.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_ft-0.1.2-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file napari_ft-0.1.2.tar.gz.

File metadata

  • Download URL: napari_ft-0.1.2.tar.gz
  • Upload date:
  • Size: 23.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for napari_ft-0.1.2.tar.gz
Algorithm Hash digest
SHA256 fbed2e9542bb4dc6427155bc37e1e8d0e2ad39c52f53fa2ca4fda00bc175bfbd
MD5 62c1bf29a2f138f27da7d5409b0e566f
BLAKE2b-256 e342f5579f31e9668401a34044ca9075436c6305a5a36b3e7f9b96f651f2a307

See more details on using hashes here.

File details

Details for the file napari_ft-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: napari_ft-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for napari_ft-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aede2cb73eaeed938d93712da3163898fec4fca27bc251fe000c1855511c5255
MD5 f4aae659c7046b004a1e08a9716d6fa8
BLAKE2b-256 b94adcffd193ba059db7acfd617b10031043f0bc6627c222c5386e71f8319ccb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page