fsleyes.displaycontext.mipopts

This module provides the MIPOpts class, a DisplayOpts class containing options for rendering maximum intensity projections of Image overlays. The MIPOpts class corresponds to the 'mip' overlay type.

MIP overlays are rendered via the GLMIP class.

class fsleyes.displaycontext.mipopts.MIPOpts(*args, **kwargs)[source]

Bases: fsleyes.displaycontext.colourmapopts.ColourMapOpts, fsleyes.displaycontext.niftiopts.NiftiOpts

The MIPOpts class is used for rendering maximum intensity projections of .Image overlays.

window = <MagicMock name='mock.Percentage()' id='4396604733712'>

Window over which the MIP is calculated, as a proportion of the image length. The window is centered at the current display location.

minimum = <MagicMock name='mock.Boolean()' id='4396609964304'>

Display a minimum intensity projection, rather than maximum.

absolute = <MagicMock name='mock.Boolean()' id='4396609964304'>

Display an absolute maximum intensity projection. This setting overrides the minimum setting.

interpolation = <MagicMock name='mock.Choice()' id='4396606838672'>

How the value shown at a real world location is derived from the corresponding data value(s). none is equivalent to nearest neighbour interpolation.

__init__(*args, **kwargs)[source]

Create a MIPOpts object.

All arguments are passed through to the NiftiOpts init function.

__module__ = 'fsleyes.displaycontext.mipopts'
destroy()[source]

Must be called when this MIPOpts object is no longer needed.

getDataRange()[source]

Overrides ColourMapOpts.getDataRange(). Returns the Image.dataRange of the image.

calculateRayCastSettings(viewmat)[source]

Calculates a camera direction and ray casting step vector, based on the given view matrix.