PathToKeyFrame¶

MLModule¶

genre	`Resample`
status	`stable`
author	`Florian Link`
package	`MeVisLab/Standard`
dll	`MLResample1`
definition	MLResample1.def
see also	`MPRPath`
keywords	`Path`, `Marker`, `KeyFrameList`, `Curved`, `MPR`

Purpose¶

The module PathToKeyFrame accepts a list of marker positions (an object of type ml::XMarkerList or ml::Vec3fList) and generates a key frame list, i.e. a sequence of positions and viewing orientations.

The generated key frame list is typically used by an MPRPath module to create curved MPR views.

Usage¶

Connect a marker list (e.g. from a SoView2DMarkerEditor module) to the input node and connect the output node to an MPRPath module.

Windows¶

Default Panel¶

../../../Modules/ML/MLResample1/mhelp/Images/Screenshots/PathToKeyFrame._default.png

Input Fields¶

inputKeys¶

name: inputKeys, type: MLBase¶: An object of type ml::XMarkerList or ml::Vec3fList is expected at the input node. For compatibility to older modules, ml::PointList objects are also supported.

Output Fields¶

outputKeys¶

name: outputKeys, type: MLBase¶: The output holds a ml::KeyFrameList object.

Parameter Fields¶

Field Index¶

`Allow Reverse View`: `Bool`	`Num Output Keys`: `Integer`	`Resolution`: `Float`
`Angle`: `Float`	`Path Length`: `Float`	`Smoothing`: `Integer`
`Auto path direction`: `Bool`	`Path Shift`: `Vector3`
`Direction`: `Vector3`	`Pos. Relative (pathPositionRelative)`: `Float`
`Input Path Length`: `Float`	`Pos. Relative (inputPathPositionRelative)`: `Float`
`Latitude`: `Float`	`Pos. World (pathPositionWorld)`: `Vector3`
`Longitude`: `Float`	`Pos. World (inputPathPositionWorld)`: `Vector3`
`Max. Distance`: `Float`	`Projection Mode`: `Enum`

Visible Fields¶

Smoothing¶

name: numSmoothes, type: Integer, default: 8, minimum: 0, maximum: 20¶

Sets the number of smoothing steps.

The smoothing is performed by iterative convolution with a 1-2-1 filter. A value of zero disables smoothing.

Resolution¶

name: outputResolution, type: Float, default: 0¶

Sets the sampling resolution of the generated key frame list.

It is specified as the distance in millimeters between two consecutive positions. If the resolution is set to zero, resampling is disabled.

Auto path direction¶

name: autoPathDir, type: Bool, default: FALSE¶: If checked, a path mainly orientated towards negative z direction is automatically reversed.

Allow Reverse View¶

name: allowReverseView, type: Bool, default: FALSE¶

If checked, the selection of the viewing orientation tries to generate views as closest as possible to one of the standard radiological viewing directions (axial, coronal, sagittal).

If Allow Reverse View is enabled, this may result in 'backward' viewing directions, i.e. views towards the reverse path direction.

Num Output Keys¶

name: numOutputKeys, type: Integer, default: 0¶: Shwos the number of key frames in the output key frame path.

Path Length¶

name: pathLength, type: Float, default: 0¶: Shows the total length of the output key frame path.

Path Shift¶

name: pathShift, type: Vector3, default: 0 0 0¶: Sets a translation vector to shift the output key frame path.

Projection Mode¶

name: projectionMode, type: Enum, default: Off, deprecated name: projectUpVectors¶: Defines the projection mode.

Values:

Title Name Deprecated Name Description

Off Off FALSE Projection of key frame positions and orientation is disabled.

Path Projection

PathProjection

The path is projected on a plane centered about the average path axis.

The projection takes place before the resampling step in order to achieve the desired path resolution.

The parameters Angle and Max. Distance influence the outcome if this option is chosen.

View Projection

ViewProjection

The key frame up-vectors are projected on a common viewing direction that can be specified either as a direction vector or by two angles.

The parameters Direction, Latitude, and Longitude influence the outcome if this option is chosen.

Direction¶

name: viewDir, type: Vector3, default: 0 1 0¶: Sets the viewing direction as a vector.

Latitude¶

name: viewLatitude, type: Float, default: 0, minimum: -90, maximum: 90¶: Sets the viewing direction as a latitude angle.

Longitude¶

name: viewLongitude, type: Float, default: 0, minimum: -180, maximum: 180¶: Sets the viewing direction as a longtitude angle.

Angle¶

name: projectPathAngle, type: Float, default: 0, minimum: 0, maximum: 360¶: Sets the rotation angle of the projection plane about the average path axis.

Max. Distance¶

name: maxProjectionDistance, type: Float, default: 0¶

Sets the maximum distance of a path point to the average path axis.

This value is useful to specify the field of view necessary for a single-curved MPR.

Pos. World (pathPositionWorld)¶

name: pathPositionWorld, type: Vector3, default: 0 0 0¶: Shows a position of the output path depending on the relative parameter Pos. Relative.

Pos. Relative (pathPositionRelative)¶

name: pathPositionRelative, type: Float, default: 0, minimum: 0, maximum: 1¶: Sets the relative 'index' into the output path to display the Pos. World.

Pos. World (inputPathPositionWorld)¶

name: inputPathPositionWorld, type: Vector3, default: 0 0 0¶: Shows a position of the input path depending on the relative parameter Pos. Relative.

Pos. Relative (inputPathPositionRelative)¶

name: inputPathPositionRelative, type: Float, default: 0, minimum: 0, maximum: 1¶: Sets the relative 'index' into the input path to display the Pos. World.

Input Path Length¶

name: inputPathLength, type: Float, default: 0¶: Shows the length of the input path.

Navigation