Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Improve PlaneSegmentation.add_roi doc #1308

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from
Open

ENH: Improve PlaneSegmentation.add_roi doc #1308

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b9b3549
Improve PlaneSegmentation.add_roi doc
rly Oct 17, 2020
d623905
Fix package dependency issues with importlib
rly Oct 17, 2020
470e917
Update ophys.py
rly Oct 18, 2020
04161b9
Update ophys.py
rly Oct 18, 2020
5f6ed1f
Merge branch 'dev' into planeseg_doc
rly Oct 18, 2020
bfa712e
Fix flake8
rly Oct 18, 2020
f105f12
Merge branch 'dev' into planeseg_doc
rly Nov 4, 2020
710972b
Merge branch 'dev' into planeseg_doc
rly Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ coverage==5.2
flake8==3.8.3
flake8-debugger==3.1.0
flake8-print==3.1.4
importlib-metadata<2
tox==3.17.1
10 changes: 7 additions & 3 deletions src/pynwb/ophys.py
View file
Open in desktop
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