Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zoccoler authored Dec 21, 2022
1 parent 3bce7d2 commit fb0f8dd
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,32 @@
[![codecov](https://codecov.io/gh/zoccoler/napari-flim-phasor-calculator/branch/main/graph/badge.svg)](https://codecov.io/gh/zoccoler/napari-flim-phasor-calculator)
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-flim-phasor-calculator)](https://napari-hub.org/plugins/napari-flim-phasor-calculator)

A simple plugin to use FooBar segmentation within napari
A napari plugin to generate a phasor plot for TCSPC FLIM data.

----------------------------------

This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.
## Usage

<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started
Open a raw TCSPC FLIM image in napari and call the plugin from the Plugins menu. Specify the laser frequency, which harmonic and a threshold for the phasor plot. Optionally, apply median filters. Below is a demonstration:

and review the napari docs for plugin developers:
https://napari.org/stable/plugins/index.html
-->
<img src="https://github.com/zoccoler/napari-flim-phasor-calculator/raw/main/figures/napari_FLIM_phasor_calculator_Demo.gif" width="700"/>

## Installation
Manually draw curves on the plot to get the corresponding pixels highlighted in a new labels layer. Hold 'SHIFT' while drawing to add more than two colors.

You can install `napari-flim-phasor-calculator` via [pip]:
This plugin integrates with [napari-clusters-plotter plugin](https://github.com/BiAPoL/napari-clusters-plotter).

pip install napari-flim-phasor-calculator
This plugin can read the following FLIM file types:
- ".ptu"

This plugin works with the following data shapes:
- 2D timelapse, where time is the first dimension.

## Installation

To install latest development version :
You can install `napari-flim-phasor-calculator` via [pip]. Currently, only the development version is available:

pip install git+https://github.com/zoccoler/napari-flim-phasor-calculator.git


## Contributing

Contributions are very welcome. Tests can be run with [tox], please ensure
Expand Down

0 comments on commit fb0f8dd

Please sign in to comment.