Skip to content

Commit

Permalink
plugin guide added
Browse files Browse the repository at this point in the history
  • Loading branch information
GiorgiaTortora committed Nov 7, 2023
1 parent 5ded182 commit 38634a5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
Binary file added docs/napari-roi-registration_guide.pdf
Binary file not shown.
14 changes: 10 additions & 4 deletions src/napari_roi_registration/_widget.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,11 @@ def register_rois(viewer: Viewer, image: Image,
Parameters
----------
image: napari.layers.Image
The image stack (time,y,x) to be registered.
The image stack (time,channel,y,x) to be registered.
labels_layer: Labels
The labels will define the rectangular ROIs to be registered.
selected_channel:int
The channel on which registration will be performed.
mode: str
The type of cv2 registration.
median_filter_size:int
Expand All @@ -219,7 +221,7 @@ def register_rois(viewer: Viewer, image: Image,
Rescaling factor of the image for the registation
Does not affect the registered image scale.
bbox_zoom: int
The bounding boxes encloding the ROIs are zoomed by this factor.
The bounding boxes enclosing the ROIs are zoomed by this factor.
register_entire_image:bool
If True, the entire image is registered around the bounding box.
show_registered_stack:bool
Expand Down Expand Up @@ -468,14 +470,18 @@ def process_rois(viewer: Viewer,
The center of the ROIs to take into account during processing
labels_layer: napari.layers.Labels
The labels previously used for registration. The intensity is calculated on the labels only.
selected_channel:int
The channel to be considered for processing of data.
correct_photobleaching: bool
If True photobleaching correction is appleid to the the intensities.
plot_results:bool
If True, shows the plots of the collected data with matplotlib in the console.
save_results:bool
If True, creates an excel file with processing results.
path: str
Folder with filename of the excel file.
saving foldere: str
Folder to save the file to.
saving_filename:
Name of the file to save.
'''

if registered_points is None or labels_layer is None or image is None:
Expand Down

0 comments on commit 38634a5

Please sign in to comment.