ROISelect

MacroModule

genre	Subimage
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
definition	Geometry.def
see also	View2D, OrthoView2D
keywords	voi, region, volume, interest, subimage, timepoints

Purpose

The module ROISelect selects a cuboid subvolume (VOI) from an input image.

Windows

Default Panel

Input Fields

inImage

name: inImage, type: Image, deprecated name: input

Output Fields

outImage

name: outImage, type: Image, deprecated name: output

outNode

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

Parameter Fields

Field Index

All: Bool	currentPos: Vector3	Layout: Enum
allowDraw: Bool	currentPosColor: Color	limit: Float
annotationColor: Color	currentPosCtrlListen: Enum	Reset (resetAll): Trigger
annotationOn: Bool	currentPosOn: Enum	reset (reset): Bool
annotFontSize: Enum	currentPosShiftListen: Enum	restriction: Enum
annotHorizontalRuler: Bool	Edit Mode: Enum	startVoxelX: Double
annotShowAnnot: Enum	editModeFieldDisable: Bool	startVoxelY: Double
annotShowOrientation: Enum	endVoxelX: Double	startVoxelZ: Double
annotVerticalRuler: Bool	endVoxelY: Double	startWorldPos: Vector3
borderColor: Color	endVoxelZ: Double	Timepoint: Integer
boxBlend: Float	endWorldPos: Vector3	unit: String
boxColor: Color	extraViewLowerLeft: Vector2	useGlobalInputImage: Bool
boxCtrlListen: Enum	extraViewUpperRight: Vector2	usePreview: Bool
boxOn: Bool	grayCenter: Double	worldPosition: Vector3
boxShiftListen: Enum	grayWidth: Double

Visible Fields

Edit Mode

name: editMode, type: Enum, default: Edit

Defines the edit / navigation mode.

Values:

Title	Name
​Edit	​Edit
​Navigate	​Navigate

All

name: allTimepoints, type: Bool, default: TRUE

If checked, the VOI is selected over all available time points.

Timepoint

name: timepoint, type: Integer, default: 0, minimum: 0, maximum: view.maxTimePoint

Sets the current time point.

Reset

name: resetAll, type: Trigger

When pressed, the center slice is shown in all viewers.

Layout

name: layout, type: Enum, default: LAYOUT_ROW_EQUAL

Defines the layout of the viewer(s).

Values:

Title	Name
​Axial	​LAYOUT_AXIAL
​Sagittal	​LAYOUT_SAGITTAL
​Coronal	​LAYOUT_CORONAL
​Cube	​LAYOUT_CUBE
​Cube Equal	​LAYOUT_CUBE_EQUAL
​Cube Customized	​LAYOUT_CUBE_CUSTOMIZED
​Row	​LAYOUT_ROW
​Row Equal	​LAYOUT_ROW_EQUAL
​Row Axialextra	​LAYOUT_ROW_AXIALEXTRA
​Column	​LAYOUT_COLUMN
​Column Equal	​LAYOUT_COLUMN_EQUAL
​Hidden	​LAYOUT_HIDDEN

Hidden Fields

currentPosOn

name: currentPosOn, type: Enum, default: Navigate

Values:

Title	Name
​Navigate	​Navigate
​Always	​Always
​Off	​Off

editModeFieldDisable

name: editModeFieldDisable, type: Bool, default: FALSE

usePreview

name: usePreview, type: Bool, default: FALSE

unit

name: unit, type: String

startWorldPos

name: startWorldPos, type: Vector3, default: -0.5 -0.5 -0.5

startVoxelX

name: startVoxelX, type: Double, default: -1

startVoxelY

name: startVoxelY, type: Double, default: -1

startVoxelZ

name: startVoxelZ, type: Double, default: -1

endWorldPos

name: endWorldPos, type: Vector3, default: -0.5 -0.5 -0.5

endVoxelX

name: endVoxelX, type: Double, default: -1

endVoxelY

name: endVoxelY, type: Double, default: -1

endVoxelZ

name: endVoxelZ, type: Double, default: -1

boxOn

name: boxOn, type: Bool, default: TRUE

boxShiftListen

name: boxShiftListen, type: Enum, default: RELEASED

Values:

Title	Name
​Pressed	​PRESSED
​Released	​RELEASED
​Ignored	​IGNORED

boxCtrlListen

name: boxCtrlListen, type: Enum, default: RELEASED

Values:

Title	Name
​Pressed	​PRESSED
​Released	​RELEASED
​Ignored	​IGNORED

boxBlend

name: boxBlend, type: Float, default: 0.14, minimum: 0, maximum: 1

boxColor

name: boxColor, type: Color, default: 1 0.979525029659271 0.38740399479866

allowDraw

name: allowDraw, type: Bool, default: TRUE

reset

name: reset, type: Bool, default: TRUE

currentPos

name: currentPos, type: Vector3, default: 0 0 0

currentPosShiftListen

name: currentPosShiftListen, type: Enum, default: PRESSED

Values:

Title	Name
​Pressed	​PRESSED
​Released	​RELEASED
​Ignored	​IGNORED

currentPosCtrlListen

name: currentPosCtrlListen, type: Enum, default: RELEASED

Values:

Title	Name
​Pressed	​PRESSED
​Released	​RELEASED
​Ignored	​IGNORED

currentPosColor

name: currentPosColor, type: Color, default: 1 1 1

worldPosition

name: worldPosition, type: Vector3, default: 0 0 0

useGlobalInputImage

name: useGlobalInputImage, type: Bool, default: TRUE

extraViewLowerLeft

name: extraViewLowerLeft, type: Vector2, persistent: no

extraViewUpperRight

name: extraViewUpperRight, type: Vector2, persistent: no

restriction

name: restriction, type: Enum, default: MaxMBytesIsotropic

Values:

Title	Name	Deprecated Name
​Max Voxels Per Dim	​MaxVoxelsPerDim	​MAX_VOXELS_PER_DIM
​Max MBytes Isotropic	​MaxMBytesIsotropic	​MAX_MBYTES_ISOTROPIC
​Max MBytes Cubic	​MaxMBytesCubic	​MAX_MBYTES_CUBIC
​Max MBytes Uniform	​MaxMBytesUniform	​MAX_MBYTES_UNIFORM
​Min Voxel Dist	​MinVoxelDist	​MIN_VOXEL_DIST

limit

name: limit, type: Float, default: 10

grayWidth

name: grayWidth, type: Double, default: 1, deprecated name: greyWidth

grayCenter

name: grayCenter, type: Double, default: 0.5, deprecated name: greyCenter

annotationColor

name: annotationColor, type: Color, default: 0.9 0.9 0.9

borderColor

name: borderColor, type: Color, default: 0.9 0.9 0.9

annotationOn

name: annotationOn, type: Bool, default: TRUE

annotShowAnnot

name: annotShowAnnot, type: Enum, default: ANNO_SHOW_HIDE

Values:

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

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