smooth_funct_1d_meanT_smooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMeansmooth_funct_1d_mean (Operator)

Name

smooth_funct_1d_meanT_smooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMeansmooth_funct_1d_mean — Smooth an equidistant 1D function by averaging its values.

Signature

smooth_funct_1d_mean( : : Function, SmoothSize, Iterations : SmoothedFunction)

Description

The operator smooth_funct_1d_meansmooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMeansmooth_funct_1d_mean smooths a one dimensional function by applying an average (mean) filter multiple times. The function must be equidistant, i.e., created with create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArraycreate_funct_1d_array, sample_funct_1dsample_funct_1dSampleFunct1dSampleFunct1dsample_funct_1d or similar. At the function borders the function values are mirrored.

Attention

If an even value instead of an odd value is given for SmoothSizeSmoothSizeSmoothSizesmoothSizesmooth_size, the routine uses the next larger odd value instead (this way the center of the filter mask is always explicitly determined).

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

FunctionFunctionFunctionfunctionfunction (input_control) function_1d → (integer / real)

1D function.

SmoothSizeSmoothSizeSmoothSizesmoothSizesmooth_size (input_control) integer → (integer)

Size of the averaging mask.

Default: 9

Suggested values: 1, 3, 5, 7, 9, 11, 13, 15, 21, 31, 51

Value range: 0 ≤ SmoothSize SmoothSize SmoothSize smoothSize smooth_size ≤ 1001 (lin)

Minimum increment: 1

Recommended increment: 2

IterationsIterationsIterationsiterationsiterations (input_control) integer → (integer)

Number of iterations for the smoothing.

Default: 3

Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9

Value range: 1 ≤ Iterations Iterations Iterations iterations iterations ≤ 100 (lin)

Minimum increment: 1

Recommended increment: 1

SmoothedFunctionSmoothedFunctionSmoothedFunctionsmoothedFunctionsmoothed_function (output_control) function_1d → (real / integer)

Smoothed function.

Possible Predecessors

create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArraycreate_funct_1d_array, sample_funct_1dsample_funct_1dSampleFunct1dSampleFunct1dsample_funct_1d

Alternatives

smooth_funct_1d_gausssmooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGausssmooth_funct_1d_gauss

Module

Foundation

Operators