Skip to main content

A plugin for plotting intensity profiles with control features in napari.

Project description

napari-intensity-plotter

License BSD-3 PyPI Python Version tests codecov napari hub

napari-intensity-plotter

napari-intensity-plotter is a plugin for napari that provides tools to measure and plot intensity profiles in 2D time-series images.

Intensity Plot Widget

Screenshot: Intensity profile of a region of interest in a 2D time-series image.

Features

  • Intensity Plot Widget: Allows you to select a region of interest in a 2D time-series image and plot the intensity profile over time.
  • Intensity Plot Control Widget: Lets you fine-tune plot parameters and save the results as CSV or PNG files.

Installation

You can install napari-intensity-plotter via pip:

pip install napari-intensity-plotter

Alternatively, you can install it directly from the napari plugin interface.

Usage

  1. Load a 2D Time-Series Image
    Load a 2D time-series image (e.g., fluorescence microscopy data) in napari.

  2. Activate the Widgets
    Open the Intensity Plot Widget and Intensity Plot Control Widget from the Plugins menu in napari.

  3. Intensity Plot Widget

    • Move your mouse over the image, or click on a specific location to plot the intensity profile of the selected region across slices (e.g., time).
    • The region of interest (ROI) size can be adjusted using the square size setting in the control widget.
  4. Intensity Plot Control Widget

    • Configure the square size for the ROI (ensures that the region size remains odd).
    • Set the directory to save plots and intensity data.
    • Save the intensity profile as a .csv or .png file by clicking the corresponding buttons or using keyboard shortcuts (Ctrl+S).
  5. Additional Controls

    • Hide all layers using the Hide All Layers button or Ctrl+D.
    • Use the rectangle to visualize the selected ROI.

Example Workflow

Step 1: Load a 2D time-series image (e.g., tif or nd2) into napari. Ensure the layer is visible.

Step 2: Open the Intensity Plot Widget to visualize intensity changes over time or slices for a specific ROI.

Step 3: Use the Intensity Plot Control Widget to:

  • Adjust the square size for the ROI.
  • Specify a directory to save intensity data.
  • Enable saving in CSV or PNG formats.

Step 4: Save the plotted intensity data by clicking Save to CSV/PNG or pressing Ctrl+S.

Step 5: Hide all layers if necessary using Hide All Layers or Ctrl+D.

Contributing

Contributions are welcome! If you encounter issues or have ideas for new features, please submit them via the GitHub Issues.

Acknowledgements

This plugin was developed using the napari plugin cookiecutter template, which greatly streamlined the creation of this tool. See the cookiecutter-napari-plugin for more details.

Special thanks to the napari community for their continuous support and resources.

License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for details.

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_intensity_plotter-0.1.6.tar.gz (2.9 MB view details)

Uploaded Source

Built Distribution

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

napari_intensity_plotter-0.1.6-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file napari_intensity_plotter-0.1.6.tar.gz.

File metadata

File hashes

Hashes for napari_intensity_plotter-0.1.6.tar.gz
Algorithm Hash digest
SHA256 b8e87077cf0f1e667578358208a41c0aa131430be89ca914eaf05e1b8bbf9d61
MD5 04297fa794802b7c1a58e4eb0236de8f
BLAKE2b-256 712c63ea3e7ed08d29993d88561ed12bd0c28f9e32eb92fcb5a38cf8fbc407ce

See more details on using hashes here.

File details

Details for the file napari_intensity_plotter-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_intensity_plotter-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f8d08ce74f1b6278b7fbdfc186b73da7a25abb512ec05849b163d60b7edfad95
MD5 29716f44e559902ba4e35c8157eaaea4
BLAKE2b-256 1fe13cecc5aa3d3a5ce684c273e45644e810f150adf646a7c983c1cff6837a68

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