SigGen: Programming Interface

The SigGen module has following settings, ports and functions.

Settings

Signal Type

Syntax	:type
Type	:String
Unit	:n/a
Default	:"Sine"

Type of waveform to synthesize. Valid values are "Sine", "Square", "Triangle", "Pulse" and "Noise".

Frequency

Syntax	:freq
Type	:double
Unit	:Hertz (Hz)
Default	:1M

Frequency of the synthesized waveform. Must be greater than 0.

Amplitude (Peak to Peak)

Syntax	:pk2pk
Type	:double
Unit	:Volt (V)
Default	:4

Peak to peak amplitude of the synthesized waveform. Must be greater than or equal to 0.

DC Offset

Syntax	:offset
Type	:double
Unit	:Volt (V)
Default	:0

DC offset in the synthesized waveform.

Duty Cycle

Syntax	:duty
Type	:double
Unit	:Percent (%)
Default	:50

Duty cycle of the synthesized waveform. Available only for square waves. Valid range is from 0 through 100.

Symmetry

Syntax	:symmetry
Type	:double
Unit	:Percent (%)
Default	:50

Symmetry of the synthesized waveform. Available only for triangle waves. Valid range is from 0 through 100. A symmetry of 0% generates saw-tooth signal and a symmetry of 100% generates a ramp signal.

Pulse Width

Syntax	:width
Type	:double
Unit	:second (s)
Default	:500n

Width of the synthesize pulse. Available only for pulse type signal. Must be greater than 0.

Noise Type

Syntax	:noise.type
Type	:String
Unit	:n/a
Default	:"white"

Type of noise signal to be synthesized. Available only for noise signal. Valid values are "White" and "Gaussian".

Sample Rate

Syntax	:samplerate
Type	:double
Unit	:Samples/second (SPS)
Default	:100M

Number of samples per second in the synthesized waveform. Must be greater than 0. If modulation is ON, then the sample rate value of the input signal is used.

Record Length

Syntax	:reclen
Type	:long
Unit	:Points (Pts)
Default	:1000

Number of points in the synthesized waveform. Must be greater than 0. If modulation is ON, then the record length value of the input signal is used.

Freeze Signal

Syntax	:freeze
Type	:long
Unit	:n/a
Default	:0

A new acquisition cycle produces the same old waveform.

Current Angle

Syntax	:angle
Type	:double
Unit	:Radian (Rad)
Default	:Varies

Angle of the first point of the synthesized waveform in the next acquisition.

Modulation Type

Syntax	:mod.type
Type	:String
Unit	:n/a
Default	:"OFF"

Parameter of the synthesized waveform to be modulated. Valid values depend on type of signal and are as listed below:

Modulation Gain

Syntax	:mod.gain
Type	:double
Unit	:Varies with Modulation type as given below.
		Modulation	Unit
		OFF	Not Applicable
		AM	V/V
		FM	Hz/V
		PM	Rad/V
		DCM	%/V
		SM	%/V
		PAM	V/V
		PFM	Hz/V
		PPM	s/V
		PWM	s/V
Default	:1

The modulation gain is the modulation sensitivity of the signal generator. It is applied to the input signal before modulating it on to the output signal.

Horizontal Offset

Syntax	:hor.offset
Type	:double
Unit	:Second (s)
Default	:0

Horizontal offset of the output signal. If hor.offset.additive is 0, the specified horizontal offset is absolute and is the horizontal offset for the first point in the waveform, i.e. it overrides the horizontal offset inherent in the waveform. If hor.offset.additive is non-zero, the specified horizontal offset is additive to any horizontal offset inherent in the waveform.

Horizontal Offset Type

Syntax	:hor.offset.additive
Type	:long
Unit	:n/a
Default	:1

1=Additive, 0=Absolute
Setting the horizontal offset additive makes the specified hor.offset as additive to the horizontal offset inherent in the waveform. Setting the horizontal offset absolute makes the specified hor.offset as absolute and is the horizontal offset for the first point in the waveform, i.e. it overrides the horizontal offset inherent in the waveform.

Ports

Signal Out

Syntax

:out

The synthesized waveform is available at this port.

Modulation In

Syntax

:mod.src

The modulating signal should be connected to this port.

Functions

Waveform Types Supported

Types of waveforms that can be synthesized by the module.

String wfm.types()

Returns

:Comma separated list of waveform types

Modulation Types Supported

Types of modulations available for the selected waveform type.

String mod.types()

Returns

:Comma separated list of modulation types

Noise Types Supported

Types of noise signals that can be synthesized by the module.

String noise.types()

Returns

:Comma separated list of noise types

Window Size

Changes the width and height of the GUI window.

void gui.size(float width, float height)

Returns	:None
width	:Window width in pixels
height	:Window height in pixels

Window Location

Moves the GUI window to the specified location and optionally changes size.

void gui.move(float left, float top, float width, float height)

Returns	:None
left	:Horizontal coordinate for the left edge of the window in pixels.
top	:Vertical coordinate for the top edge of the window in pixels.
width	:Optional. Window width in pixels
height	:Optional. Window height in pixels