Skip to content

Commit

Permalink
update napari plugin doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pr4deepr committed Jan 31, 2025
1 parent 4ce57f7 commit 811dcd5
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions docs/napari_plugin.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Napari Plugin

## Starting the plugin

The napari plugin has been redesigned in the newer version.
To activate the plugin, activate the `napari-lattice` environment in your terminal and type `napari` in the console.
The plugin is under `Lattice Lightsheet Analysis`
Expand All @@ -22,14 +24,38 @@ To load an image, drag and drop it into napari. You can get some sample data [he

![open_image](./images/003_open_image.png){ width="600" }

## Configuration

To configure any parameters, you can change the settings here:

![settings](./images/004_configure.png)

## Deskewing

To use the specific image for processing, you will have to select it under the `Image Layer(s) to Deskew` box on the right. Here, we will click on `RBC_tiny`. As its a czi file it should read the `metadata` accordingly and you will see a green tick.

![deskew_active](./images/deskew_active.png)

To configure any parameters, you can change the settings here:
If you are loading a czi, the metadata fields should be populated automatically.

![settings](./images/004_configure.png)
To `Preview` the deskewed image, click `Preview` and choose the appropriate `channel` and `time`.

You should see the deskewed image appear as an extra layer with the `Preview` suffix attached to it.

![deskewed](./images/005_deskewed.png){ width="600" }

??? Extra_info
If you look at the terminal after deskew, you should see the settings used and any other metadata associated with the dataset. It is handy for troubleshooting.

More instructions to be added...

## Deconvolution

## Cropping

## Workflow

## Output (Saving files)



0 comments on commit 811dcd5

Please sign in to comment.