photons.equipment.oscilloscope_rigol module

An oscilloscope from Rigol.

class photons.equipment.oscilloscope_rigol.RigolOscilloscope(record, **kwargs)

Bases: Oscilloscope

An oscilloscope from Rigol.

Base class for an oscilloscope.

Parameters:

• record (EquipmentRecord) – The equipment record.

• **kwargs – Keyword arguments. Can be specified as attributes of an XML element in a configuration file (with the tag of the element equal to the alias of record).

clear()

Clears the event registers and the error queue.

Return type:

None

configure_channel(channel, *, bw_limit=False, coupling='DC', enable=True, invert=False, offset=0, probe=1, scale=1)

Configure a channel.

Parameters:

• channel (int) – The channel number.

• bw_limit (bool) – Whether to enable or disable the bandwidth limit.

• coupling (Literal['DC', 'AC', 'GND']) – The coupling mode (either DC, AC or GND).

• enable (bool) – Whether to enable or disable the channel.

• invert (bool) – Whether to invert the waveform.

• offset (float) – The vertical offset [Volts].

• probe (float) – The probe ratio. Only discrete values are allowed (see manual).

• scale (float) – The vertical scale [Volts/div].

Return type:

None

configure_timebase(*, mode='MAIN', offset=0, scale=1e-06)

Configure the timebase.

Parameters:

• mode (Literal['MAIN', 'XY', 'ROLL']) – The timebase mode (either MAIN, XY or ROLL).

• offset (float) – The horizontal offset [seconds].

• scale (float) – The horizontal scale [seconds/div].

Return type:

None

configure_trigger(*, channel=1, coupling='DC', holdoff=1.6e-08, level=0, noise_reject=True, slope='POS', sweep='AUTO')

Configure the Edge trigger.

Parameters:

• channel (int | str) – The channel to use as the trigger source.

• coupling (Literal['AC', 'DC', 'LFReject', 'HFReject']) – The trigger coupling type (either AC, DC, LFReject or HFReject).

• holdoff (float) – The trigger holdoff time [seconds].

• level (float) – The voltage level to trigger at.

• noise_reject (bool) – Whether to enable or disable noise rejection.

• slope (Literal['POS', 'NEG', 'RFAL']) – The slope edge to trigger on (either POS, NEG or RFAL).

• sweep (Literal['AUTO', 'NORMAL', 'SINGLE']) – The sweep mode (either AUTO, NORMAL or SINGLE).

Return type:

None

run()

Start acquiring waveform data.

Return type:

None

single()

Capture and display a single acquisition.

Return type:

None

trigger()

Send a software trigger.

Return type:

None

stop()

Stop acquiring waveform data.

Return type:

None

waveform(*channels, displayed=True)

Get the waveform data.

Parameters:

• *channels (int | str) – The channel(s) to read (e.g., 1, ‘CHAN1’, ‘channel1’, ‘D6’).

• displayed (bool) – Whether to read the waveform data displayed on the screen or from internal memory. If reading from internal memory then stop() is called prior to reading the data.

Return type:

ndarray

Returns:

The waveform data.