Skip to content
Snippets Groups Projects
Commit 88abdcbb authored by pswain's avatar pswain
Browse files

docs(extractor): add docstring to extract_tp

parent 461ada6c
No related branches found
No related tags found
No related merge requests found
......@@ -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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment