Icon bar widgets

class Sisyphe.widgets.iconBarViewWidgets.IconBarWidget(parent: QWidget | None = None)

IconBarWidget class

Description

Base class that encapsulates a primary view widget (typically a MultiViewWidget subclass) and enhances it with a collapsible, vertical icon bar.

The main features are as follows:

  • Encapsulated view widget access: the python __call__ syntax where he instance can be called like a function (e.g. instance_name()) returns the native encapsulated view widget. This is a fast and easy way to access all the methods of the encapsulated view widget.

  • Collapsible icon bar: a space-saving icon bar is displayed on the left. It automatically hides when the mouse is over the main view and reappears when the mouse pointer moves to the left edge. This behavior can be overridden by “pinning” the bar to keep it permanently visible.

  • Standardized Toolset: The icon bar provides quick access to a rich set of common functionalities, grouped into icons:

    • View control: fullscreen mode, expanding a single sub-view, and zoom controls (in, out, reset).

    • Display settings: menus for toggling the visibility of on-screen elements like the cursor, information text, orientation markers, color bars, and rulers.

    • Interactive tools: menus for managing mouse interaction modes, adding measurement tools (e.g. distance, angle), and configuring isolines.

    • Capture: buttons to save the current view(s) to a bitmap file or copy them directly to the system clipboard.

  • Context-sensitive menus: menus associated with icons are dynamically populated based on the state of the encapsulated view widget. For example, the “Isoline” menu lists all displayed volumes and overlays available for contouring.

  • Drag-and-Drop integration: fully supports dragging volumes from an external source (like a thumbnail bar) and dropping them onto the view. The drop behavior (e.g., replace the current volume, add as an overlay, or prompt the user) is configurable through application settings (settings.xml).

  • Customizable interface: offers an extensive API to control the visibility and availability of each button on the icon bar, allowing derived classes to tailor the user interface to their specific needs.

Inheritance

QWidget -> IconBarWidget

Creation: 17/04/2022 Last revision: 10/10/2025

addOverlay(volume: SisypheVolume) None

Add an overlay SisypheVolume.

Parameters

volumeSisypheVolume

SisypheVolume to add as an overlay.

alignCentersOff() None

Disable alignment of centers for the reference volume and overlays.

alignCentersOn() None

Enable alignment of centers for the reference volume and overlays.

dragEnterEvent(event: QDragEnterEvent | None) None

Handles drag enter events, accepting text-based mime data for drag-and-drop operations. This is used to load PySisyphe volume (.xvol) from the thumbnail bar.

Parameters

eventQDragEnterEvent

drag enter event.

dropEvent(event: QDropEvent | None) None

Handles drop events to load PySisyphe volume (.xvol) from the thumbnail bar based on user settings. The action (replace, overlay, etc.) depends on the ‘DropInView’ application setting (settings.xml).

Parameters

eventQDropEvent

drop event.

finalize() None

Method to be called before IconBarWidget instance destruction. It is used to avoid vtk error on windows platform (vtkWin32OpenGLRenderWindow error: ‘wglMakeCurrent failed in MakeCurrent()’).

getActionButtonAvailability() bool

Get the availability flag for the mouse actions button.

Returns

bool

True if the button is available, False otherwise.

getAlignCenters() bool

Get the current state of center alignment.

Returns

bool

True if center alignment is enabled, False otherwise.

getButtons() dict[str, RoundedButton]

Get the dictionary of icon bar buttons.

Returns

dict[str, RoundedButton]

dictionary mapping button names to their instances.

getCaptureButtonAvailability() bool

Get the availability flag for the capture button.

Returns

bool

True if the button is available, False otherwise.

getClipboardButtonAvailability() bool

Get the availability flag for the clipboard button.

Returns

bool

True if the button is available, False otherwise.

getColorbarButtonAvailability() bool

Get the availability flag for the color bar button.

Returns

bool

True if the button is available, False otherwise.

getExpandButtonAvailability() bool

Get the availability flag for the expand button.

Returns

bool

True if the button is available, False otherwise.

getFullscreenButtonAvailability() bool

Get the availability flag for the fullscreen button.

Returns

bool

True if the button is available, False otherwise.

