WindowFunctions.Tukey Method

Definition

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

Overload List

Tukey(Int32, Double) Returns a Tukey window with the specified length.
Tukey(Int32, WindowSampling, Double) Returns a Tukey window with the specified length and symmetry.
Tukey<T>(Int32, T) Returns a Tukey window with the specified length.
Tukey<T>(Int32, WindowSampling, T) Returns a Tukey window with the specified length and symmetry.

Tukey(Int32, Double)

Returns a Tukey window with the specified length.
C# 
public static WindowFunction Tukey(
	int length,
	double ratio
)

Parameters

length  Int32
The length of the window.
ratio  Double
The ratio of the tapered section to the constant section.

Return Value

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

ratio is less than or equal to zero.

Tukey<T>(Int32, T)

Returns a Tukey window with the specified length.
C# 
public static WindowFunction<T> Tukey<T>(
	int length,
	T ratio
)

Parameters

length  Int32
The length of the window.
ratio  T
The ratio of the tapered section to the constant section.

Type Parameters

T

Return Value

WindowFunction<T>
A WindowFunction<T> that represents a Blackman 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-

ratio is less than or equal to zero.

Tukey(Int32, WindowSampling, Double)

Returns a Tukey window with the specified length and symmetry.
C# 
public static WindowFunction Tukey(
	int length,
	WindowSampling sampling,
	double ratio
)

Parameters

length  Int32
The length of the window.
sampling  WindowSampling
A WindowSampling value that indicates whether the filter is symmetrical or periodic.
ratio  Double
The ratio of the tapered section to the constant section.

Return Value

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

Tukey<T>(Int32, WindowSampling, T)

Returns a Tukey window with the specified length and symmetry.
C# 
public static WindowFunction<T> Tukey<T>(
	int length,
	WindowSampling sampling,
	T ratio
)

Parameters

length  Int32
The length of the window.
sampling  WindowSampling
A WindowSampling value that indicates whether the filter is symmetrical or periodic.
ratio  T
The ratio of the tapered section to the constant section.

Type Parameters

T

Return Value

WindowFunction<T>
A WindowFunction<T> that represents a Blackman 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