Skip to content

Commit 7145611

Browse files
committed
Update README.md
1 parent 08f11f6 commit 7145611

File tree

1 file changed

+31
-18
lines changed

1 file changed

+31
-18
lines changed

README.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
# Delaunay-Watershed 3D
22

3-
<img src="https://raw.githubusercontent.com/sacha-ichbiah/delaunay_watershed_3d/main/Figures_readme/Figure_logo_white_arrow.png" alt="drawing" width="300"/>
3+
[![CC BY-NC-SA 4.0][cc-by-nc-sa-shield]][cc-by-nc-sa]
4+
5+
<img src="Figures_readme/Figure_logo_white_arrow.png" alt="drawing" width="300"/>
46

57

68
**Delaunay-Watershed-3D** is an algorithm designed to reconstruct a sparse representation of the geometry of tissues and cell nuclei from instance segmentations, in 3D. It accomplishes this by building multimaterial meshes from segmentation masks. These multimaterial meshes are perfectly suited for **storage, geometrical analysis, sharing** and **visualisation of data**. We provide high level APIs to extract geometrical features from the meshes, as well as visualisation tools based on [polyscope](https://polyscope.run) and [napari](https://napari.org).
79

810
Delaunay-Watershed was created by Sacha Ichbiah during his PhD in [Turlier Lab](https://www.turlierlab.com), and is maintained by Sacha Ichbiah, Matthieu Perez and Hervé Turlier. For support, please open an issue.
9-
A preprint of the method will be published soon. If you use our library in your work please cite the paper.
11+
If you use this library in your work please cite the [paper](https://doi.org/10.1101/2023.04.12.536641).
1012

11-
Introductory notebooks with precise use case are provided.
13+
Introductory notebooks on two examples (cells in an aggregate and nuclei) are provided.
1214
The algorithm takes as input segmentation masks and return multimaterial triangle meshes (3D).
1315

14-
This method is used as a backend for [foambryo](https://github.com/VirtualEmbryo/foambryo), our 3D tension inference library.
16+
This method is used as a backend for [foambryo](https://github.com/VirtualEmbryo/foambryo), our 3D tension and pressure inference library.
1517

1618

17-
### Example
19+
### Quick start example
1820

19-
Load an instance segmentation, reconstruct its multimaterial mesh, and extract its geometry:
21+
Load an instance segmentation, construct its multimaterial mesh, and extract geometrical features of cells:
2022

2123
```shell
2224
pip install delaunay-watershed-3d
23-
2425
```
2526

2627
```py
@@ -47,14 +48,16 @@ Mesh.compute_angles_junctions()
4748

4849
### Installation
4950

50-
`pip install delaunay-watershed-3d`
51+
```shell
52+
pip install delaunay-watershed-3d
53+
```
5154

5255
---
5356

54-
### API and Documentation
57+
### API and documentation
5558

5659
#### 1 - Creating a multimaterial mesh:
57-
The first step is to convert your instance segmentation into a multimaterial mesh
60+
The first step is to convert your instance segmentation masks into a multimaterial mesh
5861

5962
- `geometry_reconstruction_3d(labels,min_dist = 5, expansion_labels = 0,original_image = None,print_info = False, mode='torch')`:
6063
- `Mesh` is a `DCEL_Data` object
@@ -86,23 +89,23 @@ A `DCEL_Data` object can be used to analyze the geometry:
8689
- `self.compute_length_halfedges(), self.compute_areas_faces(), self.compute_centroids_cells(), self.compute_areas_cells(), self.compute_areas_interfaces(), self.compute_volumes_cells(), compute_length_trijunctions()
8790

8891
---
89-
### Biological use-cases
92+
### Biological examples
9093

91-
#### Geometrical reconstruction of P.Mammilata Embryo
92-
Data from [Guignard et al.](https://www.science.org/doi/10.1126/science.aar5663)
94+
#### Geometrical reconstruction of cell interfaces in the *P. Mammilata* embryo
95+
Segmentation masks from [Guignard et al.](https://www.science.org/doi/10.1126/science.aar5663)
9396

94-
![](https://raw.githubusercontent.com/sacha-ichbiah/delaunay_watershed_3d/main/Figures_readme/DW_3d.png "Title")
97+
![](Figures_readme/DW_3d.png "Title")
9598

96-
#### Geometrical reconstruction of Cell Nuclei
97-
Data from [Stardist](https://github.com/stardist/stardist)
99+
#### Geometrical reconstruction of cell nuclei
100+
Segmentation masks from [Stardist](https://github.com/stardist/stardist)
98101

99-
![](https://raw.githubusercontent.com/sacha-ichbiah/delaunay_watershed_3d/main/Figures_readme/DW_3d_nuclei.png "Title")
102+
![](Figures_readme/DW_3d_nuclei.png "Title")
100103

101104
---
102105

103106

104107
### Credits, contact, citations
105-
If you use this tool, please cite the associated preprint.
108+
If you use this tool, please cite the associated paper.
106109
Do not hesitate to contact Sacha Ichbiah and Hervé Turlier for practical questions and applications.
107110
We hope that **Delaunay-Watershed** could help biologists and physicists to shed light on the mechanical aspects of early development.
108111

@@ -121,3 +124,13 @@ We hope that **Delaunay-Watershed** could help biologists and physicists to shed
121124
}
122125
```
123126

127+
### License
128+
129+
This work is licensed under a
130+
[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].
131+
132+
[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa]
133+
134+
[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/
135+
[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png
136+
[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg

0 commit comments

Comments
 (0)