getGridButtonAvailability() bool

Get the availability flag for the grid layout button.

Returns

bool

True if the button is available, False otherwise.

getIconBarVisibility() bool

Get the current visibility of the icon bar.

Returns

bool

True if the icon bar is visible, False otherwise.

getIconSize() int

Get the current size of the icons in the icon bar.

Returns

int

current icon size in pixels.

getInfoButtonAvailability() bool

Get the availability flag for the information button.

Returns

bool

True if the button is available, False otherwise.

getIsoButtonAvailability() bool

Getsthe availability flag for the isovalue button.

Returns

bool

True if the button is available, False otherwise.

getName() str

Get the name of the widget.

Returns

str

widget name.

getOrientButtonAvailability() bool

Get the availability flag for the orientation button.

Returns

bool

True if the button is available, False otherwise.

getOverlayCount() int

Get the number of overlay volumes.

Returns

int

number of overlays.

getOverlayFromIndex(index: int) SisypheVolume

Get an overlay volume by its index.

Parameters

indexint

index of the overlay to retrieve.

Returns

SisypheVolume

overlay volume at the specified index.

getOverlayIndex(o: SisypheVolume) int

Get the index of a specific overlay volume.

Parameters

oSisypheVolume

overlay volume instance to find.

Returns

int

index of the overlay.

getPinButtonAvailability() bool

Get the availability flag for the pin button.

Returns

bool

True if the button is available, False otherwise.

getRulerButtonAvailability() bool

Get the availability flag for the ruler button.

Returns

bool

True if the button is available, False otherwise.

getShowButtonAvailability() bool

Get the availability flag for the show/hide options button.

Returns

bool

True if the button is available, False otherwise.

getSliceButtonsAvailability() bool

Get the availability flag for the slice navigation buttons.

Returns

bool

True if the buttons are available, False otherwise.

getThumbnail() ToolBarThumbnail

Get the associated thumbnail bar widget.

Returns

ToolBarThumbnail

associated thumbnail bar widget instance.

getToolButtonAvailability() bool

Get the availability flag for the measurement tools button.

Returns

bool

True if the button is available, False otherwise.

getTransferButtonAvailability() bool

Get the availability flag for the transfer function button.

Returns

bool

True if the button is available, False otherwise.

getViewWidget() MultiViewWidget

Get the encapsulated view widget.

Returns

MultiViewWidget

encapsulated view widget.

getViewWidgetVisibility() bool

Get the visibility of the encapsulated view widget.

Returns

bool

True if the widget is visible, False otherwise.

getVolume() SisypheVolume

Get the displayed SisypheVolume.

Returns

SisypheVolume

reference SisypheVolume.

getZoomButtonsAvailability() bool

Get the availability flag for the zoom control buttons.

Returns

bool

True if the buttons are available, False otherwise.

hasOverlay() bool

Checksif there are any overlay volumes.

Returns

bool

True if at least one overlay exists, False otherwise.

hasThumbnail() bool

Check if a thumbnail bar widget is associated.

Returns

bool

True if a thumbnail bar is associated, False otherwise.

hasVolume() bool

Check if a reference SisypheVolume is displayed.

Returns

bool

True if a volume is displayed, False otherwise.

iconBarVisibleOff() None

Hide the icon bar.

iconBarVisibleOn() None

Show the icon bar.

removeAllOverlays() None

Remove all overlay volumes.

removeOverlay(o: int | SisypheVolume) None

Remove an overlay volume by index or instance.

Parameters

oint | SisypheVolume

index or instance of the overlay to remove.

removeVolume() None

Remove the reference SisypheVolume.

replaceVolume(vol: SisypheVolume) None

Replace the currently displayed SisypheVolume with a new one. The new volume must have the same dimensions as the old one.

Parameters

volSisypheVolume

new volume to display.

setActionButtonAvailability(v: bool) None

Set the availability (and visibility) of the mouse actions button.

Parameters

vbool

True to make the button available, False to hide it.

setAlignCenters(v: bool) None

Set whether to align the centers of the reference volume and overlays.

Parameters

vbool

True to align centers, False otherwise.

setCaptureButtonAvailability(v: bool) None

