XMarkerListContainer¶
-
MLModule
¶ genre Marker
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLBase
definition MLBase.def see also SoView2DMarkerEditor
keywords Vector
,ListBase
Purpose¶
The module XMarkerListContainer
stores a list of ml.XMarker
objects as a ml.XMarkerList
object and makes it available at its outXMarkerList
field. The contents of this marker list can be displayed, edited, and saved in a persistent state.
Usage¶
The XMarkerListContainer
controls either an internal ml.XMarkerList
object or an external object connected at the inXMarkerList
field. It allows for adding, deleting and modifying entries in the XMarkerList.
If an external XMarkerList is connected, the XMarkerListContainer
acts as an inspector for the external object, i.e., it displays the contents of the external XMarkerList and the internal list object is hidden. If the inXMarkerList
field is connected to an object which is no XMarkerList, all display and edit functions are disabled.
Details¶
A ml.XMarkerList
object contains a number of XMarker list elements. An XMarker object consists of a 6D position, a 3D vector, a type, a name, and an
Item ID property. The vector is interpreted relative to the marker position, hence if the vector equals (0, 0, 0), the marker is a point marker. The type is an arbitrary integer value, which can be used to distinguish between markers with different meaning (e.g., include and exclude marker in a segmentation application). The ID of an XMarker list element is unique within a list and is left unchanged even if list elements are inserted or deleted. The ID can hence be used as a reference to a list element.
In addition to the XMarker list elements, an ml.XMarkerList
contains a description of the last action performed on the list (see the description of the field Action below). This can be used by modules attached to a XMarkerList object to synchronize themselves with operations performed on the list by some other module.
Interaction¶
The module’s control panel offers the possibility to add empty or filled XMarker items. To add filled items, Add/Insert from Template has to be checked. In this case, the values of the Template Item are used.
Furthermore, the modification of existing items is possible. This can be done by selecting an item via the field Item Index and editing the properties of the Current Item. The new property values are passed to the list item when the focus leaves the edit control.
Input Fields¶
Output Fields¶
outXMarkerList¶
-
name:
outXMarkerList
, type:
XMarkerList(MLBase)
, deprecated name:
outputXMarkerList
¶ The XMarkerList controlled by this module is presented at this field.
For accessing this object via scripting see the Scripting Reference:MLXMarkerListWrapper
.
Parameter Fields¶
The XMarkerItems section contains additional fields to display and edit the Position, Vector, Type, and Name properties of the current marker. The Name property can be used as a label for individual markers.