Skip to content

smooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMeansmooth_funct_1d_meanT_smooth_funct_1d_mean🔗

Short description🔗

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

Signature🔗

smooth_funct_1d_mean( function_1d Function, integer SmoothSize, integer Iterations, out function_1d SmoothedFunction )void SmoothFunct1dMean( const HTuple& Function, const HTuple& SmoothSize, const HTuple& Iterations, HTuple* SmoothedFunction )static void HOperatorSet.SmoothFunct1dMean( HTuple function, HTuple smoothSize, HTuple iterations, out HTuple smoothedFunction )def smooth_funct_1d_mean( function: Sequence[Union[float, int]], smooth_size: int, iterations: int ) -> Sequence[Union[float, int]]

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

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

HFunction1D HFunction1D.SmoothFunct1dMean( int smoothSize, int iterations )

Description🔗

The operator smooth_funct_1d_meanSmoothFunct1dMean 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_arrayCreateFunct1dArray, sample_funct_1dSampleFunct1d or similar. At the function borders the function values are mirrored.

Attention🔗

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

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 → (integer / real)HTuple (Hlong / double)HFunction1D, HTuple (int / long / double)Sequence[Union[float, int]]Htuple (Hlong / double)

1D function.

SmoothSizesmoothSizesmooth_size (input_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Size of the averaging mask.

Default: 99
Suggested values: 1, 3, 5, 7, 9, 11, 13, 15, 21, 31, 511, 3, 5, 7, 9, 11, 13, 15, 21, 31, 51
Value range: 0 ≤ SmoothSize ≤ 1001 (lin)
Minimum increment: 1
Recommended increment: 2

Iterationsiterationsiterations (input_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of iterations for the smoothing.

Default: 33
Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 91, 2, 3, 4, 5, 6, 7, 8, 9
Value range: 1 ≤ Iterations ≤ 100 (lin)
Minimum increment: 1
Recommended increment: 1

SmoothedFunctionsmoothedFunctionsmoothed_function (output_control) function_1d → (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

Alternatives

smooth_funct_1d_gaussSmoothFunct1dGauss

Module🔗

Foundation