Set the availability (and visibility) of the capture button.

Parameters

vbool

True to make the button available, False to hide it.

setClipboardButtonAvailability(v: bool) None

Set the availability (and visibility) of the clipboard button.

Parameters

vbool

True to make the button available, False to hide it.

setColorbarButtonAvailability(v: bool) None

Set the availability (and visibility) of the color bar button.

Parameters

vbool

True to make the button available, False to hide it.

setExpandButtonAvailability(v: bool) None

Set the availability (and visibility) of the expand button.

Parameters

vbool

True to make the button available, False to hide it.

setFullscreenButtonAvailability(v: bool) None

Set the availability (and visibility) of the fullscreen button.

Parameters

vbool

True to make the button available, False to hide it.

setGridButtonAvailability(v: bool) None

Set the availability (and visibility) of the grid layout button.

Parameters

vbool

True to make the button available, False to hide it.

setIconBarVisibility(v: bool) None

Set the visibility of the icon bar, respecting the pinned state.

Parameters

vbool

True to show the icon bar, False to hide it.

setIconSize(size: int | None) None

Set the size, in pixels, of the icons in the icon bar.

Parameters

size : int | None

  • new size for the icons. Clamped between 0 and 64.

  • if None, set the size to its default value (40).

setInfoButtonAvailability(v: bool) None

Set the availability (and visibility) of the information button.

Parameters

vbool

True to make the button available, False to hide it.

setIsoButtonAvailability(v: bool) None

Set the availability (and visibility) of the isovalue button.

Parameters

vbool

True to make the button available, False to hide it.

setName(name: str) None

Set the name of the widget and emits a signal.

Parameters

namestr

new widget name.

setOrientButtonAvailability(v: bool) None

Set the availability (and visibility) of the orientation button.

Parameters

vbool

True to make the button available, False to hide it.

setPinButtonAvailability(v: bool) None

Set the availability (and visibility) of the pin button.

Parameters

vbool

True to make the button available, False to hide it.

setRulerButtonAvailability(v: bool) None

Set the availability (and visibility) of the ruler button.

Parameters

vbool

True to make the button available, False to hide it.

setShowButtonAvailability(v: bool) None

Set the availability (and visibility) of the show/hide options button.

Parameters

vbool

True to make the button available, False to hide it.

setSliceButtonsAvailability(v: bool) None

Set the availability (and visibility) of the slice navigation buttons.

Parameters

vbool

True to make the buttons available, False to hide them.

setThumbnail(thumbnail: ToolBarThumbnail) None

Set the associated thumbnail bar widget.

Parameters

thumbnailToolBarThumbnail

The thumbnail bar widget to associate with this icon bar.

setToolButtonAvailability(v: bool) None

Set the availability (and visibility) of the measurement tools button.

Parameters

vbool

True to make the button available, False to hide it.

setTransferButtonAvailability(v: bool) None

Set the availability (and visibility) of the transfer function button.

Parameters

vbool

True to make the button available, False to hide it.

setViewWidget(widget: MultiViewWidget) None

Set and configure the view widget encapsulated by the IconBarWidget. This method connects the icon bar buttons to the corresponding actions of the view widget.

Parameters

widgetMultiViewWidget

view widget to be encapsulated.

setViewWidgetVisibility(v: bool) None

Set the visibility of the encapsulated view widget.

Parameters

vbool

True to show the widget, False to hide it.

setVolume(vol: SisypheVolume) None

Set the SisypheVolume to be displayed.

Parameters

volSisypheVolume

volume to display.

setZoomButtonsAvailability(v: bool) None

Set the availability (and visibility) of the zoom control buttons.

Parameters

vbool

True to make the buttons available, False to hide them.

timerDisabled() None

Disable the icon bar visibility timer. This timer is used to manage icon bar visibility based on mouse position.

timerEnabled() None

Enables a timer to manage icon bar visibility based on mouse position. The timer is only started if a SisypheVolume is displayed.

timerEvent(event: QTimerEvent | None) None

Handles timer events to manage the auto-hiding of the unpinned icon bar. Currently, this method overrides the superclass’s implementation.

Parameters

eventQTimerEvent

timer event.

updateRender() None

