Skip to content

smooth_funct_1d_gausssmooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGausssmooth_funct_1d_gaussT_smooth_funct_1d_gauss🔗

Short description🔗

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

Signature🔗

smooth_funct_1d_gauss( function_1d Function, number Sigma, out function_1d SmoothedFunction )smooth_funct_1d_gauss( : : Function, Sigma : SmoothedFunction )void SmoothFunct1dGauss( const HTuple& Function, const HTuple& Sigma, HTuple* SmoothedFunction )static void HOperatorSet.SmoothFunct1dGauss( HTuple function, HTuple sigma, out HTuple smoothedFunction )def smooth_funct_1d_gauss( function: Sequence[Union[float, int]], sigma: float ) -> Sequence[Union[float, int]]

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

HFunction1D HFunction1D::SmoothFunct1dGauss( double Sigma ) const

HFunction1D HFunction1D.SmoothFunct1dGauss( double sigma )

Description🔗

The operator smooth_funct_1d_gaussSmoothFunct1dGauss smooths a one-dimensional function with a Gaussian function. The function must be equidistant, i.e., created with create_funct_1d_arrayCreateFunct1dArray, sample_funct_1dSampleFunct1d or similar. At the function borders the function values are mirrored.

Note that the smoothing parameter Sigmasigmasigma must not be larger than \((\textrm{Length}-2) / 7.8 * \textrm{Function}[1]\), with \(\textrm{Length}-2\) being the number of control points of Functionfunctionfunction and \(\textrm{Function}[1]\) specifying the equidistance of the x values. The value of Lengthlengthlength can, e.g., be determined with num_points_funct_1dNumPointsFunct1d.

Execution information🔗

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🔗

Functionfunctionfunction (input_control) function_1d → (real / integer)(real / integer)HTuple (double / Hlong)HFunction1D, HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)

Function to be smoothed.

Sigmasigmasigma (input_control) number → (real)(real)HTuple (double)HTuple (double)floatHtuple (double)

Sigma of the Gaussian function for the smoothing.

Default: 2.02.0
Suggested values: 0.5, 1.0, 2.0, 3.0, 4.0, 5.00.5, 1.0, 2.0, 3.0, 4.0, 5.0
Value range: 0.1 ≤ Sigma ≤ 50.0 (lin)
Minimum increment: 0.01
Recommended increment: 0.2

SmoothedFunctionsmoothedFunctionsmoothed_function (output_control) function_1d → (real / integer)(real / integer)HTuple (double / Hlong)HFunction1D, HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)

Smoothed function.

Combinations with other operators🔗

Combinations

Possible predecessors

create_funct_1d_arrayCreateFunct1dArray, sample_funct_1dSampleFunct1d

Possible successors

match_funct_1d_transMatchFunct1dTrans, distance_funct_1dDistanceFunct1d

Alternatives

smooth_funct_1d_meanSmoothFunct1dMean

Module🔗

Foundation