SoView2DAnnotation¶

InventorModule¶

genre	`View2DExtended`
author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`SoView2D`
definition	view2d.def
see also	`SoView2D`
inherits from	`SoView2DExtension`
keywords	`dicom`, `ct`, `mrt`, `information`, `user-defined`, `extension`

Purpose¶

The module SoView2DAnnotation displays general and configurable image information in a 2D viewer.

Details¶

The following keywords are available in the annotation text (written as $(variablename)):

Variable	Description
timepoint	The current temporal position.
timepointPlus1	Above plus one.
userIndex	The current user index.
slice	The current slice.
slicePlus1	Above plus one.
numSlices	The total number of slices.
sliceThickness	The thickness of the slice in mm.
min	The minimum voxel value of the dataset.
max	The maximum voxel value of the dataset.
zoom	The current zoom (zoom == 1 means one pixel per voxel).
type	The datatype of the image.
status	The status string of the SoView2D.
size[xyzctu]	The size of the dataset in x,y,z,c,t,u dimension (in voxel).
page[xyzctu]	The page size of the dataset in x,y,z,c,t,u dimension (in voxel).
voxel[xyz]	The voxel size of the dataset in x,y,z dimension (in mm).
input[00-09]	The string value of the `input00`- `input09` fields.
numInput[00-09]	The numerical value of the `numInput00`- `numInput09` fields.
lutSize	The size of the used LUT.
shader	The active shader (GLSL, or empty if no shader is used).
distanceToCenterSlice	In case of mosaic views, that displays the distance (in mm ) to the center slice.
distanceToCenterSliceCM	In case of mosaic views, that displays the distance (in mm ) to the center slice.

In addition to these variables, any DICOM tag name can be specified, e.g., $(PatientsName).

One can specify a maximum displayed string length (for string values) or the decimal precision (for numerical values) by specifying an additional number after the variable name like this: $(variablename:number). If not given, a variable-specific default is applied.

Interaction¶

Key	Function
A	Toggles `Show Annotation` modes.
I	Toggles image information.

Tips¶

This module may be be used to display information on a 3D viewer as well by using a dummy SoView2D which does not draw the image. To facilitate orientation and scale determination of a 3D viewer, the field orientationAndScaleFromCamera on the automatic panel can be enabled, which will take the Open Inventor viewing matrix to determine the orientation (used for orientation letters and orientation cube) and which will render the rulers correctly when an orthographic camera is used. Rulers are automatically disabled for perspective cameras.

Windows¶

Default Panel¶

../../../Modules/Inventor/SoView2D/mhelp/Images/Screenshots/SoView2DAnnotation._default.png

Input Fields¶

inOrientationModel¶

name: inOrientationModel, type: SoNode¶

Output Fields¶

self¶

name: self, type: SoNode¶

Parameter Fields¶

Field Index¶

