SoView2DVoxelValue

InventorModule

genre	Interaction
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoView2D
definition	view2d.def
see also	SoView2D, GetVoxelValue
inherits from	SoView2DExtension
keywords	pixel, cursor, position, extension

Purpose

The module SoView2DVoxelValue shows the current position of the mouse cursor and the voxel value beneath it.

Windows

Default Panel

Parameter Fields

Field Index

Alt: Enum	Integer Position: Vector3	Show Color Channel Values: Bool
clipToSlice: Bool	interactionProviderID: String	singleClicked: Trigger
color: Color	Invalidate Undefined Output Values: Bool	Stored Value: Float
Color Channel Separator: String	maskValid: Bool	Stored Value String: String
createNewMode: Bool	Max Precision: Integer	Values Valid: Bool
createNewModeRequest: Trigger	modality: String	viewerId: String
cursorShape: Enum	needsValidVoxel: Bool	Voxel Position: Vector3
doubleClicked: Trigger	Output Value: Float	wantsAllEvents: Bool
drawingOn: Bool	Output Value String: String	wantsKeyEvents: Bool
editingOn: Bool	renderOnSlab: Bool	World Position: Vector3
fixZOn: Bool	selectionTolerance: Float
ignoreHandledEvents: Bool	setEventHandled: Bool

Visible Fields

Alt

name: alt, type: Enum, default: IGNORED

see SoView2DExtension.alt

Values Valid

name: valuesValid, type: Bool, persistent: no, deprecated name: valuesUpToDate

This will be set to false if the mouse cursor is not over the image. Voxel Position, Integer Position, and World Position should be considered as invalid, as well as Output Value and Stored Value.

Voxel Position

name: voxelPosition, type: Vector3, persistent: no, deprecated name: voxelPos

Shows the current voxel position.

Integer Position

name: integerPosition, type: Vector3, persistent: no, deprecated name: floorVoxelPos

Shows the floored current voxel position.

World Position

name: worldPosition, type: Vector3, persistent: no, deprecated name: worldPos

Shows the current world position.

Stored Value

name: storedValue, type: Float, persistent: no, deprecated name: value

Shows the value stored in the image under the mouse cursor.

Output Value

name: outputValue, type: Float, persistent: no, deprecated name: medicalValue

Shows the voxel value under the mouse cursor in Hounsfield units.

This value is only valid for CT images.

Show Color Channel Values

name: showColorChannelValues, type: Bool, default: FALSE

If checked, the display of voxel values from all color channels in Stored Value String is enabled; otherwise, only the value of the first channel is shown.

Color Channel Separator

name: colorChannelSeparator, type: String, default: /

Sets the string used to separate color channel components in Stored Value String; other separators than a space are recommended to distinguish it from the space used in non-scalar voxel values.

Invalidate Undefined Output Values

name: invalidateUndefinedOutputValues, type: Bool, default: TRUE

If checked, output values are set to NaN/empty string when Values Valid is false.

Max Precision

name: maxPrecision, type: Integer, default: 4

Sets the maximum number of digits after the comma of non-scalar voxels.

Stored Value String

name: storedValueString, type: String, persistent: no, deprecated name: valueStr

Shows the same as Stored Value only as a string.

Output Value String

name: outputValueString, type: String, persistent: no, deprecated name: medicalValueStr

Shows the same as Output Value only as a string.

Hidden Fields

interactionProviderID

name: interactionProviderID, type: String

see SoView2DExtension.interactionProviderID

drawingOn

name: drawingOn, type: Bool, default: TRUE

see SoView2DExtension.drawingOn

editingOn

name: editingOn, type: Bool, default: TRUE

see SoView2DExtension.editingOn

maskValid

name: maskValid, type: Bool, persistent: no

fixZOn

name: fixZOn, type: Bool, default: TRUE

color

name: color, type: Color, default: 1 1 1

see SoView2DExtension.color

selectionTolerance

name: selectionTolerance, type: Float, default: 4, deprecated name: selectDistance

needsValidVoxel

name: needsValidVoxel, type: Bool, default: TRUE

see SoView2DExtension.needsValidVoxel

wantsAllEvents

name: wantsAllEvents, type: Bool, default: FALSE

wantsKeyEvents

name: wantsKeyEvents, type: Bool, default: FALSE

setEventHandled

name: setEventHandled, type: Bool, default: FALSE

see SoView2DExtension.setEventHandled

ignoreHandledEvents

name: ignoreHandledEvents, type: Bool, default: FALSE

see SoView2DExtension.ignoreHandledEvents

createNewMode

name: createNewMode, type: Bool, default: FALSE

see SoView2DExtension.createNewMode

createNewModeRequest

name: createNewModeRequest, type: Trigger

see SoView2DExtension.createNewModeRequest

renderOnSlab

name: renderOnSlab, type: Bool, default: FALSE

clipToSlice

name: clipToSlice, type: Bool, default: FALSE

cursorShape

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR

see SoView2DExtension.cursorShape

singleClicked

name: singleClicked, type: Trigger, persistent: no

doubleClicked

name: doubleClicked, type: Trigger, persistent: no

viewerId

name: viewerId, type: String, persistent: no

This field contains the ID of the viewer through which the current voxel position was set.

modality

name: modality, type: String, persistent: no