Purpose

The module View2DExtensions encapsulates a set of viewer extensions that are commonly used in conjunction with a 2D viewer.

This includes extensions for navigation (browsing through slices, zoom and pan), level/window adjustment and drawing annotations. The various settings of each of these modules can be accessed through the View2DExtensions panel, and the most important of them are duplicated as module parameter fields. There are some additional parameter, e.g., to enable/disable each of the internal extension modules separately.

Details

The module supports the following functions:

Mouse Function
Middle Mouse, Wheel Browse through the slices.
CTRL-Middle Mouse Zoom in/out.
SHIFT-Middle Mouse Move visible rectangle (pan).
CTRL-SHIFT-Middle Mouse Zoom to current mouse position (Auto Center).

Windows

Default Panel

../../../Modules/Macros/Viewers/mhelp/Images/Screenshots/View2DExtensions._default.png

Input Fields

inLUT

name: inLUT, type: Image, deprecated name: lutInput

Output Fields

outNode

name: outNode, type: SoNode, deprecated name: self

Parameter Fields

Field Index

annoInput03: String annotUserBottomLeft: String lutMouseOn: Bool
annoInput04: String annotUserBottomRight: String lutMouseShift: Enum
annoInput05: String annotUserTopLeft: String lutOn: Bool
annoInput06: String annotUserTopRight: String lutRangeMax: Double
annoInput07: String annotVerticalRuler: Bool lutRangeMin: Double
annoInput08: String autoCenterMouseAlt: Enum lutSetDefault: Trigger
annoInput09: String autoCenterMouseButton1: Enum lutSetDefaultOnce: Bool
annoNumInput00: Double autoCenterMouseButton2: Enum maxPrecision: Integer
annoNumInput01: Double autoCenterMouseButton3: Enum mouseGrabberMode: Bool
annoNumInput02: Double autoCenterMouseCtrl: Enum panMouseAlt: Enum
annoNumInput03: Double autoCenterMouseShift: Enum panMouseButton1: Enum
annoNumInput04: Double borderColor: Color panMouseButton2: Enum
annoNumInput05: Double borderEvaluateFocus: Bool panMouseButton3: Enum
annoNumInput06: Double borderFocusColor: Color panMouseCtrl: Enum
annoNumInput07: Double borderFocusWidth: Float panMouseShift: Enum
annoReadPixFloorPos: Vector3 borderWidth: Float position: Vector3
annoReadPixVoxelPos: Vector3 colorChannelSeparator: String positionColor: Color
annoReadPixWorldPos: Vector3 Coordinate System: Enum positionDrawingOn: Bool
annotationCol: Color CT Values: Enum positionMode: Enum
annotationMode: Enum Display value with high precision: Bool positionMouseAlt: Enum
annotCTBottomCenter: String Enable (slicerOn): Bool positionMouseButton1: Enum
annotCTBottomLeft: String Enable (zoomOn): Bool positionMouseButton2: Enum
annotCTBottomRight: String Enable (panOn): Bool positionMouseButton3: Enum
annotCTTopLeft: String Enable (autoCenterOn): Bool positionMouseCtrl: Enum
annotCTTopRight: String Enable (annotationOn): Bool positionMouseShift: Enum
annotFontSize: Enum Enable (annoMouseOn): Bool showColorChannelValues: Bool
annotHorizontalRuler: Bool Enable (borderOn): Bool slicerMouseAlt: Enum
annotMRBottomCenter: String lutAlphaCenter: Double slicerMouseButton1: Enum
annotMRBottomLeft: String lutAlphaFactor: Double slicerMouseButton2: Enum
annotMRBottomRight: String lutAlphaSync: Bool slicerMouseButton3: Enum
annotMRTopLeft: String lutAlphaWidth: Double slicerMouseCtrl: Enum
annotMRTopRight: String lutColorFactor: Color slicerMouseShift: Enum
annotShortBottomCenter: String lutGrayCenter: Double Use Managed Interaction: Bool
annotShortBottomLeft: String lutGrayWidth: Double useRelativeLUTIfNoInputImage: Bool
annotShortBottomRight: String lutIsRelative: Bool zoomMouseAlt: Enum
annotShortTopLeft: String lutMouseAlt: Enum zoomMouseButton1: Enum
annotShortTopRight: String lutMouseButton1: Enum zoomMouseButton2: Enum
annotShowAnnot: Enum lutMouseButton2: Enum zoomMouseButton3: Enum
annotShowOrientation: Enum lutMouseButton3: Enum zoomMouseCtrl: Enum
annotUserBottomCenter: String lutMouseCtrl: Enum zoomMouseShift: Enum