Trigger a render update in the encpasulated view widget.

viewWidgetVisibleOff() None

Make the encapsulated view widget invisible.

viewWidgetVisibleOn() None

Make the encapsulated view widget visible.

class Sisyphe.widgets.iconBarViewWidgets.IconBarOrthogonalSliceViewWidget(widget: OrthogonalSliceViewWidget | None = None, parent: QWidget | None = None)

IconBarOrthogonalSliceViewWidget class

Description

This widget encapsulates an OrthogonalSliceViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarOrthogonalSliceViewWidget

Creation: 17/04/2022 Last revision: 10/10/2025

class Sisyphe.widgets.iconBarViewWidgets.IconBarOrthogonalRegistrationViewWidget(widget: OrthogonalRegistrationViewWidget | None = None, parent: QWidget | None = None)

IconBarOrthogonalRegistrationViewWidget class

Description

This widget encapsulates an OrthogonalRegistrationViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarOrthogonalRegistrationViewWidget

Creation: 17/04/2022 Last revision: 10/10/2025

cropOff() None

Disable cropping of the registration area.

cropOn() None

Enable cropping of the registration area.

displayEdge() None

Display the edges of the moving volume for registration visualization.

displayEdgeAndNative() None

Display both the edges and the native moving volume.

displayNative() None

Display the native (unprocessed) moving volume.

getCrop() bool

Get the current crop state of the registration area.

Returns

bool

True if cropping is enabled, False otherwise.

getRegistrationBoxMatrixArea() list[float] | tuple[float, float, float, float, float, float]

Get the bounds of the coregistration box as a matrix area. Voxels located outside the registration box are not used to calculate the coregistration.

Returns

list[float] | tuple[float, float, float, float, float, float]

bounds of the registration box.

getRegistrationBoxVisibility() bool

Get the visibility of the coregistration box. Voxels located outside the registration box are not used to calculate the coregistration.

Returns

bool

True if the box is visible, False otherwise.

registrationBoxOff() None

Hide the registration box. Voxels located outside the coregistration box are not used to calculate the coregistration.

registrationBoxOn() None

Show the registration box. Voxels located outside the coregistration box are not used to calculate the coregistration.

setCrop(crop: bool) None

Set whether to crop the registration area.

Parameters

cropbool

True to enable cropping, False to disable it.

setRegistrationBoxVisibility(v: bool) None

Set the visibility of the coregistration box. Voxels located outside the registration box are not used to calculate the coregistration.

Parameters

vbool

True to show the box, False to hide it.

class Sisyphe.widgets.iconBarViewWidgets.IconBarOrthogonalRegistrationViewWidget2(widget: OrthogonalRegistrationViewWidget | None = None, parent: QWidget | None = None)

IconBarOrthogonalRegistrationViewWidget2 class

Description

This widget encapsulates an OrthogonalRegistrationViewWidget and extends it by providing a collapsible icon bar that is displayed on the left, with rigid transformation buttons at the bottom.

Inheritance

QWidget -> IconBarWidget -> IconBarOrthogonalRegistrationViewWidget -> IconBarOrthogonalRegistrationViewWidget2

Creation: 17/04/2022 Last revision: 10/10/2025

addOverlay(volume: SisypheVolume) None

Add an overlay and update the transformation tooltips. Currently, this method calls the superclass’s implementation.

Parameters

volumeSisypheVolume

SisypheVolume to add as an overlay.

getMoveButtonsVisibility() bool

Get the visibility of the rigid transformation buttons.

Returns

bool

True if the buttons are visible, False otherwise.

getMoveStep() float

Get the current step value for translations (in mm) and rotations (in degrees).

Returns

float

The current step value.

setMoveButtonsVisibility(v: bool) None

Set the visibility of all rigid transformation buttons.

Parameters

vbool

True to show the buttons, False to hide them.

setMoveOverlayOff() None

Disable the ‘Move overlay’ interaction mode. In this mode, overlay volume can be moved or rotated with mouse.

setMoveOverlayOn() None

Enable the ‘Move overlay’ interaction mode. In this mode, overlay volume can be moved or rotated with mouse.

setMoveStep(v: float) None

Set the step value for translations (in mm) and rotations (in degrees).

