WindowFunctions.Gaussian Method

Definition

Namespace: Numerics.NET.SignalProcessing
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3

Overload List

Gaussian(Int32, Double) Returns a Gaussian window of the specified length.
Gaussian(Int32, Double, WindowSampling) Returns a Gaussian window of the specified length and symmetry.

Gaussian(Int32, Double)

Returns a Gaussian window of the specified length.
C#
public static WindowFunction Gaussian(
	int length,
	double standardDeviation
)

Parameters

length  Int32
The length of the window.
standardDeviation  Double
The standard deviation of the bell curve. Must be less than or equal to 0.5.

Return Value

WindowFunction
A WindowFunction that represents a Gaussian window with a length of length, normalized so the largest value is 1.

Remarks

If the window length is even, the maximum value of 1 may not appear.

Exceptions

ArgumentOutOfRangeException

length is less than or equal to zero.

-or-

standardDeviation is less than zero or greater than 0.5.

Gaussian(Int32, Double, WindowSampling)

Returns a Gaussian window of the specified length and symmetry.
C#
public static WindowFunction Gaussian(
	int length,
	double standardDeviation,
	WindowSampling sampling
)

Parameters

length  Int32
The length of the window.
standardDeviation  Double
The standard deviation of the bell curve. Must be less than or equal to 0.5.
sampling  WindowSampling
A WindowSampling value that indicates whether the filter is symmetrical or periodic.

Return Value

WindowFunction
A WindowFunction that represents a Gaussian window with a length of length, normalized so the largest value is 1.

Remarks

If the window is symmetrical and the length is even, the maximum value of 1 may not appear.

Exceptions

ArgumentOutOfRangeException

length is less than or equal to zero.

-or-

standardDeviation is less than zero or greater than 0.5.

See Also