Visible Fields

Enable (slicerOn)

name: slicerOn, type: Bool, default: TRUE

If checked, the interactive slicing is enabled.

Enable (zoomOn)

name: zoomOn, type: Bool, default: TRUE

If checked, the interactive zooming is enabled.

Enable (panOn)

name: panOn, type: Bool, default: TRUE

If checked, the interactive panning is enabled.

Enable (autoCenterOn)

name: autoCenterOn, type: Bool, default: TRUE

If checked, the interactive setting of a center is enabled.

Coordinate System

name: annoCoords, type: Enum, default: Voxel

Defines the coordinate system in which the current mouse position is displayed in.

Values:

Title Name
Voxel Voxel
World World

CT Values

name: annoCTValue, type: Enum, default: ToHounsfield

Defines the unit of the voxel values under the mouse cursor.

Values:

Title Name Deprecated Name
As Is AsIs As Is
To Hounsfield ToHounsfield To Hounsfield

Display value with high precision

name: valueHighPrecision, type: Bool, default: TRUE

If checked, voxel values under the mouse cursor are being displayed with a high precision. This includes the display of all components of non-scalar values and, if enabled, the display of all color channel values.

Enable (annotationOn)

name: annotationOn, type: Bool, default: TRUE

If checked, the rendering of annotations is enabled.

Enable (annoMouseOn)

name: annoMouseOn, type: Bool, default: TRUE

If checked, the annotations show the voxel value under the mouse cursor.

Enable (borderOn)

name: borderOn, type: Bool, default: FALSE

If checked, a border is rendered around the viewer.

Use Managed Interaction

name: useManagedInteraction, type: Bool, default: FALSE

Use Managed Interaction for the mouse interaction. This is useful if the rest of the interaction in the scene also uses Managed Interaction, since otherwise there might overlapping interactions.

Hidden Fields

position

name: position, type: Vector3, default: -3.9842700958252 -7.72900009155273 32.6810989379883

positionMode

name: positionMode, type: Enum, default: Off

Values:

Title Name
Off Off
Navigate Navigate
On On

lutAlphaSync

name: lutAlphaSync, type: Bool, default: TRUE

If checked, the setting of the alpha value and the gray value width/center of the LUT is synchronized.

lutGrayCenter

name: lutGrayCenter, type: Double, default: 0.5, deprecated name: lutGreyCenter

lutGrayWidth

name: lutGrayWidth, type: Double, default: 0.5, deprecated name: lutGreyWidth

lutAlphaCenter

name: lutAlphaCenter, type: Double, default: 0.5

lutAlphaWidth

name: lutAlphaWidth, type: Double, default: 0.5

lutSetDefault

name: lutSetDefault, type: Trigger

lutRangeMin

name: lutRangeMin, type: Double, persistent: no

lutRangeMax

name: lutRangeMax, type: Double, persistent: no

lutIsRelative

name: lutIsRelative, type: Bool, default: TRUE

lutSetDefaultOnce

name: lutSetDefaultOnce, type: Bool, default: FALSE

useRelativeLUTIfNoInputImage

name: useRelativeLUTIfNoInputImage, type: Bool, default: TRUE

lutColorFactor

name: lutColorFactor, type: Color, default: 1 1 1

lutAlphaFactor

name: lutAlphaFactor, type: Double, default: 1, minimum: 0, maximum: 1

annotFontSize

name: annotFontSize, type: Enum, default: ANNO_SIZE_AUTO

Values:

Title Name Deprecated Name
Auto ANNO_SIZE_AUTO AUTO_SIZE_ANNOTATION
Small ANNO_SIZE_SMALL SMALL_ANNOTATION
Medium ANNO_SIZE_MEDIUM MEDIUM_ANNOTATION
Large ANNO_SIZE_LARGE LARGE_ANNOTATION
User ANNO_SIZE_USER  

annotShowOrientation

name: annotShowOrientation, type: Enum, default: ANNO_ORIENTATION_SIZE_WEIGHTED

Values:

Title Name Deprecated Name
Off ANNO_ORIENTATION_OFF FALSE
Size Fixed ANNO_ORIENTATION_SIZE_FIXED  
Size Weighted ANNO_ORIENTATION_SIZE_WEIGHTED TRUE

annotVerticalRuler

name: annotVerticalRuler, type: Bool, default: TRUE

