View2DExtensions¶

MacroModule¶

genre	`View2D`
author	`Tobias Boskamp`
package	`MeVisLab/Standard`
definition	viewers.def
see also	`SoView2D`, `SoView2DAnnotation`, `SoView2DAutoCenter`, `SoView2DBorder`, `SoView2DVoxelValue`, `SoView2DSlicePan`, `SoView2DSliceZoom`, `SoView2DSlicer`, `SoRLLookUpTable`, `SoMouseGrabber`
keywords	`standard`, `navigation`, `zoom`, `shift`, `pan`, `autocenter`, `lut`, `lookup`, `annotation`

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`	`autoCenterMouseButton2`: `Enum`	`lutRangeMin`: `Float`
`annoInput04`: `String`	`autoCenterMouseButton3`: `Enum`	`lutSetDefault`: `Trigger`
`annoInput05`: `String`	`autoCenterMouseCtrl`: `Enum`	`lutSetDefaultOnce`: `Bool`
`annoInput06`: `String`	`autoCenterMouseShift`: `Enum`	`maxPrecision`: `Integer`
`annoInput07`: `String`	`borderColor`: `Color`	`mouseGrabberMode`: `Bool`
`annoInput08`: `String`	`borderEvaluateFocus`: `Bool`	`panMouseAlt`: `Enum`
`annoInput09`: `String`	`borderFocusColor`: `Color`	`panMouseButton1`: `Enum`
`annoReadPixFloorPos`: `Vector3`	`borderFocusWidth`: `Float`	`panMouseButton2`: `Enum`
`annoReadPixVoxelPos`: `Vector3`	`borderWidth`: `Float`	`panMouseButton3`: `Enum`
`annoReadPixWorldPos`: `Vector3`	`Coordinate System`: `Enum`	`panMouseCtrl`: `Enum`
`annotationCol`: `Color`	`CT Values`: `Enum`	`panMouseShift`: `Enum`
`annotationMode`: `Enum`	`Display value with high precision`: `Bool`	`position`: `Vector3`
`annotCTBottomLeft`: `String`	`Enable (slicerOn)`: `Bool`	`positionColor`: `Color`
`annotCTBottomRight`: `String`	`Enable (zoomOn)`: `Bool`	`positionDrawingOn`: `Bool`
`annotCTTopLeft`: `String`	`Enable (panOn)`: `Bool`	`positionMode`: `Enum`
`annotCTTopRight`: `String`	`Enable (autoCenterOn)`: `Bool`	`positionMouseAlt`: `Enum`
`annotFontSize`: `Enum`	`Enable (annotationOn)`: `Bool`	`positionMouseButton1`: `Enum`
`annotHorizontalRuler`: `Bool`	`Enable (annoMouseOn)`: `Bool`	`positionMouseButton2`: `Enum`
`annotMRBottomLeft`: `String`	`Enable (borderOn)`: `Bool`	`positionMouseButton3`: `Enum`
`annotMRBottomRight`: `String`	`Enable (lutOn)`: `Bool`	`positionMouseCtrl`: `Enum`
`annotMRTopLeft`: `String`	`Enable (lutMouseOn)`: `Bool`	`positionMouseShift`: `Enum`
`annotMRTopRight`: `String`	`lutAlphaCenter`: `Float`	`slicerMouseAlt`: `Enum`
`annotShortBottomLeft`: `String`	`lutAlphaFactor`: `Double`	`slicerMouseButton1`: `Enum`
`annotShortBottomRight`: `String`	`lutAlphaWidth`: `Float`	`slicerMouseButton2`: `Enum`
`annotShortTopLeft`: `String`	`lutColorFactor`: `Color`	`slicerMouseButton3`: `Enum`
`annotShortTopRight`: `String`	`lutGrayCenter`: `Float`	`slicerMouseCtrl`: `Enum`
`annotShowAnnot`: `Enum`	`lutGrayWidth`: `Float`	`slicerMouseShift`: `Enum`
`annotShowOrientation`: `Enum`	`lutIsRelative`: `Bool`	`Synchronize Gray and Alpha`: `Bool`
`annotUserBottomLeft`: `String`	`lutMouseAlt`: `Enum`	`useRelativeLUTIfNoInputImage`: `Bool`
`annotUserBottomRight`: `String`	`lutMouseButton1`: `Enum`	`zoomMouseAlt`: `Enum`
`annotUserTopLeft`: `String`	`lutMouseButton2`: `Enum`	`zoomMouseButton1`: `Enum`
`annotUserTopRight`: `String`	`lutMouseButton3`: `Enum`	`zoomMouseButton2`: `Enum`
`annotVerticalRuler`: `Bool`	`lutMouseCtrl`: `Enum`	`zoomMouseButton3`: `Enum`
`autoCenterMouseAlt`: `Enum`	`lutMouseShift`: `Enum`	`zoomMouseCtrl`: `Enum`
`autoCenterMouseButton1`: `Enum`	`lutRangeMax`: `Float`	`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.

Synchronize Gray and Alpha¶

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.

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
As Is	AsIs
To Hounsfield	ToHounsfield

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.

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.

Enable (lutOn)¶

