Skip to content

Commit 470e917

Browse files
authored
Update ophys.py
1 parent d623905 commit 470e917

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/pynwb/ophys.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,11 @@ def __init__(self, **kwargs):
247247
'shape': (None, 4)},
248248
{'name': 'image_mask', 'type': 'array_data', 'default': None,
249249
'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.'),
250+
'the image. This should be used when the NWB file will be compressed or when using '
251+
'dense masks, i.e., masks where most of the pixels have a '
252+
'positive weight. In a compressed file, an image mask will often take up less space '
253+
'than a pixel mask, whereas in an uncomprsesed file, a pixel mask will often take up '
254+
'less space than an image mask.'),
252255
'shape': [[None]*2, [None]*3]},
253256
{'name': 'id', 'type': int, 'doc': 'the ID for the ROI', 'default': None},
254257
allow_extra=True)

0 commit comments

Comments
 (0)