Scalar3D.filter_gauss

Scalar3D.filter_gauss(self, delta,n_cut=0,mute=False):


Description

Filters the scalar field with a Gaussian function.

The variance sigma is considered equal to:

σ=112Δ2\sigma = \sqrt{\frac{1}{12} \cdot \Delta^2}

where delta is the amplitude of the Gaussian filter.

Parameters

  • delta (float): The amplitude of the Gaussian filter.

  • n_cut (int, optional): The number of samples to cut at the extrema. Default is 0.

  • mute (bool, optional): A flag indicating whether to mute the output. Default is False.

Returns

  • array-like: The filtered scalar field.

Last updated