Parameters

vfloat

The new step value.

class Sisyphe.widgets.iconBarViewWidgets.IconBarOrthogonalReorientViewWidget(widget: OrthogonalReorientViewWidget | None = None, parent: QWidget | None = None)

IconBarOrthogonalReorientViewWidget class

Description

This widget encapsulates an OrthogonalReorientViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarOrthogonalReorientViewWidget

Creation: 17/04/2022 Last revision: 10/10/2025

class Sisyphe.widgets.iconBarViewWidgets.IconBarOrthogonalSliceVolumeViewWidget(widget: OrthogonalSliceVolumeViewWidget | None = None, parent: QWidget | None = None)

IconBarOrthogonalSliceVolumeViewWidget class

Description

This widget encapsulates an OrthogonalSliceVolumeViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarOrthogonalSliceVolumeViewWidget

Creation: 17/04/2022 Last revision: 10/10/2025

getCameraPositionButtonAvailability() bool

Get the availability of the camera position button.

Returns

bool

True if the button is available, False otherwise.

getTextureSettingsButtonAvailability() bool

Get the availability of the 3D texture settings button.

Returns

bool

True if the button is available, False otherwise.

setCameraPositionButtonAvailability(v: bool) None

Set the availability of the camera position button.

Parameters

vbool

True to make the button available, False to hide it.

setTextureSettingsButtonAvailability(v: bool) None

Set the availability of the 3D texture settings button.

Parameters

vbool

True to make the button available, False to hide it.

setVolume(vol: SisypheVolume) None

Set the SisypheVolume to be displayed. and connect the transfer function widget to the 3D VolumeViewWidget. Currently, this method calls the superclass’s implementation.

Parameters

volSisypheVolume

SisypheVolume to display.

class Sisyphe.widgets.iconBarViewWidgets.IconBarOrthogonalSliceTrajectoryViewWidget(widget: OrthogonalTrajectoryViewWidget | None = None, parent: QWidget | None = None)

IconBarOrthogonalSliceTrajectoryViewWidget class

Description

This widget encapsulates an OrthogonalTrajectoryViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarOrthogonalSliceTrajectoryViewWidget

Creation: 17/04/2022 Last Revision: 10/10/2025

getSlabThicknessButtonAvailability() bool

Get the availability of the slab thickness management button.

Returns

bool

True if the button is available, False otherwise.

setSlabThicknessButtonAvailability(v: bool) None

Set the availability of the slab thickness management button.

Parameters

vbool

True to make the button available, False to hide it.

setVolume(vol: SisypheVolume) None

Set the SisypheVolume to display, connect the transfer function widget, and reset slab properties. Currently, this method calls the superclass’s implementation.

Parameters

volSisypheVolume

SisypheVolume to display.

class Sisyphe.widgets.iconBarViewWidgets.IconBarMultiSliceGridViewWidget(widget: MultiSliceGridViewWidget | None = None, rois: SisypheROICollection | None = None, draw: SisypheROIDraw | None = None, parent: QWidget | None = None)

IconBarMultiSliceGridViewWidget class

Description

This widget encapsulates a MultiSliceGridViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarMultiSliceGridViewWidget

Creation: 17/04/2022 Last revision: 10/10/2025

setVolume(vol: SisypheVolume) None

Set the SisypheVolume to display, adjust the orientation for thick anisotropic volumes to its native orientation. Currently, this method calls the superclass’s implementation.

Parameters

volSisypheVolume

SisypheVolume to display.

class Sisyphe.widgets.iconBarViewWidgets.IconBarSynchronisedGridViewWidget(widget: SynchronisedGridViewWidget | None = None, rois: SisypheROICollection | None = None, draw: SisypheROIDraw | None = None, parent=None)

IconBarSynchronisedGridViewWidget class

Description

This widget encapsulates a SynchronisedGridViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarSynchronisedGridViewWidget

Creation: 17/04/2022 Last revision: 10/10/2025

setVolume(vol: SisypheVolume) None

Set the SisypheVolume to display, adjust the orientation for thick anisotropic volumes to its native orientation. Currently, this method calls the superclass’s implementation.

Parameters

volSisypheVolume

volume to display.

class Sisyphe.widgets.projectionViewWidget.IconBarMultiProjectionViewWidget(widget: MultiProjectionViewWidget | None = None, parent: QWidget | None = None)

IconBarMultiProjectionViewWidget class

Description

This widget encapsulates a MultiProjectionViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarMultiProjectionViewWidget

Creation: 13/10/2024 Last revision: 10/10/2025

addOverlay(volume: SisypheVolume) None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

getOverlayCount() int

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

getOverlayFromIndex(index: int) SisypheVolume

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

getOverlayIndex(o: SisypheVolume) int | None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

hasOverlay() bool

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

removeAllOverlays() None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

removeOverlay(o: int | SisypheVolume) None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

removeVolume() None

Remove the SisypheVolume instance and disable the timer. Currently, this method calls the superclass’s implementation.

setVolume(foreground: SisypheVolume, background: SisypheVolume | None = None, mask: SisypheVolume | None = None) None

Set the SisypheVolume instances for projection display and updates the GUI. Currently, this method overrides the superclass’s implementation.

Parameters

foregroundSisypheVolume

SisypheVolume instance to be projected and displayed.

backgroundSisypheVolume | None (optional)

SisypheVolume instance to be projected and used as a background (default None).

maskSisypheVolume | None, optional

mask to apply before projection processing (default to None).

class Sisyphe.widgets.multiComponentViewWidget.IconBarMultiComponentViewWidget(widget: MultiComponentViewWidget | None = None, parent: QWidget | None = None)

Description

This widget encapsulates a MultiComponentViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarMultiComponentViewWidget

Creation: 10/12/2024 Last revision: 10/10/2025

addOverlay(volume: SisypheVolume) None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

getFirstDisplayedComponent() int

Get the index of the first component currently displayed in the grid view.

Returns

int

index of the first component.

getOverlayCount() int

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

getOverlayFromIndex(index: int) None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

getOverlayIndex(o: SisypheVolume) int | None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

hasOverlay() bool

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

nextComponent() None

Navigate to the next component in the sequence, updating the grid view. Wraps around to the beginning if at the end.

previousComponent() None

Navigate to the previous component in the sequence, updating the grid view. Wraps around to the end if at the beginning.

removeAllOverlays() None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

removeOverlay(o: int | SisypheVolume) None

Dummy method, overlays are not available in this widget. Currently, this method overrides the superclass’s implementation.

removeVolume() None

Remove the SisypheVolume from the managed view widget.

setFirstDisplayedComponent(first: int) None

Set the first component to be displayed in the grid view.

Parameters

firstint

Index of the first component.

setViewWidget(widget: MultiComponentViewWidget)

Set the main MultiComponentViewWidget instance and connects its actions to the icon bar buttons. Currently, this method overrides the superclass’s implementation.

Parameters

widgetMultiComponentViewWidget

view widget to be controlled by this icon bar.

setVolume(multi: SisypheVolume) None

Set the multi-component SisypeVolume for the managed view widget.

Parameters

multiSisypheVolume

multi-component SisypheVolume to display.

class Sisyphe.widgets.iconBarViewWidgets.IconBarSliceViewWidget(widget: SliceROIViewWidget | None = None, rois: SisypheROICollection | None = None, draw: SisypheROIDraw | None = None, parent=None)

IconBarSliceViewWidget class

Description

This widget encapsulates a SliceROIViewWidget and extends it by providing a collapsible icon bar that is displayed on the left.

Inheritance

QWidget -> IconBarWidget -> IconBarSliceViewWidget

Creation: 17/04/2022 Last revision: 10/10/2025

removeVolume() None

Remove the displayed SisypheVolume and disable the visibility timer. Currently, this method calls the superclass’s implementation.

setVolume(vol: SisypheVolume) None

Set the SisypheVolume to display, enable the visibility timer for the icon bar. Currently, this method calls the superclass’s implementation.

Parameters

volSisypheVolume

volume to display.

timerEvent(event: QTimerEvent | None) None

Handles timer events to manage the auto-hiding of the unpinned icon bar. Currently, this method overrides the superclass’s implementation.

Parameters

eventQTimerEvent

timer event.