Skip to content

Commit c102195

Browse files
authored
update readme with sphere and TODO in docs (#180)
1 parent 315f646 commit c102195

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# blik
44

55
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10090438.svg)](https://zenodo.org/doi/10.5281/zenodo.10090438)
6+
[![Paper DOI](https://zenodo.org/badge/DOI/10.1371/journal.pbio.3002447.svg)](https://doi.org/10.1371/journal.pbio.3002447)
67
[![License](https://img.shields.io/pypi/l/blik.svg?color=green)](https://github.com/brisvag/blik/raw/main/LICENSE)
78
[![PyPI](https://img.shields.io/pypi/v/blik.svg?color=green)](https://pypi.org/project/blik)
89
[![Python Version](https://img.shields.io/pypi/pyversions/blik.svg?color=green)](https://python.org)
@@ -54,13 +55,14 @@ The `-w blik` is important for proper initialization of all the layers. Always o
5455
The main widget has a few functions:
5556

5657
- `experiment`: quickly switch to a different experiment id (typically, everything related to an individual tomogram such as volume, particles and segmentations)
57-
- `new`: generate a new `segmentation`, a new manually-picked set of `particles`, or a new `surface picking` or `filament picking` for segmentation, particle generation or volume resampling.
58+
- `new`: generate a new `segmentation`, a new manually-picked set of `particles`, or a new `surface`, `sphere`, or `filament picking` for segmentation, particle generation or volume resampling.
5859
- `add to exp`: add a layer to the currently selected `experiment` (just a shorthand for `layer.metadata['experiment_id'] = current_exp_id`)
5960
- `slice_thickness`: changes the slicing thickness in all dimensions in napari. Images will be averaged over that thickness, and all particles in the slice will be displayed.
6061

61-
There are also widgets for picking of both surfaces and filaments.
62+
There are also widgets for picking surfaces, spheres and filaments:
6263

6364
- `surface`: process a previously picked `surface picking` layer to generate a surface mesh and distribute particles on it for subtomogram averaging, or resample a tomogram along the surface.
65+
- `sphere`: process a previously picked `sphere picking` layer to generate a sphere mesh and distribute particles on it for subtomogram averaging.
6466
- `filament`: process a previously picked `filament picking` layer to generate a filament and distribute particles on it for subtomogram averaging, or resample a tomogram along the filament.
6567

6668
# References

docs/getting_started.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,14 @@ name: surface_particles
180180
Particles uniformly distributed on the generated surface.
181181
```
182182

183+
### Surface from a segmentation
184+
185+
TODO!
186+
187+
### Sphere picking
188+
189+
TODO!
190+
183191
### Filament picking
184192

185193
Another geometrical picking model implemented in blik is the `filament picker`. The procedure is similar to that for surfaces. To start defining a new filament, we need to create a new `filament picking` in the main widget. This will open a new `Points` layer called `filament picks`.

0 commit comments

Comments
 (0)