Enums

class ipyniivue.ColormapType(*values)

Bases: Enum

An enumeration of colormap types.

Members

MIN_TO_MAXint

Colormap spans from minimum to maximum values (value 0).

ZERO_TO_MAX_TRANSPARENT_BELOW_MINint

Colormap spans from zero to maximum, transparent below minimum (value 1).

ZERO_TO_MAX_TRANSLUCENT_BELOW_MINint

Colormap spans from zero to maximum, translucent below minimum (value 2).

MIN_TO_MAX = 0

ZERO_TO_MAX_TRANSLUCENT_BELOW_MIN = 2

ZERO_TO_MAX_TRANSPARENT_BELOW_MIN = 1

class ipyniivue.DragMode(*values)

Bases: Enum

An enumeration of drag modes for NiiVue instances.

Members

NONEint

No drag mode active (value 0).

CONTRASTint

Contrast adjustment mode (value 1).

MEASUREMENTint

Measurement mode for taking measurements (value 2).

PANint

Pan mode for moving around the image (value 3).

SLICER_3Dint

3D slicer interaction mode (value 4).

CALLBACK_ONLYint

Callback only mode (value 5).

ROI_SELECTIONint

ROI (Region of Interest) selection mode (value 6).

CALLBACK_ONLY = 5

CONTRAST = 1

MEASUREMENT = 2

NONE = 0

PAN = 3

ROI_SELECTION = 6

SLICER_3D = 4

class ipyniivue.DragModePrimary(*values)

Bases: Enum

An enumeration of primary drag modes for NiiVue instances.

Members

CROSSHAIRint

Crosshair mode (value 0).

WINDOWINGint

Windowing mode (value 1).

CROSSHAIR = 0

WINDOWING = 1

class ipyniivue.MultiplanarType(*values)

Bases: Enum

An enumeration of multiplanar types for NiiVue instances.

Members

AUTOint

Automatic multiplanar layout (value 0).

COLUMNint

Vertical column multiplanar layout (value 1).

GRIDint

Grid multiplanar layout (value 2).

ROWint

Horizontal row multiplanar layout (value 3).

AUTO = 0

COLUMN = 1

GRID = 2

ROW = 3

class ipyniivue.ShowRender(*values)

Bases: Enum

An enumeration for specifying when to show rendering in NiiVue instances.

Members

NEVERint

Never show rendering (value 0).

ALWAYSint

Always show rendering (value 1).

AUTOint

Automatically determine whether to show rendering (value 2).

ALWAYS = 1

AUTO = 2

NEVER = 0

class ipyniivue.SliceType(*values)

Bases: Enum

An enumeration of slice types for NiiVue instances.

Members

AXIALint

Axial slice type (value 0).

CORONALint

Coronal slice type (value 1).

SAGITTALint

Sagittal slice type (value 2).

MULTIPLANARint

Multiplanar view type (value 3).

RENDERint

Render view type (value 4).

AXIAL = 0

CORONAL = 1

MULTIPLANAR = 3

RENDER = 4

SAGITTAL = 2