Rewrite docstrings in SelectionBox
This commit is contained in:
parent
a7b0b64578
commit
d897aaaaae
@ -99,16 +99,34 @@ class SelectionBox(object):
|
|||||||
return InvertedBox(self)
|
return InvertedBox(self)
|
||||||
|
|
||||||
def section_mask(self, cx, cy, cz):
|
def section_mask(self, cx, cy, cz):
|
||||||
|
"""
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
cx : int
|
||||||
|
cy : int
|
||||||
|
cz : int
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
mask : ndarray | None
|
||||||
|
|
||||||
|
"""
|
||||||
return self.box_mask(SectionBox(cx, cy, cz))
|
return self.box_mask(SectionBox(cx, cy, cz))
|
||||||
|
|
||||||
def box_mask(self, box):
|
def box_mask(self, box):
|
||||||
"""
|
"""
|
||||||
Return a boolean mask array for the given bounding box. Array indices are ordered YZX.
|
Return a boolean mask array for the given bounding box.
|
||||||
|
|
||||||
:param box:
|
Array indices are ordered YZX.
|
||||||
:type box:
|
|
||||||
:return:
|
Parameters
|
||||||
:rtype: ndarray | None
|
----------
|
||||||
|
box : BoundingBox
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
mask : ndarray | None
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user