annotHorizontalRuler

name: annotHorizontalRuler, type: Bool, default: FALSE

annotationCol

name: annotationCol, type: Color, default: 0.899999976158142 0.899999976158142 0.899999976158142

annotationMode

name: annotationMode, type: Enum, default: ANNO_MODE_AUTO

Values:

Title Name Deprecated Name
User ANNO_MODE_USER USER_ANNOTATION
CT ANNO_MODE_CT CT_ANNOTATION
MR ANNO_MODE_MR MR_ANNOTATION
Auto ANNO_MODE_AUTO AUTO_SELECT_ANNOTATION

annotShowAnnot

name: annotShowAnnot, type: Enum, default: ANNO_SHOW_DETAILED

Values:

Title Name Deprecated Name
Hide ANNO_SHOW_HIDE HIDE_ANNOTATION
Short ANNO_SHOW_SHORT SHORT_ANNOTATION
Detailed ANNO_SHOW_DETAILED DETAILED_ANNOTATION

annotUserTopLeft

name: annotUserTopLeft, type: String, default: $(PatientsName), $(PatientID) $(PatientsSex), $(PatientsBirthDate), ($(input00)): $(input01)

annotUserTopRight

name: annotUserTopRight, type: String, default: $(InstitutionName), $(ManufacturersModelName), $(Modality)

annotUserBottomLeft

name: annotUserBottomLeft, type: String, default: slice:  $(slice), Timepoint: $(timepoint), $(sizex),$(sizey),$(sizez),$(sizec),$(sizet),$(sizeu), $(voxelx),$(voxely),$(voxelz), $(SeriesDescription)

annotUserBottomRight

name: annotUserBottomRight, type: String, default: User Mode, Scan: $(AcquisitionDate), LUT C/W: $(numInput03) / $(numInput04)

annotUserBottomCenter

name: annotUserBottomCenter, type: String

annotShortTopLeft

name: annotShortTopLeft, type: String, default: $(PatientsName), ($(input00)):,  $(input01) GV

annotShortTopRight

name: annotShortTopRight, type: String, default: $(Modality)

annotShortBottomLeft

name: annotShortBottomLeft, type: String, default: Slice: $(slice)

annotShortBottomRight

name: annotShortBottomRight, type: String, default: LUT C/W: $(numInput03) / $(numInput04)

annotShortBottomCenter

name: annotShortBottomCenter, type: String

annotMRTopLeft

name: annotMRTopLeft, type: String, default: $(PatientsName), $(PatientsBirthDate)  $(PatientsSex), $(PatientID), ($(input00)):, $(input01) GV

annotMRTopRight

name: annotMRTopRight, type: String, default: $(InstitutionName), $(ManufacturersModelName), $(Modality)

annotMRBottomLeft

name: annotMRBottomLeft, type: String, default: Slice: $(slice), Timepoint: $(timepoint), $(sizex),$(sizey),$(sizez),$(sizec),$(sizet), $(voxelx),$(voxely),$(voxelz), $(SeriesDescription), $(ImageComments)

annotMRBottomRight

name: annotMRBottomRight, type: String, default: MR Mode, Scan: $(AcquisitionDate), LUT C/W: $(numInput03) / $(numInput04)

annotMRBottomCenter

name: annotMRBottomCenter, type: String

annotCTTopLeft

name: annotCTTopLeft, type: String, default: $(PatientsName), $(PatientsBirthDate)  $(PatientsSex), $(PatientID), ($(input00)): , $(numInput02) $(input09)

annotCTTopRight

name: annotCTTopRight, type: String, default: $(InstitutionName), $(ManufacturersModelName), $(Modality)

annotCTBottomLeft

name: annotCTBottomLeft, type: String, default: Slice: $(slice), Timepoint: $(timepoint), $(sizex),$(sizey),$(sizez),$(sizec),$(sizet), $(voxelx),$(voxely),$(voxelz), $(SeriesDescription), $(ImageComments)

annotCTBottomRight

name: annotCTBottomRight, type: String, default: CT Mode, Scan: $(AcquisitionDate), LUT C/W: $(numInput07) / $(numInput08)

annotCTBottomCenter

name: annotCTBottomCenter, type: String

annoInput03

name: annoInput03, type: String, default: 0.5

annoInput04

name: annoInput04, type: String, default: 0.5

annoInput05

name: annoInput05, type: String, default: 0.5

annoInput06

name: annoInput06, type: String, default: 0.5

