Sine

Generates a signal containing a sine wave.

1378

Inputs/Outputs

datatype_icon

offset

DC offset of the signal.

Default value: 0

datatype_icon

reset phase

A Boolean that determines the initial phase of the wave.

True

Sets the initial phase to phase in and sets the initial time to t0 if you configure this node to return a waveform.

Sets the initial phase to phase in if you configure this node to return a double-precision, floating-point number or an array of double-precision, floating-point numbers.

False

Uses the values of phase out and t0 from when the node last executed as the initial phase and time of the wave if you configure this node to return a waveform.

Uses the values of phase out from when the node last executed as the initial phase of the wave if you configure this node to return a double-precision, floating-point number or an array of double-precision, floating-point numbers.

Default value: False

datatype_icon

amplitude

Amplitude of the signal.

Default value: 1

datatype_icon

frequency

Frequency of the signal.

Default value: 10

datatype_icon

phase in

Initial phase in degrees of the signal when reset phase is True.

Default value: 0

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Default value: No error

datatype_icon

sample rate

Sample rate in samples per second.

Default value: 1000

datatype_icon

samples

Number of samples in the signal.

samples must be greater than 0. Otherwise, this node returns an error.

This input is available when you configure this node to return a waveform or an array of double-precision, floating-point numbers.

Default value: 1000

datatype_icon

t0

Timestamp of the output signal.

If this input is unwired, this node uses the current time as the timestamp of the output signal.

This input is available only if you configure this node to return a waveform.

datatype_icon

sine wave

Output sine signal.

This output can return the following data types:

  • Waveform
  • Double-precision, floating-point number
  • 1D array of double-precision, floating-point numbers
datatype_icon

phase out

Phase, in degrees, of the next sample of the output signal.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Algorithm for Simulating a Sine Wave

If sequence Y represents a sine wave, this node generates the pattern according to the following equation.

y [ i ] = amplitude × sin ( phase [ i ] ) ,   for ⁢     i = 0 , 1 , 2.... , n − 1 y [ i ] = amplitude × sin ( phase [ i ] ) ,   for ⁢     i = 0 , 1 , 2.... , n − 1

where n is the number of samples, and

phase[i]
is:

initial_phase + frequency × 360 × i samples per second initial_phase + frequency × 360 × i samples per second

where initial_phase is the initial phase of the wave.