name: lutOn, type: Bool, default: TRUE¶: If checked, the use of a LUT is enabled.

Enable (lutMouseOn)¶

name: lutMouseOn, type: Bool, default: TRUE¶: If checked, the interactive setting of the LUT width and center is enabled.

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

lutGrayCenter¶

name: lutGrayCenter, type: Float, default: 0.43000001¶

lutGrayWidth¶

name: lutGrayWidth, type: Float, default: 1¶

lutAlphaCenter¶

name: lutAlphaCenter, type: Float, default: 0.43000001¶

lutAlphaWidth¶

name: lutAlphaWidth, type: Float, default: 1¶

lutSetDefault¶

name: lutSetDefault, type: Trigger¶

lutRangeMin¶

name: lutRangeMin, type: Float, default: 0¶

lutRangeMax¶

name: lutRangeMax, type: Float, default: 1¶

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
Auto	ANNO_SIZE_AUTO
Small	ANNO_SIZE_SMALL
Medium	ANNO_SIZE_MEDIUM
Large	ANNO_SIZE_LARGE
User	ANNO_SIZE_USER

annotShowOrientation¶

name: annotShowOrientation, type: Enum, default: ANNO_ORIENTATION_SIZE_WEIGHTED¶

Values:

Title	Name
Off	ANNO_ORIENTATION_OFF
Size Fixed	ANNO_ORIENTATION_SIZE_FIXED
Size Weighted	ANNO_ORIENTATION_SIZE_WEIGHTED

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
User	ANNO_MODE_USER
CT	ANNO_MODE_CT
MR	ANNO_MODE_MR
Auto	ANNO_MODE_AUTO

annotShowAnnot¶

name: annotShowAnnot, type: Enum, default: ANNO_SHOW_DETAILED¶

Values:

Title	Name
Hide	ANNO_SHOW_HIDE
Short	ANNO_SHOW_SHORT
Detailed	ANNO_SHOW_DETAILED

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), $(voxelx),$(voxely),$(voxelz), $(SeriesDescription)¶

annotUserBottomRight¶

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

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)¶

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)¶

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)¶

annoInput03¶

name: annoInput03, type: String, default: 0.43000001¶

annoInput04¶

name: annoInput04, type: String, default: 1¶

annoInput05¶

name: annoInput05, type: String, default: 0.430000007152557¶

annoInput06¶

name: annoInput06, type: String, default: 1¶

annoInput07¶

name: annoInput07, type: String, default: 0.430000007152557¶

annoInput08¶

name: annoInput08, type: String, default: 1¶

annoInput09¶

name: annoInput09, type: String, default: HU¶

maxPrecision¶

name: maxPrecision, type: Integer, default: 4¶

annoReadPixFloorPos¶

name: annoReadPixFloorPos, type: Vector3, default: -1 -1 -1¶

annoReadPixVoxelPos¶

name: annoReadPixVoxelPos, type: Vector3, default: -1 -1 -1¶

annoReadPixWorldPos¶

name: annoReadPixWorldPos, type: Vector3, default: -1 -1 -1¶

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¶

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

Navigation

View2DExtensions¶

Purpose¶

Details¶

Windows¶

Default Panel¶

Input Fields¶

inLUT¶

Output Fields¶

outNode¶

Parameter Fields¶

Field Index¶

Visible Fields¶

Enable (slicerOn)¶

Enable (zoomOn)¶

Enable (panOn)¶

Enable (autoCenterOn)¶

Synchronize Gray and Alpha¶

Coordinate System¶

CT Values¶

Display value with high precision¶

Enable (annotationOn)¶

Enable (annoMouseOn)¶

Enable (borderOn)¶

Enable (lutOn)¶

Enable (lutMouseOn)¶

Hidden Fields¶

position¶

positionMode¶

lutGrayCenter¶

lutGrayWidth¶

lutAlphaCenter¶

lutAlphaWidth¶

lutSetDefault¶

lutRangeMin¶

lutRangeMax¶

lutIsRelative¶

lutSetDefaultOnce¶

useRelativeLUTIfNoInputImage¶

lutColorFactor¶

lutAlphaFactor¶

annotFontSize¶

annotShowOrientation¶

annotVerticalRuler¶

annotHorizontalRuler¶

annotationCol¶

annotationMode¶

annotShowAnnot¶

annotUserTopLeft¶

annotUserTopRight¶

annotUserBottomLeft¶

annotUserBottomRight¶

annotShortTopLeft¶

annotShortTopRight¶

annotShortBottomLeft¶

annotShortBottomRight¶

annotMRTopLeft¶

annotMRTopRight¶

annotMRBottomLeft¶

annotMRBottomRight¶

annotCTTopLeft¶

annotCTTopRight¶

annotCTBottomLeft¶

annotCTBottomRight¶

annoInput03¶

annoInput04¶

annoInput05¶

annoInput06¶

annoInput07¶

annoInput08¶

annoInput09¶

maxPrecision¶

annoReadPixFloorPos¶

annoReadPixVoxelPos¶

annoReadPixWorldPos¶

borderColor¶

borderWidth¶

borderEvaluateFocus¶

borderFocusColor¶

borderFocusWidth¶