From 88abdcbb15f23d5dc26556a641102909f76fc40d Mon Sep 17 00:00:00 2001
From: pswain <peter.swain@ed.ac.uk>
Date: Thu, 21 Jul 2022 18:09:59 +0100
Subject: [PATCH] docs(extractor): add docstring to extract_tp
---
extraction/core/extractor.py | 31 ++++++++++++++++++++++++++-----
1 file changed, 26 insertions(+), 5 deletions(-)
diff --git a/extraction/core/extractor.py b/extraction/core/extractor.py
index 285cb772..dd5af63f 100644
--- a/extraction/core/extractor.py
+++ b/extraction/core/extractor.py
@@ -324,12 +324,33 @@ class Extractor(ProcessABC):
labels=None,
**kwargs,
) -> dict:
- """
- Extract individual time-point from images and masks
+ """Core extraction method for an individual time-point.
+
+ Parameters
+ ----------
+ tp : int
+ Time-point being analysed.
+ tree : dict
+ Nested dictionary indicating channels, reduction functions and
+ metrics to use during extraction.
+ tile_size : int
+ size of the tile to be extracted.
+ masks : np.ndarray
+ 3-D boolean numpy array with dimensions (ncells, tile_size,
+ tile_size.
+ labels : t.List[t.List[int]]
+ List of list of ints indicating the ids of masks.
+ **kwargs : Additional keyword arguments to be passed to extractor.reduce_extract.
+
+ Returns
+ -------
+ dict
+
+ Examples
+ --------
+ FIXME: Add docs.
+
- :param tp: int timepoint from which to extract results
- :param tree: dict of dict {channel : {reduction_function : metrics}}
- :**kwargs: Must include masks and preferably labels.
"""
if tree is None:
--
GitLab