From d897aaaaae1a9052b7be7108ad66b9e1802524bd Mon Sep 17 00:00:00 2001 From: David Vierra Date: Sun, 31 Jan 2016 20:14:11 -1000 Subject: [PATCH] Rewrite docstrings in SelectionBox --- src/mceditlib/selection/__init__.py | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/src/mceditlib/selection/__init__.py b/src/mceditlib/selection/__init__.py index 69d986e..1ada1da 100644 --- a/src/mceditlib/selection/__init__.py +++ b/src/mceditlib/selection/__init__.py @@ -99,16 +99,34 @@ class SelectionBox(object): return InvertedBox(self) 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)) 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: - :type box: - :return: - :rtype: ndarray | None + Array indices are ordered YZX. + + Parameters + ---------- + box : BoundingBox + + Returns + ------- + mask : ndarray | None """ raise NotImplementedError