Skip to content
This repository has been archived by the owner on Apr 20, 2024. It is now read-only.

Commit

Permalink
docs tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
vreuter committed Apr 14, 2024
1 parent b806cb5 commit 1dd1723
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ __Drag-and-drop__ visualisation of outputs from `looptrace`
This package is a plugin for [Napari](https://napari.org/stable/) to facilitate interactive viewing of various results from [`looptrace`](https://github.com/gerlichlab/looptrace).

## Guides and documentation
Included is, among other things, documentation about [what's viewable](./docs/user_docs/README.md#what-can-be-visualised) with this plugin, how to [get started](./docs/user_docs/README.md#quickstart) using this plugin, or how to [develop](./docs/development.md) this plugin.
Included are, among other things, documentation about [what's viewable](./docs/user_docs/README.md#what-can-be-visualised) with this plugin, how to [get started](./docs/user_docs/README.md#quickstart) using this plugin, and how to [develop](./docs/development.md) this plugin.

Here's the ["home" of the documentation](./docs/).
Here's the [documentation "home"](./docs/).
7 changes: 3 additions & 4 deletions docs/user_docs/locus-spots.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Locus spots visualisations
## Viewing locus spots

### Quickstart
To visualise the locus-specific spots masks, you need to __drag-and-drop files__ into an active Napari window.
Expand All @@ -10,9 +10,8 @@ To visualise the locus-specific spots masks, you need to __drag-and-drop files__
### What you should see
A Napari window with a three sliders and three layers (QC pass, QC fail, and pixel data).
- Bottom slider: ROI/trace
- Middle slider:
- Top slider:

- Middle slider: imaging timepoint
- Top slider: slice in `z`

### Details and troubleshooting
__Scrolling__
Expand Down
6 changes: 3 additions & 3 deletions docs/user_docs/nuclear-masks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Nuclear masks visualisation
## Viewing nuclear masks
First, check the [general quickstart](./README.md#quickstart), ensuring you have an environment ready to go.

### Quickstart
Expand All @@ -11,7 +11,7 @@ That folder must...
* `nuc_masks`: "images" (2D), encoding the subregions of each image deemed to be nuclei. 0 a non-nuclear pixel while positive integer indicates membership of the pixel in a particular nucleus (corresponding to a `label` value in the corresponding points/labels file for the particular field of view in question).
* `_nuclear_masks_visualisation`: table-like files (CSV), for now, with a `label` column indicating _which_ nucleus a record represents, and `yc` and `xc` columns giving y- and x-coordinates, respectively, for the centroid of a particular nuclear region.

These properties should be nearly satisfied a run of `looptrace`.
These properties should be nearly satisfied by a run of `looptrace`.
Perhaps only these steps will be required to prepare the data:
1. Copy the nuclear mask visualisation folder (with the points/labels file(s)) into a shared folder with the nuclei images and masks.
1. Add an underscore as prefix to the name of the copy of the folder.
Expand All @@ -25,7 +25,7 @@ The fields of view displayed will be those for which all three files (image, mas
* Each relevant file, regardless of which kind of data are inside, should have a basename like `PXXXX`, where `XXXX` corresponds to the 1-based integer index of the field of view, left-padded with zeroes, e.g. P0001.
* Each image or masks file should have a `.zarr` extension.
* Each points/labels file should have a `.nuclear_masks.csv` extension.
* Each `.zarr` should either have a `.zarray` immediately inside it, or a single `0` subfolder which has a `.zarray` inside it.
* Each `.zarr` should either have a `.zarray` immediately inside it, or have a single `0` subfolder which has a `.zarray` inside it.
* In general, you probably want the fields of view to match up among the three types of files involved (images, masks, points/labels), and to be numbered $1, 2, ..., N$, $N$ being the number of fields of view in your experiment (or whatever subset of the experiment you want to visualise).
* Each image or masks ZARR should in general be 2D or 5D, each of the first three axes having length 1 if 5D.
* Each points/labels file should have first column unnamed, just as row index; other columns should be `label` (unique per row, natural numbers), then `yc` and `xc` as nonnegative real numbers giving 2D coordinates of nucleus center.
Expand Down

0 comments on commit 1dd1723

Please sign in to comment.