CurveFilter

MLModule

genre	Diagram
authors	Caroline Kuehnel, Tobias Block, Volker Dicken
package	FMEstable/ReleaseMeVis
dll	MLCurveUtils
definition	MLCurveUtils.def
see also	CurveGenerator, SoDiagram2D, CurveBypass, CurveProperties, CurveListConvert
keywords	curve, diagram, filter, base, parser, differentiate, integrate, smooth, median, average, min, max, quantile, histogram, DVH, dose, volume, histogram

Purpose

The module CurveFilter filters an input Curve by some criteria and generates a filtered copy as output.

Windows

Default Panel

Input Fields

inCurves

name: inCurves, type: MLBase

The input defines the input curve(s).

Use CurveGenerator and affiliated modules like ConcatenateCurve, CurveProperties, etc. for input.

Output Fields

outCurves

name: outCurves, type: MLBase

Filtered result curve(s).

Parameter Fields

Field Index

a =: Double	Data To Process: Enum	outOfRangeTreatment: Enum
Average Of Parameter: Double	End Index: Integer	Percentage[%]: Double
b =: Double	Error: String	Process only limited interval: Bool
Bin Size: Double	Expression: String	Start Index: Integer
c =: Double	Filter Mode: Enum	StdDev Of Parameter: Double
Constant Value: Double	Interpolation Mode: Enum	Step: Double
correctInvalidInterval: Bool	Model Fitting Rel Center Of Drop Points: Bool	Strength: Integer
d =: Double	Num. Points: Integer	Use Step Function: Bool

Visible Fields

Filter Mode

name: filterMode, type: Enum, default: Off

Defines the filter operation.

Values:

Title	Name
Off	Off
Math. expression	Math. expression
Smooth	Smooth
Differentiate	Differentiate
Integrate	Integrate
Average	Average
Std Dev	StdDev
Median	Median
Resample	Resample
Max	Max
Min	Min
Quantile	Quantile
Cumulated Histogram	CumulatedHistogram
Inverse Cum Histogram	InverseCumHistogram
Max Pos	MaxPos
Mean Pos	MeanPos
Lower Drop Point	LowerDropPoint
Upper Drop Point	UpperDropPoint
Center Of Drop Points	CenterOfDropPoints
Width At Drop Points	WidthAtDropPoints
Normalized Integral Curve	NormalizedIntegralCurve
Normalized Height Curve	NormalizedHeightCurve
Hist Average	HistAverage
Hist Std Dev	HistStdDev
Curvature	Curvature
Histogram Bins	HistogramBins
Zero Of Lower Tangent	ZeroOfLowerTangent
Zero Of Upper Tangent	ZeroOfUpperTangent
Zero Of Lower Secant	ZeroOfLowerSecant
Zero Of Upper Secant	ZeroOfUpperSecant
Lower Next Local Min	LowerNextLocalMin
Upper Next Local Min	UpperNextLocalMin
Zero Of Lower Parabola Fit	ZeroOfLowerParabolaFit
Zero Of Upper Parabola Fit	ZeroOfUpperParabolaFit
Count Non Zero Points	CountNonZeroPoints
Max Non Zero Point	MaxNonZeroPoint
Min Non Zero Point	MinNonZeroPoint
Center Of Non Zero Range	CenterOfNonZeroRange
Width Of Non Zero Range	WidthOfNonZeroRange

Interpolation Mode

name: interpolationMode, type: Enum, default: CubicSpline

Defines the interpolation mode if the Filter Mode is Resample.

Values:

Title	Name
Constant	Constant
Linear	Linear
Quadratic	Quadratic
Cubic Spline	CubicSpline
Pw Cubic Hemite	PwCubicHemite
Centered Cubic	CenteredCubic

Process only limited interval

name: onlyProcessMarkedInterval, type: Bool, default: FALSE

If checked, only a specific interval of the selected curves are filtered.

Start Index

name: markerStart, type: Integer, default: 0

Sets the start index of the interval of curves to be filtered.

End Index

name: markerEnd, type: Integer, default: 0

Sets the end index of the interval of curves to be filtered.

Expression

name: parserExpression, type: String, default: x^2+2*x

Sets a mathematical expression for the Filter Mode Math. expression.

Data To Process

name: parserData, type: Enum, default: Y-Data

Defines in which dimension the data should be processed.

Values:

Title	Name
X-Data	X-Data
Y-Data	Y-Data
XY-Data	XY-Data

Error

name: parserErrorText, type: String

Shows an error message of the function parser.

a =

name: parserExtValueA, type: Double, default: 0

Sets one of four variables for use in the expression.

b =

name: parserExtValueB, type: Double, default: 0

Sets one of four variables for use in the expression.

c =

name: parserExtValueC, type: Double, default: 0

Sets one of four variables for use in the expression.

d =

name: parserExtValueD, type: Double, default: 0

Sets one of four variables for use in the expression.

Strength

name: smoothingStrength, type: Integer, default: 10

Smoothing over that many curve points / distance (in # points) to take secants in curvature mode) (CAVE: not then window width in X range, if x step != 1)

Num. Points

name: numResamplePoints, type: Integer, default: 10

Sets the number of target re-sample points.

Step

name: resampleInterval, type: Double, default: 1

Sets the step width for re-sampling.

Percentage[%]

name: percentage, type: Double, default: 50, minimum: 0, maximum: 100, deprecated name: quantilePercent

Percentage values used e.g. for drop points and quantile

Constant Value

name: constCurveParam, type: Double, default: 0

Value for first curve in list

Average Of Parameter

name: averageOfParameter, type: Double, default: 0

Average over curve parameters over all curves in list

StdDev Of Parameter

name: stdDevOfParameter, type: Double, default: 0

StdDev over curve parameters over all curves in list

Bin Size

name: histogramBinSize, type: Double, default: 1, minimum: 0.001

Resample curve so it collects values into bins of this size

Use Step Function

name: useStepFunction, type: Bool, default: TRUE

Draw histogram curve as a bar plot

Model Fitting Rel Center Of Drop Points

name: ModelFittingRelCenterOfDropPoints, type: Bool, default: FALSE

Select if true max or center or max value at drop points si used for model fitting

Hidden Fields

outOfRangeTreatment

name: outOfRangeTreatment, type: Enum, default: Copy

Values:

Title	Name
Copy	Copy
Fill Zeros	FillZeros
Fill Curve Min	FillCurveMin
Fill Curve Max	FillCurveMax
Fill Const Curve Value	FillConstCurveValue
Fill Range End Values	FillRangeEndValues

correctInvalidInterval

name: correctInvalidInterval, type: Bool, default: TRUE