smooth_funct_1d_gaussT_smooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGauss (Operator)
Name
smooth_funct_1d_gaussT_smooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGauss — Smooth an equidistant 1D function with a Gaussian function.
Signature
Description
The operator smooth_funct_1d_gausssmooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGaussSmoothFunct1dGauss smooths a one-dimensional
function with a Gaussian function. 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.
Note that the smoothing parameter SigmaSigmaSigmaSigmasigma must not be larger
than (LengthLengthLengthLengthlength-2)/7.8, with LengthLengthLengthLengthlength being the
number of control points of FunctionFunctionFunctionFunctionfunction. The value of
LengthLengthLengthLengthlength can, e.g., be determined with
num_points_funct_1dnum_points_funct_1dNumPointsFunct1dNumPointsFunct1dNumPointsFunct1d.
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 → HFunction1D, HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Function to be smoothed.
SigmaSigmaSigmaSigmasigma (input_control) number → HTupleHTupleHtuple (real) (double) (double) (double)
Sigma of the Gaussian function for the smoothing.
Default value: 2.0
Suggested values: 0.5, 1.0, 2.0, 3.0, 4.0, 5.0
Typical range of values: 0.1
≤
Sigma
Sigma
Sigma
Sigma
sigma
≤
50.0 (lin)
Minimum increment: 0.01
Recommended increment: 0.2
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
Possible Successors
match_funct_1d_transmatch_funct_1d_transMatchFunct1dTransMatchFunct1dTransMatchFunct1dTrans,
distance_funct_1ddistance_funct_1dDistanceFunct1dDistanceFunct1dDistanceFunct1d
Alternatives
smooth_funct_1d_meansmooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMeanSmoothFunct1dMean
Module
Foundation