Skip to content

Commit

Permalink
Improve PlaneSegmentation.add_roi doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rly committed Oct 17, 2020
1 parent e3dce5a commit b9b3549
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions src/pynwb/ophys.py
Original file line number Diff line number Diff line change
Expand Up @@ -238,13 +238,17 @@ def __init__(self, **kwargs):
self.reference_images = reference_images

@docval({'name': 'pixel_mask', 'type': 'array_data', 'default': None,
'doc': 'pixel mask for 2D ROIs: [(x1, y1, weight1), (x2, y2, weight2), ...]',
'doc': ('Pixel mask for 2D ROIs: [(x1, y1, weight1), (x2, y2, weight2), ...]. This should be used '
'for sparse masks, i.e., masks that have few pixels relative to the size of the image.'),
'shape': (None, 3)},
{'name': 'voxel_mask', 'type': 'array_data', 'default': None,
'doc': 'voxel mask for 3D ROIs: [(x1, y1, z1, weight1), (x2, y2, z2, weight2), ...]',
'doc': ('Voxel mask for 3D ROIs: [(x1, y1, z1, weight1), (x2, y2, z2, weight2), ...]. This should be used '
'for sparse masks, i.e., masks that have few voxels relative to the size of the volume.'),
'shape': (None, 4)},
{'name': 'image_mask', 'type': 'array_data', 'default': None,
'doc': 'image with the same size of image where positive values mark this ROI',
'doc': ('Image with the same size of image where positive values mark the ROI weights for each pixel of '
'the image. This should be used for dense masks, i.e., masks where most of the pixels have a '
'positive weight.'),
'shape': [[None]*2, [None]*3]},
{'name': 'id', 'type': int, 'doc': 'the ID for the ROI', 'default': None},
allow_extra=True)
Expand Down

0 comments on commit b9b3549

Please sign in to comment.