`abreviateChars`: `Integer`	`Hit Orientation Letter`: `String`	`numInput07`: `Double`
`abreviateShortChars`: `Integer`	`ignoreHandledEvents`: `Bool`	`numInput08`: `Double`
`alt`: `Enum`	`input00`: `String`	`numInput09`: `Double`
`Annotation Color`: `Color`	`input01`: `String`	`Orientation Color`: `Color`
`Annotation Font Size`: `Enum`	`input02`: `String`	`orientationAndScaleFromCamera`: `Bool`
`Annotation Mode`: `Enum`	`input03`: `String`	`Position`: `Enum`
`Background Color`: `Color`	`input04`: `String`	`Relative Offset (orientationModelRelativeVerticalOffset)`: `Float`
`Background Opacity`: `Float`	`input05`: `String`	`Relative Offset (orientationModelRelativeHorizontalOffset)`: `Float`
`Bottom Center (annotationUserBottomCenter)`: `String`	`input06`: `String`	`Relative Size`: `Float`
`Bottom Center (annotationCTBottomCenter)`: `String`	`input07`: `String`	`renderOnSlab`: `Bool`
`Bottom Center (annotationMRBottomCenter)`: `String`	`input08`: `String`	`Ruler Shadow`: `Bool`
`Bottom Center (shortBottomCenter)`: `String`	`input09`: `String`	`selectionTolerance`: `Float`
`Bottom Left (annotationUserBottomLeft)`: `String`	`interactionProviderID`: `String`	`setEventHandled`: `Bool`
`Bottom Left (annotationCTBottomLeft)`: `String`	`Is Mouse Over Cube`: `Bool`	`Shadow Color`: `Color`
`Bottom Left (annotationMRBottomLeft)`: `String`	`Margin (verticalRulerMarginRight)`: `Integer`	`shift`: `Enum`
`Bottom Left (shortBottomLeft)`: `String`	`Margin (horizontalRulerMarginBottom)`: `Integer`	`Show Annotation`: `Enum`
`Bottom Right (annotationUserBottomRight)`: `String`	`Margin Bottom`: `Integer`	`Show horizontal ruler`: `Bool`
`Bottom Right (annotationCTBottomRight)`: `String`	`Margin Left`: `Integer`	`Show negative`: `Bool`
`Bottom Right (annotationMRBottomRight)`: `String`	`Margin Right`: `Integer`	`Show Orientation`: `Enum`
`Bottom Right (shortBottomRight)`: `String`	`Margin Top`: `Integer`	`Show positive`: `Bool`
`button1`: `Enum`	`maskValid`: `Bool`	`Show vertical ruler`: `Bool`
`button2`: `Enum`	`Max Detail Font Size`: `Integer`	`showTechnicalInfo`: `Bool`
`button3`: `Enum`	`Max Short Font Size`: `Integer`	`singleClicked`: `Trigger`
`clipToSlice`: `Bool`	`Max. Pixel (orientationModelMaxVerticalOffset)`: `Integer`	`targetHeight`: `Integer`
`Color`: `Color`	`Max. Pixel (orientationModelMaxHorizontalOffset)`: `Integer`	`targetWidth`: `Integer`
`control`: `Enum`	`Max. Pixel Size`: `Integer`	`Top Left (annotationUserTopLeft)`: `String`
`createNewMode`: `Bool`	`Min Detail Font Size`: `Integer`	`Top Left (annotationCTTopLeft)`: `String`
`createNewModeRequest`: `Trigger`	`Min Short Font Size`: `Integer`	`Top Left (annotationMRTopLeft)`: `String`
`cursorShape`: `Enum`	`Min. Pixel (orientationModelMinVerticalOffset)`: `Integer`	`Top Left (shortTopLeft)`: `String`
`doubleClicked`: `Trigger`	`Min. Pixel (orientationModelMinHorizontalOffset)`: `Integer`	`Top Right (annotationUserTopRight)`: `String`
`Draw background`: `Bool`	`Min. Pixel Size`: `Integer`	`Top Right (annotationCTTopRight)`: `String`
`drawingOn`: `Bool`	`needsValidVoxel`: `Bool`	`Top Right (annotationMRTopRight)`: `String`
`Edge Color`: `Color`	`numInput00`: `Double`	`Top Right (shortTopRight)`: `String`
`Edge Opacity`: `Float`	`numInput01`: `Double`	`Use text shadow`: `Bool`
`editingOn`: `Bool`	`numInput02`: `Double`	`User Detail Font Size`: `Integer`
`Enable`: `Bool`	`numInput03`: `Double`	`User Short Font Size`: `Integer`
`fixZOn`: `Bool`	`numInput04`: `Double`	`wantsAllEvents`: `Bool`
`Font Size`: `Integer`	`numInput05`: `Double`	`wantsKeyEvents`: `Bool`
`fontWidthDummyString`: `String`	`numInput06`: `Double`	`wantsMouseWheelEvents`: `Bool`

Visible Fields¶

Annotation Color¶

name: color, type: Color, default: 1 1 1¶: Sets the color of the annotations.

Annotation Mode¶

name: annotationMode, type: Enum, default: ANNO_MODE_AUTO¶: Defines the chapter from which the layout information is taken.

Values:

Title	Name	Deprecated Name	Description
User	ANNO_MODE_USER	USER_ANNOTATION	Information is taken from the USER chapter.
CT	ANNO_MODE_CT	CT_ANNOTATION	Information is taken from the CT chapter.
MR	ANNO_MODE_MR	MR_ANNOTATION	Information is taken from the MR chapter.
Auto	ANNO_MODE_AUTO	AUTO_SELECT_ANNOTATION	Module chooses on base of DICOM tags.

Show Orientation¶

name: showOrientation, type: Enum, default: ANNO_ORIENTATION_SIZE_WEIGHTED¶: Defines how the orientation letters are displayed.

Values:

