From 9b090222511557cea72ec5033116fe5bbf7deaae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Al=C3=A1n=20Mu=C3=B1oz?= <alan.munoz@ed.ac.uk>
Date: Tue, 28 Feb 2023 20:02:32 +0000
Subject: [PATCH] docs(cells): improve cells documentation
---
src/agora/io/cells.py | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/src/agora/io/cells.py b/src/agora/io/cells.py
index 00e4fd33..72cc641a 100644
--- a/src/agora/io/cells.py
+++ b/src/agora/io/cells.py
@@ -358,8 +358,8 @@ class Cells:
@cached_property
def mothers_daughters(self) -> np.ndarray:
"""
- Return a single array with three columns, containing information about the mother-daughter relationships:
- tile, mothers and daughters.
+ Return a single array with three columns, containing information about
+ the mother-daughter relationships: tile, mothers and daughters.
Returns
-------
@@ -481,7 +481,9 @@ class Cells:
return nested_massign
@lru_cache(maxsize=200)
- def labelled_in_frame(self, frame: int, global_id=False) -> np.ndarray:
+ def labelled_in_frame(
+ self, frame: int, global_id: bool = False
+ ) -> np.ndarray:
"""
Returns labels in a 4D ndarray with the global ids with shape
(ntraps, max_nlabels, ysize, xsize) at a given frame.
@@ -621,6 +623,7 @@ class Cells:
size=1,
min_ncells: int = 2,
min_consecutive_ntps: int = 5,
+ interval: t.Union[None, t.Tuple[int, int]] = None,
seed=0,
) -> t.Tuple[t.Tuple[t.List[int], t.List[int], t.List[int]], np.ndarray]:
"""
--
GitLab