ProfileCurve

MLModule
genre Diagram
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLCurve
definition MLCurve.def
see also SoDiagram2D, DynaCurve
keywords Diagram

Purpose

The module ProfileCurve extracts a profile curve from an image along any data dimension.

Usage

The ProfileCurve module reads voxel values from its input image at positions along a specified half-ray and creates a ml.CurveData object from these values.

The curve data is available at the outCurve field, which can be connected, e.g., to a SoDiagram2D module.

Windows

Default Panel

../../../Modules/ML/MLCurve/mhelp/Images/Screenshots/ProfileCurve._default.png

Input Fields

input0

name: input0, type: Image

The input image from which the voxel values are extracted.

Output Fields

outCurve

name: outCurve, type: CurveData(MLBase), deprecated name: outputCurveData

The output field provides a CurveData object containing the image voxel values along the profile line.

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

Parameter Fields

Field Index

Axis: Enum Use image min/max values for y-range: Bool
C: Integer X: Integer
Curve Style: Integer X Coords: Enum
Enable: Bool Y: Integer
Length: Integer Z: Integer
Reference Position: Integer  
T: Integer  
U: Integer  

Visible Fields

Axis

name: axis, type: Enum, default: X

Defines the dimension along which the profile should be extracted.

Positions outside the current image size are padded with zero.

Values:

Title Name
X X
Y Y
Z Z
C C
T T
U U

X

name: posX, type: Integer, default: 0, deprecated name: XPos

Sets the x-coordinate of the starting point of the half-ray.

Y

name: posY, type: Integer, default: 0, deprecated name: YPos

Sets the y-coordinate of the starting point of the half-ray.

Z

name: posZ, type: Integer, default: 0, deprecated name: ZPos

Sets the z-coordinate of the starting point of the half-ray.

C

name: posC, type: Integer, default: 0, deprecated name: CPos

Sets the c-coordinate of the starting point of the half-ray.

T

name: posT, type: Integer, default: 0, deprecated name: TPos

Sets the t-coordinate of the starting point of the half-ray.

U

name: posU, type: Integer, default: 0, deprecated name: UPos

Sets the u-coordinate of the starting point of the half-ray.

Length

name: length, type: Integer, default: 1

Sets the length of the half-ray, specified in voxel coordinates.

Reference Position

name: referencePosition, type: Integer, default: 0

If a Reference Position is specified and the corresponding Enable is checked, the output curve contains the differences to the value found at the reference position (in voxel coordinates). Otherwise the curve contains absolute image values.

Enable

name: referenceEnable, type: Bool, default: FALSE

Enables the use of a Reference Position. If enabled, the profile line contains the difference values of the read voxels and the voxel value at this position.

Use image min/max values for y-range

name: useImageMinMaxForYRange, type: Bool, default: TRUE

If checked, the y-range of the output curve is set to min/max of the input image. Otherwise, the y-range is set to the current min/max values of the curve.

X Coords

name: xMode, type: Enum, default: None

Defines the X-series data generated for the output curve.

Values:

Title Name Description
None None No X values are generated.
Voxel Voxel The X values represent the positions in voxel coordinates.
World World

The X values represent the positions in world coordinates.

If the curve is generated along the T axis, and if absolute time information is available for the input image, the curve’s X values represent seconds relative to the first time point.

Distance Distance  

Curve Style

name: curveStyle, type: Integer, default: 0

Sets a style index determining the display of the curve.

The curve style corresponding to an index value can be defined in a StylePalette module.