Title	Name	Deprecated Name	Description
Off	ANNO_ORIENTATION_OFF	FALSE	No orientation letters are shown.
Size Fixed	ANNO_ORIENTATION_SIZE_FIXED		Orientation letters are always shown with the same size.
Size Weighted	ANNO_ORIENTATION_SIZE_WEIGHTED	TRUE	The size of the orientation letters vary to indicate the actual orientation.

Show negative¶

name: drawNegativeOrientation, type: Bool, default: TRUE¶: If checked, the orientation letters pointing into negative axis directions are shown.

Show positive¶

name: drawPositiveOrientation, type: Bool, default: FALSE¶: If checked, the orientation letters pointing into positive axis directions are shown.

Orientation Color¶

name: orientationColor, type: Color, default: 1 1 1¶: Sets the color of the orientation letters.

Show vertical ruler¶

name: verticalRuler, type: Bool, default: TRUE, deprecated name: showVerticalRuler¶

If checked, a vertical ruler is shown at the right hand side of the viewer.

The scale and units of the ruler depend on the zoom level of the image.

Show horizontal ruler¶

name: horizontalRuler, type: Bool, default: FALSE, deprecated name: showHorizontalRuler¶

If checked, a horizontal ruler is shown at the bottom of the viewer.

The scale and units of the ruler depend on the zoom level of the image.

Margin (verticalRulerMarginRight)¶

name: verticalRulerMarginRight, type: Integer, default: 8¶: Sets a margin for the vertical ruler in pixel.

Margin (horizontalRulerMarginBottom)¶

name: horizontalRulerMarginBottom, type: Integer, default: 8¶: Sets a margin for the horizontal ruler in pixel.

Show Annotation¶

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

Defines the annotation mode.

This can be toggled by pressing the A key in the viewer.

Also, the module toggles between Short and Detailed based on the size of the viewport.

Values:

Title	Name	Deprecated Name	Description
Hide	ANNO_SHOW_HIDE	HIDE_ANNOTATION	No annotation is shown.
Short	ANNO_SHOW_SHORT	SHORT_ANNOTATION	A subset of information is shown.
Detailed	ANNO_SHOW_DETAILED	DETAILED_ANNOTATION	All detailed information is shown.

Annotation Font Size¶

name: annotationFontSize, type: Enum, default: ANNO_SIZE_AUTO¶: Defines the size of the annotation font.

Values:

Title	Name	Deprecated Name	Description
Auto	ANNO_SIZE_AUTO	AUTO_SIZE_ANNOTATION	The size is automatically chosen on base of the size of the viewport. The sizes to switch between short and detailed information can be set with `Min Short Font Size`, `Max Short Font Size`, `Min Detail Font Size`, and `Max Detail Font Size`.
Small	ANNO_SIZE_SMALL	SMALL_ANNOTATION	A small font size.
Medium	ANNO_SIZE_MEDIUM	MEDIUM_ANNOTATION	A medium font size.
Large	ANNO_SIZE_LARGE	LARGE_ANNOTATION	A large font size.
User	ANNO_SIZE_USER		A user defined font size, defined in `User Short Font Size` and `User Detail Font Size`.

Min Detail Font Size¶

name: minDetailFontSize, type: Integer, default: 10, minimum: 6, maximum: :field:`maxDetailFontSize`¶: Sets the minimum font size for detail information before switching to short information.

Max Detail Font Size¶

name: maxDetailFontSize, type: Integer, default: 18, minimum: :field:`minDetailFontSize`, maximum: 64¶: Sets the maximum font size for detailed information.

Min Short Font Size¶

name: minShortFontSize, type: Integer, default: 8, minimum: 6, maximum: :field:`maxShortFontSize`¶: Sets the minimum font size for short information.

Max Short Font Size¶

name: maxShortFontSize, type: Integer, default: 12, minimum: :field:`minShortFontSize`, maximum: 64¶: Sets the maximum font size for short information before switching to detailed information.

User Detail Font Size¶

name: userDetailFontSize, type: Integer, default: 12, minimum: 6, maximum: 64¶: Sets the user font size for detailed information.

User Short Font Size¶

name: userShortFontSize, type: Integer, default: 10, minimum: 6, maximum: 64¶: Sets the user font size for short information.

Font Size¶

name: rulerFontSize, type: Integer, default: 12, minimum: 6, maximum: 64¶: Sets the font size of the ruler text.

Use text shadow¶

name: textShadow, type: Bool, default: TRUE¶: If checked, a text shadow is displayed to enhance readability.

Shadow Color¶

