WindowFunctions.FlatTop Method

Definition

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

Overload List

FlatTop(Int32) Returns a symmetric flat top window of the specified length.
FlatTop(Int32, WindowSampling) Returns a flat top window of the specified length and symmetry.

FlatTop(Int32)

Returns a symmetric flat top window of the specified length.
C#
public static WindowFunction FlatTop(
	int length
)

Parameters

length  Int32
The length of the window.

Return Value

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

FlatTop(Int32, WindowSampling)

Returns a flat top window of the specified length and symmetry.
C#
public static WindowFunction FlatTop(
	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 flat top 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