fsleyes.displaycontext.freesurferopts

This module provides the FreesurferOpts class, which contains settings for displaying a FreesurferMesh overlay.

class fsleyes.displaycontext.freesurferopts.FreesurferOpts(overlay, *args, **kwargs)

Bases: fsleyes.displaycontext.meshopts.MeshOpts

The FreesurferOpts class, which contains settings for displaying a FreesurferMesh overlay.

Freesurfer surface vertices are defined in a coordinate system which differs from the world coordinate system of the source image. This class customises some behaviour of the MeshOpts class so that this difference is taken into account.

__init__(overlay, *args, **kwargs)

Create a FreesurferOpts instance.

All arguments are passed to the MeshOpts constructor.

getTransform(from_, to)

Overrides MeshOpts.getTransform(). If the MeshOpts.coordSpace property is 'torig', and one of from_ or to is 'mesh', the transform is adjusted to account for the difference between Freesurfer’s RAS and RAStkr spaces.

transformCoords(coords, from_, to, **kwargs)

Overrides MeshOpts.transformCoords(). If the MeshOpts.coordSpace property is 'torig', and one of from_ or to is 'mesh', the coordinate transform is adjusted to take into account the difference between Freesurfer’s RAS and RAStkr spaces.

__module__ = 'fsleyes.displaycontext.freesurferopts'