name: textShadowColor, type: Color, default: 0 0 0¶: Sets the color of all text shadows.

Ruler Shadow¶

name: rulerShadow, type: Bool, default: TRUE¶: If checked, the ruler(s) will be displayed with a black shadow.

Top Left (annotationUserTopLeft)¶

name: annotationUserTopLeft, type: String, default: $(PatientsName), $(PatientID) $(PatientsSex), $(PatientsBirthDate)¶: Sets the user annotation string for the top left corner.

Top Right (annotationUserTopRight)¶

name: annotationUserTopRight, type: String, default: $(InstitutionName), $(ManufacturersModelName), $(Modality)¶: Sets the user annotation string for the top right corner.

Bottom Left (annotationUserBottomLeft)¶

name: annotationUserBottomLeft, type: String, default: slice: $(slice), $(SeriesDescription)¶: Sets the user annotation string for the bottom left corner.

Bottom Right (annotationUserBottomRight)¶

name: annotationUserBottomRight, type: String, default: User Mode, acquisition: $(AcquisitionDate)¶: Sets the user annotation string for the bottom right corner.

Bottom Center (annotationUserBottomCenter)¶

name: annotationUserBottomCenter, type: String¶: Sets a string that is displayed at the bottom center of the viewer.

Top Left (annotationCTTopLeft)¶

name: annotationCTTopLeft, type: String, default: $(PatientsName), $(PatientID) $(PatientsSex), $(PatientsBirthDate)¶: Sets the CT annotation string for the top left corner.

Top Right (annotationCTTopRight)¶

name: annotationCTTopRight, type: String, default: $(InstitutionName), $(ManufacturersModelName), $(Modality)¶: Sets the CT annotation string for the top right corner.

Bottom Left (annotationCTBottomLeft)¶

name: annotationCTBottomLeft, type: String, default: slice: $(slice), timepoint: $(timepoint), $(sizex),$(sizey),$(sizez),$(sizec),$(sizet), $(voxelx),$(voxely),$(voxelz), $(SeriesDescription)¶: Sets the CT annotation string for the bottom left corner.

Bottom Right (annotationCTBottomRight)¶

name: annotationCTBottomRight, type: String, default: CT Mode, acquisition: $(AcquisitionDate)¶: Sets the CT annotation string for the bottom right corner.

Bottom Center (annotationCTBottomCenter)¶

name: annotationCTBottomCenter, type: String¶: Sets a string that is displayed at the bottom center of the viewer.

Top Left (annotationMRTopLeft)¶

name: annotationMRTopLeft, type: String, default: $(PatientsName), $(PatientID) $(PatientsSex), $(PatientsBirthDate)¶: Sets the MR annotation string for the top left corner.

Top Right (annotationMRTopRight)¶

name: annotationMRTopRight, type: String, default: $(InstitutionName), $(ManufacturersModelName), $(Modality)¶: Sets the MR annotation string for the top right corner.

Bottom Left (annotationMRBottomLeft)¶

name: annotationMRBottomLeft, type: String, default: slice: $(slice), timepoint: $(timepoint), $(sizex),$(sizey),$(sizez),$(sizec),$(sizet), $(voxelx),$(voxely),$(voxelz), $(SeriesDescription)¶: Sets the MR annotation string for the bottom left corner.

Bottom Right (annotationMRBottomRight)¶

name: annotationMRBottomRight, type: String, default: MR Mode, acquisition: $(AcquisitionDate)¶: Sets the MR annotation string for the bottom right corner.

Bottom Center (annotationMRBottomCenter)¶

name: annotationMRBottomCenter, type: String¶: Sets a string that is displayed at the bottom center of the viewer.

Top Left (shortTopLeft)¶

name: shortTopLeft, type: String, default: $(PatientsName), $(PatientID)¶: Sets the short annotation string for the top left corner.

Top Right (shortTopRight)¶

name: shortTopRight, type: String, default: $(Modality)¶: Sets the short annotation string for the top right corner.

Bottom Left (shortBottomLeft)¶

name: shortBottomLeft, type: String, default: Slice: $(slice)¶: Sets the short annotation string for the bottom left corner.

Bottom Right (shortBottomRight)¶

name: shortBottomRight, type: String¶: Sets the short annotation string for the bottom right corner.

Bottom Center (shortBottomCenter)¶

name: shortBottomCenter, type: String¶: Sets a string that is displayed at the bottom center of the viewer.