Skip to content

Commit b9b3549

Browse files
committed
Improve PlaneSegmentation.add_roi doc
1 parent e3dce5a commit b9b3549

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/pynwb/ophys.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,13 +238,17 @@ def __init__(self, **kwargs):
238238
self.reference_images = reference_images
239239

240240
@docval({'name': 'pixel_mask', 'type': 'array_data', 'default': None,
241-
'doc': 'pixel mask for 2D ROIs: [(x1, y1, weight1), (x2, y2, weight2), ...]',
241+
'doc': ('Pixel mask for 2D ROIs: [(x1, y1, weight1), (x2, y2, weight2), ...]. This should be used '
242+
'for sparse masks, i.e., masks that have few pixels relative to the size of the image.'),
242243
'shape': (None, 3)},
243244
{'name': 'voxel_mask', 'type': 'array_data', 'default': None,
244-
'doc': 'voxel mask for 3D ROIs: [(x1, y1, z1, weight1), (x2, y2, z2, weight2), ...]',
245+
'doc': ('Voxel mask for 3D ROIs: [(x1, y1, z1, weight1), (x2, y2, z2, weight2), ...]. This should be used '
246+
'for sparse masks, i.e., masks that have few voxels relative to the size of the volume.'),
245247
'shape': (None, 4)},
246248
{'name': 'image_mask', 'type': 'array_data', 'default': None,
247-
'doc': 'image with the same size of image where positive values mark this ROI',
249+
'doc': ('Image with the same size of image where positive values mark the ROI weights for each pixel of '
250+
'the image. This should be used for dense masks, i.e., masks where most of the pixels have a '
251+
'positive weight.'),
248252
'shape': [[None]*2, [None]*3]},
249253
{'name': 'id', 'type': int, 'doc': 'the ID for the ROI', 'default': None},
250254
allow_extra=True)

0 commit comments

Comments
 (0)