ClassesClasses | | Operators

smooth_funct_1d_meanT_smooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMean (Operator)

Name

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

Signature

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

Herror T_smooth_funct_1d_mean(const Htuple Function, const Htuple SmoothSize, const Htuple Iterations, Htuple* SmoothedFunction)

void SmoothFunct1dMean(const HTuple& Function, const HTuple& SmoothSize, const HTuple& Iterations, HTuple* SmoothedFunction)

HFunction1D HFunction1D::SmoothFunct1dMean(Hlong SmoothSize, Hlong Iterations) const

static void HOperatorSet.SmoothFunct1dMean(HTuple function, HTuple smoothSize, HTuple iterations, out HTuple smoothedFunction)

HFunction1D HFunction1D.SmoothFunct1dMean(int smoothSize, int iterations)

Description

The operator smooth_funct_1d_meansmooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMeanSmoothFunct1dMean 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_arrayCreateFunct1dArrayCreateFunct1dArrayCreateFunct1dArray, sample_funct_1dsample_funct_1dSampleFunct1dSampleFunct1dSampleFunct1d or similar. At the function borders the function values are mirrored.

Attention

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

Execution Information

Parameters

FunctionFunctionFunctionFunctionfunction (input_control)  function_1d HFunction1D, HTupleHTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

1D function.

SmoothSizeSmoothSizeSmoothSizeSmoothSizesmoothSize (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Size of the averaging mask.

Default value: 9

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

Typical range of values: 1 ≤ SmoothSize SmoothSize SmoothSize SmoothSize smoothSize ≤ 1001 (lin)

Minimum increment: 1

Recommended increment: 2

Restriction: SmoothSize > 0

IterationsIterationsIterationsIterationsiterations (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of iterations for the smoothing.

Default value: 3

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

Typical range of values: 1 ≤ Iterations Iterations Iterations Iterations iterations ≤ 100 (lin)

Minimum increment: 1

Recommended increment: 1

Restriction: Iterations >= 1

SmoothedFunctionSmoothedFunctionSmoothedFunctionSmoothedFunctionsmoothedFunction (output_control)  function_1d HFunction1D, HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Smoothed function.

Possible Predecessors

create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArrayCreateFunct1dArray, sample_funct_1dsample_funct_1dSampleFunct1dSampleFunct1dSampleFunct1d

Alternatives

smooth_funct_1d_gausssmooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGaussSmoothFunct1dGauss

Module

Foundation


ClassesClasses | | Operators