dwfpy.analog_output.AnalogOutputChannel

class AnalogOutputChannel(module, channel)

Bases: object

Represents an Analog Output channel.

Methods

apply	Applies changes to the instrument.
configure	Configures and optionally starts the instrument.
read_status	Gets the instrument status.
reset	Resets and configures all instrument parameters to default values.
setup	Sets up a new carrier waveform.
setup_am	Applies an AM modulation to a waveform.
setup_fm	Applies an FM modulation to a waveform.

Attributes

device	Gets the device.
enable_repeat_trigger	Enables the repeat count trigger in wait-run repeat cycles.
idle	Gets or sets the generator idle output option.
idle_info	Gets the supported channel nodes.
index	Gets the channel index.
label	Gets or sets the channel label.
limitation	Gets or sets the limitation value.
limitation_max	Gets the maximum limitation value.
limitation_min	Gets the minimum limitation value.
master	Gets or sets the master node index.
mode	Gets or sets the generator mode option.
module	Gets the Analog Output module.
nodes	Gets the channel nodes.
repeat_count	Gets or sets the repeat count.
repeat_count_max	Gets the maximum repeat count.
repeat_count_min	Gets the minimum repeat count.
repeat_count_status	Gets the remaining repeat count.
run_length	Gets or sets the run length in seconds.
run_length_max	Gets the maximum run length in seconds.
run_length_min	Gets the minimum run length in seconds.
run_length_status	Gets the remaining run length in seconds.
trigger	Gets the trigger unit.
wait_length	Gets or sets the wait length in seconds.
wait_length_max	Gets the maximum wait length in seconds.
wait_length_min	Gets the minimum wait length in seconds.

apply()

Applies changes to the instrument.

Return type

None

configure(start=False)

Configures and optionally starts the instrument.

Return type

None

property device: Device

Gets the device.

Return type

Device

property enable_repeat_trigger: bool

Enables the repeat count trigger in wait-run repeat cycles.

Return type

bool

property idle: AnalogOutputIdle

Gets or sets the generator idle output option.

Return type

AnalogOutputIdle

property idle_info: Tuple[AnalogOutputIdle, ...]

Gets the supported channel nodes.

Return type

Tuple[AnalogOutputIdle, ...]

property index: int

Gets the channel index.

Return type

int

property label: str

Gets or sets the channel label.

Return type

str

property limitation: float

Gets or sets the limitation value. Voltage offset in volts or modulation offset percentage.

Return type

float

property limitation_max: float

Gets the maximum limitation value.

Return type

float

property limitation_min: float

Gets the minimum limitation value.

Return type

float

property master: int

Gets or sets the master node index.

Return type

int

property mode: AnalogOutputMode

Gets or sets the generator mode option.

Return type

AnalogOutputMode

property module: AnalogOutput

Gets the Analog Output module.

Return type

AnalogOutput

property nodes: Tuple[AnalogOutputChannelNode, ...]

Gets the channel nodes.

Return type

Tuple[AnalogOutputChannelNode, ...]

read_status()

Gets the instrument status.

Return type

Status

property repeat_count: int

Gets or sets the repeat count.

Return type

int

property repeat_count_max: int

Gets the maximum repeat count.

Return type

int

property repeat_count_min: int

Gets the minimum repeat count.

Return type

int

property repeat_count_status: float

Gets the remaining repeat count.

Return type

float

reset()

Resets and configures all instrument parameters to default values.

Return type

None

property run_length: float

Gets or sets the run length in seconds.

Return type

float

property run_length_max: float

Gets the maximum run length in seconds.

Return type

float

property run_length_min: float

Gets the minimum run length in seconds.

Return type

float

property run_length_status: float

Gets the remaining run length in seconds.

Return type

float

setup(function=None, frequency=None, amplitude=None, offset=None, symmetry=None, phase=None, enabled=True, configure=False, start=False)

Sets up a new carrier waveform.

functionstr, optional

The generator function. Can be ‘dc’, ‘sine’, ‘square’, ‘triangle’, ‘ramp-up’, ‘ramp-down’, ‘noise’, ‘pulse’, ‘trapezium’, or ‘sine-power’.

frequencyfloat, optional

The waveform frequency in Hz.

amplitudefloat, optional

The waveform amplitude in Volts.

offsetfloat, optional

The waveform offset in Volts.

symmetryfloat, optional

The waveform symmetry (or duty cycle) in percent.

phasefloat, optional

The waveform phase in degree.

enabledbool, optional

If True, then the node is enabled (default True).

configurebool, optional

If True, then the instrument is configured (default False).

startbool, optional

If True, then the instrument is started (default False).

Return type

None

setup_am(function=None, frequency=None, amplitude=None, offset=None, symmetry=None, phase=None, enabled=True, configure=False, start=False)

Applies an AM modulation to a waveform.

functionstr, optional

The generator function. Can be ‘dc’, ‘sine’, ‘square’, ‘triangle’, ‘ramp-up’, ‘ramp-down’, ‘noise’, ‘pulse’, ‘trapezium’, or ‘sine-power’.

frequencyfloat, optional

The waveform frequency in Hz.

amplitudefloat, optional

The waveform amplitude in percent.

offsetfloat, optional

The waveform offset in percent.

symmetryfloat, optional

The waveform symmetry (or duty cycle) in percent.

phasefloat, optional

The waveform phase in degree.

enabledbool, optional

If True, then the node is enabled (default True).

configurebool, optional

If True, then the instrument is configured (default False).

startbool, optional

If True, then the instrument is started (default False).

Return type

None

setup_fm(function=None, frequency=None, amplitude=None, offset=None, symmetry=None, phase=None, enabled=True, configure=False, start=False)

Applies an FM modulation to a waveform.

functionstr, optional

The generator function. Can be ‘dc’, ‘sine’, ‘square’, ‘triangle’, ‘ramp-up’, ‘ramp-down’, ‘noise’, ‘pulse’, ‘trapezium’, or ‘sine-power’.

frequencyfloat, optional

The waveform frequency in Hz.

amplitudefloat, optional

The waveform amplitude in percent.

offsetfloat, optional

The waveform offset in percent.

symmetryfloat, optional

The waveform symmetry (or duty cycle) in percent.

phasefloat, optional

The waveform phase in degree.

enabledbool, optional

If True, then the node is enabled (default True).

configurebool, optional

If True, then the instrument is configured (default False).

startbool, optional

If True, then the instrument is started (default False).

Return type

None

property trigger: AnalogOutputChannelTrigger

Gets the trigger unit.

Return type

AnalogOutputChannelTrigger

property wait_length: float

Gets or sets the wait length in seconds.

Return type

float

property wait_length_max: float

Gets the maximum wait length in seconds.

Return type

float

property wait_length_min: float

Gets the minimum wait length in seconds.

Return type

float