Skip to content
Snippets Groups Projects
Commit b589e3bd authored by Christopher Randolph Rhodes's avatar Christopher Randolph Rhodes
Browse files

docstrings only

parent 6b416419
No related branches found
No related tags found
No related merge requests found
......@@ -296,7 +296,7 @@ class RoiSet(object):
"""
A set of regions of interest, referenced by their positions and contours in the YXCZ space of stack acc_raw.
RoiSet contains their internal state, which may be exported as patches, maps, and other products by export methods.
:param acc_raw: accessor to a generally a multichannel z-stack
:param acc_raw: accessor to a generally multichannel z-stack
:param df: dataframe containing at minimum bounding box and segmentation mask information
:param params: optional arguments that influence the definition and representation of ROIs
"""
......@@ -318,12 +318,12 @@ class RoiSet(object):
params: RoiSetMetaParams = RoiSetMetaParams(),
):
"""
:param acc_raw:
Create an RoiSet from an object identities map
:param acc_raw: accessor to a generally a multichannel z-stack
:param acc_obj_ids: accessor to a 2D single-channel object identities map, where each pixel's intensity
labels its membership in a connected object
:param params:
:return:
:param params: optional arguments that influence the definition and representation of ROIs
:return: RoiSet object
"""
assert acc_obj_ids.chroma == 1
......@@ -344,6 +344,13 @@ class RoiSet(object):
yxhw_list: List,
params: RoiSetMetaParams = RoiSetMetaParams()
):
"""
Create and RoiSet from bounding boxes
:param acc_raw:
:param yxhw_list: list of bounding boxing coordinates [corner X, corner Y, height, width]
:param params: optional arguments that influence the definition and representation of ROIs
:return: RoiSet object
"""
df = pd.DataFrame([
{
'y0': yxhw[0],
......
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