From 87a20fd8ac53d74865f57ee350311a2614da0d87 Mon Sep 17 00:00:00 2001
From: pswain <peter.swain@ed.ac.uk>
Date: Fri, 20 Oct 2023 11:10:01 +0100
Subject: [PATCH] added more documentation
---
src/agora/io/cells.py | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/src/agora/io/cells.py b/src/agora/io/cells.py
index 13c540a..5656dcb 100644
--- a/src/agora/io/cells.py
+++ b/src/agora/io/cells.py
@@ -16,6 +16,9 @@ class Cells:
"""
Extract information from an h5 file.
+ Use output from BABY to find cells detected, get, and fill, edge masks
+ and retrieve mother-bud relationships.
+
This class accesses in the h5 file:
'cell_info', which contains 'angles', 'cell_label', 'centres',
@@ -25,11 +28,11 @@ class Cells:
'trap_info', which contains 'drifts', and 'trap_locations'.
- The "timepoint", "cell_label", and "trap" variables are consistent 1D lists.
+ The "timepoint", "cell_label", and "trap" variables are mutually consistent
+ 1D lists.
Examples are self["timepoint"][self.get_idx(1, 3)] to find the time points
where cell 1 was present in trap 3.
-
"""
def __init__(self, filename, path="cell_info"):
--
GitLab