SignalMath.GenerateSine Method

Definition

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

Overload List

GenerateSine(Double, Double, Double, Span<Double>) Generates a sine wave signal.
GenerateSine(Int32, Double, Double, Double) Generates a sine wave signal and returns it as a vector.
GenerateSine(Vector<Double>, Double, Double, Double) Generates a sine wave signal at explicit x values and returns it as a vector.
GenerateSine(Double, Double, Double, Double, Span<Double>) Generates a sine wave signal with DC offset.
GenerateSine(Int32, Double, Double, Double, Double) Generates a sine wave signal with DC offset and returns it as a vector.
GenerateSine(ReadOnlySpan<Double>, Double, Double, Double, Span<Double>) Generates a sine wave signal at explicit x values.
GenerateSine(Vector<Double>, Double, Double, Double, Double) Generates a sine wave signal with DC offset at explicit x values and returns it as a vector.
GenerateSine(ReadOnlySpan<Double>, Double, Double, Double, Double, Span<Double>) Generates a sine wave signal with DC offset at explicit x values.

GenerateSine(Double, Double, Double, Span<Double>)

Generates a sine wave signal.
C#
public static void GenerateSine(
	double amplitude,
	double angularFrequency,
	double phase,
	Span<double> destination
)

Parameters

amplitude  Double
The amplitude of the sine wave.
angularFrequency  Double
The angular frequency in radians per sample.
phase  Double
The initial phase in radians.
destination  Span<Double>
The destination span to write the generated signal.

Remarks

Generates a sine wave according to the formula:

y[n] = A sin(ω n + φ)

where A is the amplitude, ω is the angular frequency, φ is the phase, and n = 0, 1, 2, ..., count-1.

GenerateSine(Int32, Double, Double, Double)

Generates a sine wave signal and returns it as a vector.
C#
public static Vector<double> GenerateSine(
	int count,
	double amplitude,
	double angularFrequency,
	double phase
)

Parameters

count  Int32
The number of points in the signal.
amplitude  Double
The amplitude of the sine wave.
angularFrequency  Double
The angular frequency in radians per sample.
phase  Double
The initial phase in radians.

Return Value

Vector<Double>
A vector containing the generated sine wave signal.

Remarks

Generates a sine wave according to the formula:

y[n] = A sin(ω n + φ)

where A is the amplitude, ω is the angular frequency, φ is the phase, and n = 0, 1, 2, ..., count-1.

GenerateSine(Vector<Double>, Double, Double, Double)

Generates a sine wave signal at explicit x values and returns it as a vector.
C#
public static Vector<double> GenerateSine(
	Vector<double> x,
	double amplitude,
	double angularFrequency,
	double phase
)

Parameters

x  Vector<Double>
The x values at which to evaluate the sine wave.
amplitude  Double
The amplitude of the sine wave.
angularFrequency  Double
The angular frequency in radians per x-unit.
phase  Double
The initial phase in radians.

Return Value

Vector<Double>
A vector containing the generated sine wave signal.

Remarks

Generates a sine wave according to the formula:

y(x) = A sin(ω x + φ)

where A is the amplitude, ω is the angular frequency, and φ is the phase.

GenerateSine(Double, Double, Double, Double, Span<Double>)

Generates a sine wave signal with DC offset.
C#
public static void GenerateSine(
	double amplitude,
	double angularFrequency,
	double phase,
	double offset,
	Span<double> destination
)

Parameters

amplitude  Double
The amplitude of the sine wave.
angularFrequency  Double
The angular frequency in radians per sample.
phase  Double
The initial phase in radians.
offset  Double
The DC offset to add to the signal.
destination  Span<Double>
The destination span to write the generated signal.

Remarks

Generates a sine wave according to the formula:

y[n] = c + A sin(ω n + φ)

where c is the offset, A is the amplitude, ω is the angular frequency, φ is the phase, and n = 0, 1, 2, ..., count-1.

GenerateSine(Int32, Double, Double, Double, Double)

Generates a sine wave signal with DC offset and returns it as a vector.
C#
public static Vector<double> GenerateSine(
	int count,
	double amplitude,
	double angularFrequency,
	double phase,
	double offset
)

Parameters

count  Int32
The number of points in the signal.
amplitude  Double
The amplitude of the sine wave.
angularFrequency  Double
The angular frequency in radians per sample.
phase  Double
The initial phase in radians.
offset  Double
The DC offset to add to the signal.

Return Value

Vector<Double>
A vector containing the generated sine wave signal.

Remarks

Generates a sine wave according to the formula:

y[n] = c + A sin(ω n + φ)

where c is the offset, A is the amplitude, ω is the angular frequency, φ is the phase, and n = 0, 1, 2, ..., count-1.

GenerateSine(ReadOnlySpan<Double>, Double, Double, Double, Span<Double>)

Generates a sine wave signal at explicit x values.
C#
public static void GenerateSine(
	ReadOnlySpan<double> x,
	double amplitude,
	double angularFrequency,
	double phase,
	Span<double> destination
)

Parameters

x  ReadOnlySpan<Double>
The x values at which to evaluate the sine wave.
amplitude  Double
The amplitude of the sine wave.
angularFrequency  Double
The angular frequency in radians per x-unit.
phase  Double
The initial phase in radians.
destination  Span<Double>
The destination span to write the generated signal.

Remarks

Generates a sine wave according to the formula:

y(x) = A sin(ω x + φ)

where A is the amplitude, ω is the angular frequency, and φ is the phase.

GenerateSine(Vector<Double>, Double, Double, Double, Double)

Generates a sine wave signal with DC offset at explicit x values and returns it as a vector.
C#
public static Vector<double> GenerateSine(
	Vector<double> x,
	double amplitude,
	double angularFrequency,
	double phase,
	double offset
)

Parameters

x  Vector<Double>
The x values at which to evaluate the sine wave.
amplitude  Double
The amplitude of the sine wave.
angularFrequency  Double
The angular frequency in radians per x-unit.
phase  Double
The initial phase in radians.
offset  Double
The DC offset to add to the signal.

Return Value

Vector<Double>
A vector containing the generated sine wave signal.

Remarks

Generates a sine wave according to the formula:

y(x) = c + A sin(ω x + φ)

where c is the offset, A is the amplitude, ω is the angular frequency, and φ is the phase.

GenerateSine(ReadOnlySpan<Double>, Double, Double, Double, Double, Span<Double>)

Generates a sine wave signal with DC offset at explicit x values.
C#
public static void GenerateSine(
	ReadOnlySpan<double> x,
	double amplitude,
	double angularFrequency,
	double phase,
	double offset,
	Span<double> destination
)

Parameters

x  ReadOnlySpan<Double>
The x values at which to evaluate the sine wave.
amplitude  Double
The amplitude of the sine wave.
angularFrequency  Double
The angular frequency in radians per x-unit.
phase  Double
The initial phase in radians.
offset  Double
The DC offset to add to the signal.
destination  Span<Double>
The destination span to write the generated signal.

Remarks

Generates a sine wave according to the formula:

y(x) = c + A sin(ω x + φ)

where c is the offset, A is the amplitude, ω is the angular frequency, and φ is the phase.

See Also