annoInput07

name: annoInput07, type: String, default: 0.5

annoInput08

name: annoInput08, type: String, default: 0.5

annoInput09

name: annoInput09, type: String, default: HU

annoNumInput00

name: annoNumInput00, type: Double, default: 0

annoNumInput01

name: annoNumInput01, type: Double, default: 0

annoNumInput02

name: annoNumInput02, type: Double, default: nan

annoNumInput03

name: annoNumInput03, type: Double, default: 0.5

annoNumInput04

name: annoNumInput04, type: Double, default: 0.5

annoNumInput05

name: annoNumInput05, type: Double, default: 0.5

annoNumInput06

name: annoNumInput06, type: Double, default: 0.5

annoNumInput07

name: annoNumInput07, type: Double, default: 0.5

maxPrecision

name: maxPrecision, type: Integer, default: 4

showColorChannelValues

name: showColorChannelValues, type: Bool, default: FALSE

colorChannelSeparator

name: colorChannelSeparator, type: String, default: /

annoReadPixFloorPos

name: annoReadPixFloorPos, type: Vector3, persistent: no

annoReadPixVoxelPos

name: annoReadPixVoxelPos, type: Vector3, persistent: no

annoReadPixWorldPos

name: annoReadPixWorldPos, type: Vector3, persistent: no

borderColor

name: borderColor, type: Color, default: 0.899999976158142 0.899999976158142 0.899999976158142

borderWidth

name: borderWidth, type: Float, default: 1, minimum: 0

borderEvaluateFocus

name: borderEvaluateFocus, type: Bool, default: FALSE

borderFocusColor

name: borderFocusColor, type: Color, default: 1 1 1

borderFocusWidth

name: borderFocusWidth, type: Float, default: 2, minimum: 0

mouseGrabberMode

name: mouseGrabberMode, type: Bool, default: FALSE

lutOn

name: lutOn, type: Bool, default: TRUE

If checked, the use of a LUT is enabled.

lutMouseOn

name: lutMouseOn, type: Bool, default: TRUE

If checked, the interactive setting of the LUT width and center is enabled.

lutMouseButton1

name: lutMouseButton1, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

lutMouseButton2

name: lutMouseButton2, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

lutMouseButton3

name: lutMouseButton3, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

lutMouseShift

name: lutMouseShift, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

lutMouseCtrl

name: lutMouseCtrl, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

lutMouseAlt

name: lutMouseAlt, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

positionMouseButton1

name: positionMouseButton1, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

positionMouseButton2

name: positionMouseButton2, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

positionMouseButton3

name: positionMouseButton3, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

positionMouseShift

name: positionMouseShift, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

positionMouseCtrl

name: positionMouseCtrl, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

positionMouseAlt

name: positionMouseAlt, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

positionColor

name: positionColor, type: Color, default: 0.886206984519958 0.875320017337799 0.560474991798401

positionDrawingOn

name: positionDrawingOn, type: Bool, default: FALSE

slicerMouseButton1

name: slicerMouseButton1, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

slicerMouseButton2

name: slicerMouseButton2, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

slicerMouseButton3

name: slicerMouseButton3, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

slicerMouseShift

name: slicerMouseShift, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

slicerMouseCtrl

name: slicerMouseCtrl, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

slicerMouseAlt

name: slicerMouseAlt, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

zoomMouseButton1

name: zoomMouseButton1, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

zoomMouseButton2

name: zoomMouseButton2, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

zoomMouseButton3

name: zoomMouseButton3, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

zoomMouseShift

name: zoomMouseShift, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

zoomMouseCtrl

name: zoomMouseCtrl, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

zoomMouseAlt

name: zoomMouseAlt, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

panMouseButton1

name: panMouseButton1, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

panMouseButton2

name: panMouseButton2, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

panMouseButton3

name: panMouseButton3, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

panMouseShift

name: panMouseShift, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

panMouseCtrl

name: panMouseCtrl, type: Enum, default: RELEASED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

panMouseAlt

name: panMouseAlt, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

autoCenterMouseButton1

name: autoCenterMouseButton1, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

autoCenterMouseButton2

name: autoCenterMouseButton2, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

autoCenterMouseButton3

name: autoCenterMouseButton3, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

autoCenterMouseShift

name: autoCenterMouseShift, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

autoCenterMouseCtrl

name: autoCenterMouseCtrl, type: Enum, default: PRESSED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

autoCenterMouseAlt

name: autoCenterMouseAlt, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED