From 4b5775ee541ef4b52d44a5e57aa6f0358f22de9f Mon Sep 17 00:00:00 2001
From: Swainlab <peter.swain@ed.ac.uk>
Date: Wed, 24 May 2023 10:29:33 +0100
Subject: [PATCH] more docs
---
src/agora/utils/indexing.py | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/src/agora/utils/indexing.py b/src/agora/utils/indexing.py
index 5eedeabe..503d589c 100644
--- a/src/agora/utils/indexing.py
+++ b/src/agora/utils/indexing.py
@@ -19,9 +19,11 @@ def validate_association(
"""
Identify matches between two arrays by comparing rows.
+ We match lineage data on mother-bud pairs with all the cells identified to specialise to only those cells in mother-bud pairs.
+
We use broadcasting for speed.
- Both mother and bud in association must be in indices.
+ Both a mother and bud in association must be in indices.
Parameters
----------
@@ -30,7 +32,8 @@ def validate_association(
or
a 3D array, which is an array of 2 X 2 arrays comprising [[trap_id, mother_label], [trap_id, daughter_label]].
indices : np.ndarray
- A 2D array where each column is a different level, such as (trap_id, cell_label). This array should not include mother_label.
+ A 2D array where each column is a different level, such as (trap_id, cell_label), which typically is an index of a Signal
+ dataframe. This array should not include mother_label.
match_column: int
If 0, matches indicate mothers from mother-bud pairs;
If 1, matches indicate daughters from mother-bud pairs;
--
GitLab