Stats.GetSavitskyGolayCoefficients Method

Definition

Namespace: Extreme.Statistics
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

GetSavitskyGolayCoefficients(Int32) Constructs a vector containing the coefficients of a 2nd degree Savitsky-Golay filter with the specified parameters.
Obsolete.
GetSavitskyGolayCoefficients(Int32, Int32) Constructs a vector containing the coefficients of a Savitsky-Golay filter with the specified span and polynomial degree.
Obsolete.
GetSavitskyGolayCoefficients(Int32, Int32, Int32) Constructs a vector containing the coefficients of a symmetrical Savitsky-Golay filter with the specified parameters.
Obsolete.
GetSavitskyGolayCoefficients(Int32, Int32, Int32, Int32) Constructs a vector containing the coefficients of a Savitsky-Golay filter or a derivative filter with the specified parameters.
Obsolete.

GetSavitskyGolayCoefficients(Int32)

Note: This API is now obsolete.
Constructs a vector containing the coefficients of a 2nd degree Savitsky-Golay filter with the specified parameters.
C#
[ObsoleteAttribute("Use the Extreme.Mathematics.SignalProcessing.Smoothing.GetSavitskyGolayCoefficients method instead.")]
public static Vector<double> GetSavitskyGolayCoefficients(
	int span
)

Parameters

span  Int32
The number of points in the filter.

Return Value

Vector<Double>
A vector that contains the coefficients of the Savitsky-Golay filter.

Remarks

The span must be odd, and must be greater than 2.

The return value of this method can be used to smooth a numerical variable by calling the WeightedMovingAverage(Vector<Double>, Vector<Double>) method of its Filter property.

Exceptions

ArgumentOutOfRangeException

span is less than zero.

ArgumentExceptionspan is less than or equal to 2.

GetSavitskyGolayCoefficients(Int32, Int32)

Note: This API is now obsolete.
Constructs a vector containing the coefficients of a Savitsky-Golay filter with the specified span and polynomial degree.
C#
[ObsoleteAttribute("Use the Extreme.Mathematics.SignalProcessing.Smoothing.GetSavitskyGolayCoefficients method instead.")]
public static Vector<double> GetSavitskyGolayCoefficients(
	int span,
	int polynomialDegree
)

Parameters

span  Int32
The number of points in the filter.
polynomialDegree  Int32
The order of the polynomial.

Return Value

Vector<Double>
A vector that contains the coefficients of the Savitsky-Golay filter.

Remarks

The span must be odd, and must be greater than the degree of the polynomial.

The return value of this method can be used to smooth a numerical variable by calling the WeightedMovingAverage(Vector<Double>, Vector<Double>) method of its Filter property.

Exceptions

ArgumentOutOfRangeException

span is less than zero.

-or-

polynomialDegree is less than zero.

ArgumentExceptionspan is less than or equal to polynomialDegree.

GetSavitskyGolayCoefficients(Int32, Int32, Int32)

Note: This API is now obsolete.
Constructs a vector containing the coefficients of a symmetrical Savitsky-Golay filter with the specified parameters.
C#
[ObsoleteAttribute("Use the Extreme.Mathematics.SignalProcessing.Smoothing.GetSavitskyGolayCoefficients method instead.")]
public static Vector<double> GetSavitskyGolayCoefficients(
	int span,
	int polynomialDegree,
	int currentWeightIndex
)

Parameters

span  Int32
The number of points in the filter.
polynomialDegree  Int32
The order of the polynomial.
currentWeightIndex  Int32
The index in the weight vector of the weight for the current point.

Return Value

Vector<Double>
A vector that contains the coefficients of the Savitsky-Golay filter.

Remarks

The span must be greater than the degree of the polynomial.

The return value of this method can be used to smooth a numerical variable by calling the WeightedMovingAverage(Vector<Double>, Vector<Double>) method of its Filter property.

Exceptions

ArgumentOutOfRangeException

span is less than zero.

-or-

polynomialDegree is less than zero.

-or-

currentWeightIndex is less than zero or greater than or equal to span.

ArgumentExceptionspan is less than or equal to polynomialDegree.

GetSavitskyGolayCoefficients(Int32, Int32, Int32, Int32)

Note: This API is now obsolete.
Constructs a vector containing the coefficients of a Savitsky-Golay filter or a derivative filter with the specified parameters.
C#
[ObsoleteAttribute("Use the Extreme.Mathematics.SignalProcessing.Smoothing.GetSavitskyGolayCoefficients method instead.")]
public static Vector<double> GetSavitskyGolayCoefficients(
	int span,
	int polynomialDegree,
	int currentWeightIndex,
	int derivativeOrder
)

Parameters

span  Int32
The number of points in the filter.
polynomialDegree  Int32
The order of the polynomial.
currentWeightIndex  Int32
The index in the weight vector of the weight for the current point.
derivativeOrder  Int32
The order of the derivative for which to compute the coefficients.

Return Value

Vector<Double>
A vector that contains the coefficients of the Savitsky-Golay filter.

Remarks

The span must be greater than the degree of the polynomial.

The return value of this method can be used to smooth a numerical variable by calling the WeightedMovingAverage(Vector<Double>, Vector<Double>) method of its Filter property.

Exceptions

ArgumentOutOfRangeException

span is less than zero.

-or-

polynomialDegree is less than zero.

-or-

currentWeightIndex is less than zero or greater than or equal to span.

-or-

derivativeOrder is less than zero or greater than the polynomial order.

ArgumentExceptionspan is less than or equal to polynomialDegree.

See Also