Operator Reference

smooth_funct_1d_gaussT_smooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGausssmooth_funct_1d_gauss (Operator)

smooth_funct_1d_gaussT_smooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGausssmooth_funct_1d_gauss — Smooth an equidistant 1D function with a Gaussian function.

Signature

smooth_funct_1d_gauss( : : Function, Sigma : SmoothedFunction)

Herror T_smooth_funct_1d_gauss(const Htuple Function, const Htuple Sigma, Htuple* SmoothedFunction)

void SmoothFunct1dGauss(const HTuple& Function, const HTuple& Sigma, HTuple* SmoothedFunction)

HFunction1D HFunction1D::SmoothFunct1dGauss(double Sigma) const

static void HOperatorSet.SmoothFunct1dGauss(HTuple function, HTuple sigma, out HTuple smoothedFunction)

HFunction1D HFunction1D.SmoothFunct1dGauss(double sigma)

def smooth_funct_1d_gauss(function: Sequence[Union[float, int]], sigma: float) -> Sequence[Union[float, int]]

Description

The operator smooth_funct_1d_gausssmooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGausssmooth_funct_1d_gauss smooths a one-dimensional function with a Gaussian function. 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.

Note that the smoothing parameter SigmaSigmaSigmasigmasigma must not be larger than , with being the number of control points of FunctionFunctionFunctionfunctionfunction and specifying the equidistance of the x values. The value of LengthLengthLengthlengthlength can, e.g., be determined with num_points_funct_1dnum_points_funct_1dNumPointsFunct1dNumPointsFunct1dnum_points_funct_1d.

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, HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Function to be smoothed.

SigmaSigmaSigmasigmasigma (input_control)  number HTuplefloatHTupleHtuple (real) (double) (double) (double)

Sigma of the Gaussian function for the smoothing.

Default: 2.0

Suggested values: 0.5, 1.0, 2.0, 3.0, 4.0, 5.0

Value range: 0.1 ≤ Sigma Sigma Sigma sigma sigma ≤ 50.0 (lin)

Minimum increment: 0.01

Recommended increment: 0.2

SmoothedFunctionSmoothedFunctionSmoothedFunctionsmoothedFunctionsmoothed_function (output_control)  function_1d HFunction1D, HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Smoothed function.

Possible Predecessors

create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArraycreate_funct_1d_array, sample_funct_1dsample_funct_1dSampleFunct1dSampleFunct1dsample_funct_1d

Possible Successors

match_funct_1d_transmatch_funct_1d_transMatchFunct1dTransMatchFunct1dTransmatch_funct_1d_trans, distance_funct_1ddistance_funct_1dDistanceFunct1dDistanceFunct1ddistance_funct_1d

Alternatives

smooth_funct_1d_meansmooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMeansmooth_funct_1d_mean

Module

Foundation