WindowFunctions.Hanning Method

Definition

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

Overload List

Hanning(Int32) Returns a Hann window of the specified length .
Obsolete.
Hanning(Int32, WindowSampling) Returns a Hanning window of the specified length and symmetry.
Obsolete.

Hanning(Int32)

Note: This API is now obsolete.
Returns a Hann window of the specified length .
C# 
[ObsoleteAttribute("Use the Hann method instead.")]
public static WindowFunction Hanning(
	int length
)

Parameters

length  Int32
The length of the window.

Return Value

WindowFunction
A WindowFunction that represents a Hanning 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.

Hanning(Int32, WindowSampling)

Note: This API is now obsolete.
Returns a Hanning window of the specified length and symmetry.
C# 
[ObsoleteAttribute("Use the Hann method instead.")]
public static WindowFunction Hanning(
	int length,
	WindowSampling sampling
)

Parameters

length  Int32
The length of the window.
sampling  WindowSampling
A WindowSampling value that indicates whether the filter is symmetrical or periodic.

Return Value

WindowFunction
A WindowFunction that represents a Hanning 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.

See Also