METKAddROI

5mm

Genre:	METKCaseBuilding
Authors:	Christian Tietjen
Short description:	Generates database entries for a new ROI

Usage

This module sets all necessary entries for a ROI in the ObjMgr. It can be used for a new or an existent case. To specify a new ROI, the ROI must be inherited from an image (e.g. generated with METKAddImage). The image input is checked to find the related image. The childIDs entry of the image is set automatically by ROI creation. The name of the image will be retrieved automatically by the image input, but may be edited afterwards. The image's name will be used to create an object ID.

Depending on the chosen ROI type, a new image dataset is saved to the hard drive (by using the given suffix), or the input image is used and clamped by startVoxel and endVoxel.

Listen ObjMgr-Events

ObjMgr-Key	Value	Action
ObjID Global ObjectType	Source	and
ObjID Image ImageType	Original	if so, the field parentID is updated

Send ObjMgr-Events

ObjMgr-Key	Value	Action
ObjID Global ObjectType	Result	Is always a resulting image
ObjID Global ChildIds	-	No children yet
ObjID Global ParentId		Object ID of the parent image
ObjID Global Valid	True	Is always true
ObjID Image Filename		Name of the file (ROIType ownImage or not set)
ObjID Image StartVoxel		Starting voxel (ROIType subregion or not set)
ObjID Image EndVoxel		Ending voxel (ROIType subregion or not set)
ObjID Image ImageType	Original	Is still an original
ObjID Image ObjectValue	-1	Has no specific value
ObjID Image ToWorldMatrix		Transformation matrix
ObjID Image SizeX		Number of voxel in X direction
ObjID Image SizeY
ObjID Image SizeZ

Inputs and Outputs

image:	Input image for retrieving name, location, size and DICOM tags

Fields

objectID: (string)	Name of the created Object
parentID: (string)	Available parent IDs
ROIType: (string)	Subregion or OwnImage (see Send ObjMgr-Events)
filename: (string)	Depends on ROIType, name of the resulting file
suffix: (string)	Depends on ROIType, name suffix of the resulting file
startVoxel: (int)	Depends on ROIType, clamps the input image
endVoxel: (int)	Depends on ROIType, clamps the input image
create: (trigger)	Create all entries

Related modules

METKManager, METKAddImage, METKAddStructure