| genre | Diagram |
| status | stable |
| author | Tobias Boskamp |
| package | MeVisLab/Standard |
| dll | MLCurve |
| definition | MLCurve.def |
| see also | Diagram2D, ConcatenateCurves |
| keywords | Diagram, curve, value, pick, select, display, cursor, coordinate |
The module CurveCursor picks a data value from a curve at a given position and/or displays a graphical cursor above a ml::CurveData or a ml::CurveList.
The CurveCursor module accepts a ml::CurveData or ml::CurveList object at its inCurveList field and displays the curve data value of a selected curve series at a given position specified as Position X.
In addition, it adds a curve cursor, consisting of a vertical line at the x-position and/or a horizontal line at the y-position, to the input curves. The resulting CurveList object is available at the outCurveList field.
If no input curves are present, the only valid value for Series Index is -1 and the output curve list contains nothing but the curve cursor.
In this situation, the size of the vertical and horizontal cursor indicators has to be explicitly specified in the fields Range X: Min, Max, Range Y: Min, and Max. As soon as input curves are present, these fields reflect the x/y range as obtained from the input curves.
| autoPosY: Bool | maxSeriesIndex: Integer |
| autoRange: Bool | Position X: Float |
| Cursor X: Bool | Position Y: Float |
| Cursor Y: Bool | Range X: Min: Float |
| Curve Style: Integer | Range Y: Min: Float |
| Interpolate: Bool | Series Index: Integer |
| Max (maxX): Float | |
| Max (maxY): Float |
Sets the x-position at which the selected curve data is evaluated.
Sets the value of the specified curve series at the Position X.
Sets the index of the curve series to be used.
Numbering starts with 0 for the first series in the first input curve. If the Series Index is set to -1, the Position Y is not taken from a curve series but can be specified manually instead. This can be used to display a curve cursor that is not restricted to points on a curve.
If checked, the curve data value is interpolated between adjacent data points, otherwise the value of the nearest data point is used.
Sets the x-range of the horizontal cursor if no input curve is present.
Sets the x-maximum of the horizontal cursor if no input curve is present.
Sets the y-range of the vertical cursor if no input curve is present.
Sets the y-maximum of the vertical cursor if no input curve is present.
Sets the style to be used for drawing the cursor.
Its value is an index into a StylePalette. If the Curve Style is set to 0, and if a StylePalette is used, the styles for the curve cursor is chosen automatically.
If both Cursor X and Cursor Y are enabled, this may result in a curve cursor displayed in two different styles, because the vertical and the horizontal indicator of the curve cursor are represented as two distinct curve objects in the output curve list.