fsleyes.displaycontext.maskopts
¶
This module provides the MaskOpts
class, which defines settings
for displaying an Image
overlay as a binary mask.
-
class
fsleyes.displaycontext.maskopts.
MaskOpts
(overlay, *args, **kwargs)[source]¶ Bases:
fsleyes.displaycontext.niftiopts.NiftiOpts
The
MaskOpts
class defines settings for displaying anImage
overlay as a binary mask.-
threshold
= <MagicMock name='mock.Bounds()' id='140225916891392'>¶ The mask threshold range - values outside of this range are not displayed.
-
invert
= <MagicMock name='mock.Boolean()' id='140225918039088'>¶ If
True
, thethreshold
range is inverted - values inside the range are not shown, and values outside of the range are shown.
-
colour
= <MagicMock name='mock.Colour()' id='140225918680896'>¶ The mask colour.
-
outline
= <MagicMock name='mock.Boolean()' id='140225918039088'>¶ If
True
only the outline of the mask will be shown. IfFalse
, the filled mask will be displayed.
-
outlineWidth
= <MagicMock name='mock.Int()' id='140225916854528'>¶ Width of mask outline, if :attr:
outline` is ``True
. This value is in terms of pixels.
-
interpolation
= <MagicMock name='mock.Choice()' id='140225911459120'>¶
-
__init__
(overlay, *args, **kwargs)[source]¶ Create a
MaskOpts
instance for the given overlay. All arguments are passed through to theNiftiOpts
constructor.
-
_MaskOpts__alphaChanged
(*a)¶ Called when
Display.alpha
changes. Updates the alpha component ofcolour
.
-
_MaskOpts__colourChanged
(*a)¶ Called when
colour
changes. UpdatesDisplay.alpha
from the alpha component.
-
__module__
= 'fsleyes.displaycontext.maskopts'¶
-