fsleyes.editorΒΆ

The editor package contains functionality for editing Image overlays.

_images/editor.png

The editor package provides the following two classes:

Selection The Selection class represents a selection of voxels in a 3D Image.
Editor The Editor class provides functionality to edit the data of an Image overlay.

Making an edit to an Image requires two stages:

  1. Select some voxels in the Image.
  2. Modify the values stored in those voxels.

The Selection class implements the functionality for the first stage, and the Editor class implements functinoality for the second. The Editor class also keeps track of changes to the current selection, and to the image data, thus allowing the user to undo/redo any changes.