Skip to content

Commit

Permalink
testing new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GiorgiaTortora committed Nov 7, 2023
1 parent 48625ca commit b5add4e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To install latest development version :

## Usage

You can find the detailed guide at https://github.com/GiorgiaTortora/napari-roi-registration/blob/main/docs/napari-roi-registration_guide.pdf
Detailed instructions on how to use the napari-roi-registration plugin can be found at https://github.com/GiorgiaTortora/napari-roi-registration/blob/main/docs/napari-roi-registration_guide.pdf.

### Registration Widget

Expand Down
16 changes: 15 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Welcome to napari-roi-registration

A plugin to perform roi registration.
napari-roi-registration is a plugin for simultaneous registration of multiple regions of interest (ROIs) in time lapse acquisition datasets (multiframe datasets) and for the subsequent processing of the registered data. The plugin works on single channel datasets as well as multichannel datasets.
The plugin consists of three widgets: the Background Widget, the Registration Widget and the Processing Widget.

##Background Widget

The Background Widget allows a pre-processing of data, and it is typically useful when ambient light affects the measurements. It enables the removal of background on each frame of the time-lapse dataset. The background is calculated as the mean intensity of the pixels under a chosen area of one frame of the stack. The area of the frame is chosen drawing a label in a labels layer.

###List of parameters

image: The image stack (time, channel, y, x) to be corrected.
labels: The labels layer where the user drew the label which will be used to calculate the background.

###How to use the Background Widget

1. Open the image you want to correct in the napari viewer. If you open more than one image in the viewer, select the image you want to correct in the image menu of the Background Widget.
Binary file added images/background.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b5add4e

Please sign in to comment.