From 470e917866dbe5ec9215c2ff736c58c19f5b6a0e Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Sat, 17 Oct 2020 21:52:25 -0700 Subject: [PATCH] Update ophys.py --- src/pynwb/ophys.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/pynwb/ophys.py b/src/pynwb/ophys.py index b7b0e6945..8d32f3f06 100644 --- a/src/pynwb/ophys.py +++ b/src/pynwb/ophys.py @@ -247,8 +247,11 @@ def __init__(self, **kwargs): 'shape': (None, 4)}, {'name': 'image_mask', 'type': 'array_data', 'default': None, '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.'), + 'the image. This should be used when the NWB file will be compressed or when using ' + 'dense masks, i.e., masks where most of the pixels have a ' + 'positive weight. In a compressed file, an image mask will often take up less space ' + 'than a pixel mask, whereas in an uncomprsesed file, a pixel mask will often take up ' + 'less space than an image mask.'), 'shape': [[None]*2, [None]*3]}, {'name': 'id', 'type': int, 'doc': 'the ID for the ROI', 'default': None}, allow_extra=True)