DistanceFromXMarkerList

MLModule

genre	Marker
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLDTF
definition	MLDTF.def
see also	EuclideanDistanceTransform, XMarkerListContainer
keywords	Distance

Purpose

The module DistanceFromXMarkerList calculates the distances between a provided spatial Position and the positions of the points of the inputXMarkerList.

It returns the index, along with the squared and Euclidean distances, of the nearest and farthest XMarker from the list.

Windows

Default Panel

Input Fields

inputXMarkerList

name: inputXMarkerList, type: XMarkerList(MLBase)

The list of markers.

For accessing this object via scripting, see the Scripting Reference: MLXMarkerListWrapper.

Parameter Fields

Field Index

Calculate Distance: Trigger

Euclidean Distance (minimumEuclideanDistance): Double

Euclidean Distance (maximumEuclideanDistance): Double

Index (indexMinimum): Integer

Index (indexMaximum): Integer

Position: Vector3

Squared Distance (minimumSquaredDistance): Double

Squared Distance (maximumSquaredDistance): Double

Visible Fields

Position

name: position, type: Vector3, default: 0 0 0, deprecated name: Position

Sets a position to which the shortest distance to all XMarkers is calculated.

Squared Distance (minimumSquaredDistance)

name: minimumSquaredDistance, type: Double, persistent: no, deprecated name: Distance

Shows the squared distance from the nearest XMarker to the Position.

Is set to -1 if inputXMarkerList is empty or not connected.

Euclidean Distance (minimumEuclideanDistance)

name: minimumEuclideanDistance, type: Double, persistent: no

Shows the Euclidean distance from the nearest XMarker to the Position.

Is set to -1 if inputXMarkerList is empty or not connected.

Index (indexMinimum)

name: indexMinimum, type: Integer, persistent: no, deprecated name: Idx

Shows the index of the XMarker that is nearest to the Position.

Is set to -1 if inputXMarkerList is empty or not connected.

Squared Distance (maximumSquaredDistance)

name: maximumSquaredDistance, type: Double, persistent: no, deprecated name: maximumDistance

Shows the squared distance from the farthest XMarker to the Position.

Is set to -1 if inputXMarkerList is empty or not connected.

Euclidean Distance (maximumEuclideanDistance)

name: maximumEuclideanDistance, type: Double, persistent: no

Shows the Euclidean distance from the farthest XMarker to the Position.

Is set to -1 if inputXMarkerList is empty or not connected.

Index (indexMaximum)

name: indexMaximum, type: Integer, persistent: no, deprecated name: IdxMax

Shows the index of the XMarker that is farthest to the Position.

Is set to -1 if inputXMarkerList is empty or not connected.

Calculate Distance

name: calculateDistance, type: Trigger, deprecated name: CalcDistance

When pressed, the module calculates anew.