Waveform

SCPI Commands :

EXPort:WAVeform:SCOPe
EXPort:WAVeform:CURSorset
EXPort:WAVeform:MEAS
EXPort:WAVeform:STARt
EXPort:WAVeform:STOP
EXPort:WAVeform:SAVE
EXPort:WAVeform:SOURce
EXPort:WAVeform:DLOGging
EXPort:WAVeform:NAME
EXPort:WAVeform:INCXvalues
EXPort:WAVeform:RAW
EXPort:WAVeform:DISPlayoff
EXPort:WAVeform:MULTichannel
EXPort:WAVeform:TIMestamps
EXPort:WAVeform:ICDR
Commands in total: 17
Subgroups: 2
Direct child commands: 15
get_cursor_set() → CursorSet[source]
# EXPort:WAVeform:CURSorset
value: enums.CursorSet = driver.export.waveform.get_cursor_set()

Sets the cursor set to be used for limited data export if method RsRtx.export.waveform.scope() is set to CURSor.

Returns:

cursor_set: CURSOR1 = CURSor1, CURSOR2 = CURSor2, CURSOR3 = CURSor3, CURSOR4 = CURSor4

get_display_off() → bool[source]
# EXPort:WAVeform:DISPlayoff
value: bool = driver.export.waveform.get_display_off()

Enables or disables the display update during an Nx Single acquisition.

Returns:

fast_export: ON: Disables the display update for maximum export speed. OFF: Enables the display update. The export is slower.

get_dlogging() → bool[source]
# EXPort:WAVeform:DLOGging
value: bool = driver.export.waveform.get_dlogging()

The command enables the export of subsequent acquisitions of the selected waveforms. The waveforms are taken from a running Nx Single acquisition (data logging, history is disabled) , or from the history (multiple waveforms, history is enabled) . If the history is disabled (method RsRtx.channel.waveform.history.state.set() ) and data logging is enabled, a specified number of waveforms is transferred to file directly during RUN Nx SINGLE acquisition. Enabling data logging stops a running acquisition. Set the number of acquisitions to be acquired and stored with method RsRtx.acquire.count() and start export using method RsRtx.run.single() . If the history is enabled, the subsequent waveforms are taken from the history. Specify the range with method RsRtx.channel.waveform.history.start.set() and method RsRtx.channel.waveform.history.stop.set() . Then play the history with method RsRtx.channel.waveform.history.play.set() . The commands method RsRtx.export.waveform.save() , method RsRtx.channel.waveform.data.values.get() and method RsRtx.channel.waveform.data.header.get() are not available if data logging is enabled. The method RsRtx.runContinous.set() command disables data logging. If data logging is off, and the history is enabled, one waveform out of the history is written to file. Specify the waveform using method RsRtx.channel.waveform.history.current.set() and save it using method RsRtx.export.waveform.save() .

Returns:

data_logging: OFF | ON

get_icdr() → bool[source]
# EXPort:WAVeform:ICDR
value: bool = driver.export.waveform.get_icdr()

Includes the CDR information in the waveform file.

Returns:

include_cdr_information: OFF | ON

get_incx_values() → bool[source]
# EXPort:WAVeform:INCXvalues
value: bool = driver.export.waveform.get_incx_values()

Includes horizontal values in the retrieved data (time or frequency values, depending on the waveform) . X and Y-values are written alternately to the file. If disabled, only Y-values - mostly voltage values - are written. The X-values are always returned in 64 bit real format, regardless of the defined data format. The setting is not available for the export of raw data. The command affects the content of export files as well as data retrieved with:

  • method RsRtx.channel.waveform.data.values.get()

  • method RsRtx.calculate.math.data.values.get()

  • method RsRtx.refCurve.data.values.get()

  • method RsRtx.digital.data.values.get()

  • method RsRtx.bus.parallel.data.values.get()

  • method RsRtx.zvc.z.icurrent.data.values.get()

  • method RsRtx.zvc.z.voltage.data.values.get()

Returns:

inc_hor_values: OFF | ON

get_meas() → ArithmeticMeasGroup[source]
# EXPort:WAVeform:MEAS
value: enums.ArithmeticMeasGroup = driver.export.waveform.get_meas()

Sets the gate to be used for limited data export if method RsRtx.export.waveform.scope() is set to GATE.

get_multi_channel() → bool[source]
# EXPort:WAVeform:MULTichannel
value: bool = driver.export.waveform.get_multi_channel()

Enables or disables the multichannel export. If you enable the multichannel export, all active channels are included to the export data. You can change the export state using the method RsRtx.channel.exportState.set() command. If multichannel export is disabled, select the waveform to be exported using the method RsRtx.export.waveform.source() command. Note that method RsRtx.channel.waveform.data.values.get() returns the data of all channels that are selected for export, no matter of the channel suffix.

Returns:

mlt_ch_xpt: OFF | ON

get_name() → str[source]
# EXPort:WAVeform:NAME
value: str = driver.export.waveform.get_name()

Sets the file name, file format and path to save the waveform to. See also: ‘Waveform export files’

Returns:

filename: String with path and file name with extension .xml, .bin, or .csv

get_raw() → bool[source]
# EXPort:WAVeform:RAW
value: bool = driver.export.waveform.get_raw()

Enables the export of raw sample data, and sets the data format to integer 8 bit. In high definition acquisition mode, the data format is integer 16 bit. Fot INT16, you can set the byte order using the method RsRtx.formatPy.border() command. The raw format reduces the file size but changes also the precision of the values. Currently, the setting is not available for the export of digital channel data and data of R&S RT-ZVC channels. The raw export of interleaved X/Y values is not supported.

Returns:

raw_values: OFF | ON

get_scope() → WaveformExportScope[source]
# EXPort:WAVeform:SCOPe
value: enums.WaveformExportScope = driver.export.waveform.get_scope()

Defines the part of the waveform record that has to be stored.

Returns:

scope: WFM | ZOOM | CURSor | GATE | MANual

  • WFM: Complete waveform

  • ZOOM: Data included in the zoom area if a zoom is defined for the source waveform.

  • CURSor: Data between the cursor lines if a cursor measurement is defined for the source waveform.

  • GATE: data included in the measurement gate if a gated measurement is defined for the source waveform.

  • MANual: Saves the data between user-defined start and stop values to be set with EXPort:WAVeform:STARt and EXPort:WAVeform:STOP.

get_source() → SignalSource[source]
# EXPort:WAVeform:SOURce
value: enums.SignalSource = driver.export.waveform.get_source()

Selects the waveform to be exported to file. The commands takes effect if method RsRtx.export.waveform.multi_channel() is OFF.

Returns:

source: C1W1 | C1W2 | C1W3 | C2W1 | C2W2 | C2W3 | C3W1 | C3W2 | C3W3 | C4W1 | C4W2 | C4W3 | M1 | M2 | M3 | M4 | M5 | M6 | M7 | M8 | R1 | R2 | R3 | R4 | D0 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | D11 | D12 | D13 | D14 | D15 | MSOB1 | MSOB2 | MSOB3 | MSOB4 | TRK1 | TRK2 | TRK3 | TRK4 | TRK5 | TRK6 | TRK7 | TRK8 | Z1V1 | Z1V2 | Z1V3 | Z1V4 | Z1I1 | Z1I2 | Z1I3 | Z1I4 | Z2V1 | Z2V2 | Z2V3 | Z2V4 | Z2I1 | Z2I2 | Z2I3 | Z2I4 | DIFF1 | DIFF2 | COMMON1 | COMMON2 | BATHtub1 | BMEas1 | SRESponse1 | SRHist1 | SDHist1 | TJHist1 | DJHist1 | DDJHist1 | PJHist1 | RJOHist1 | SRTRack1 | SDTRack1 | TJTRack1 | DJTRack1 | DDJTrack1 | PJTRack1 | RJOTrack1 | TJSPectrum1 | DDJSpectrum1 | PJSPectrum1 | RJOSpectrum1 | SEYE1 | BATHtub2 | BMEas2 | SRESponse2 | SRHist2 | SDHist2 | TJHist2 | DJHist2 | DDJHist2 | PJHist2 | RJOHist2 | SRTRack2 | SDTRack2 | TJTRack2 | DJTRack2 | DDJTrack2 | PJTRack2 | RJOTrack2 | TJSPectrum2 | DDJSpectrum2 | PJSPectrum2 | RJOSpectrum2 | SEYE2 | NBAThtub1 | NBMeas1 | TNHist1 | DNHist1 | DDNHist1 | PNHist1 | RNOHist1 | TNTRack1 | DNTRack1 | DDNTrack1 | PNTRack1 | RNOTrack1 | TNSPectrum1 | DDNSpectrum1 | PNSPectrum1 | RNOSpectrum1 | NBAThtub2 | NBMeas2 | TNHist2 | DNHist2 | DDNHist2 | PNHist2 | RNOHist2 | TNTRack2 | DNTRack2 | DDNTrack2 | PNTRack2 | RNOTrack2 | TNSPectrum2 | DDNSpectrum2 | PNSPectrum2 | RNOSpectrum2 | PJDHist1 | BUJHist1 | RJHist1 | PJDTrack1 | PJDSpectrum1 | PJDHist2 | BUJHist2 | RJHist2 | PJDTrack2 | PJDSpectrum2 | PNDHist1 | BUNHist1 | RNHist1 | PNDTrack1 | PNDSpectrum1 | PNDHist2 | BUNHist2 | RNHist2 | PNDTrack2 | PNDSpectrum2 | LANE1 | LANE2 | LANE3 | LANE4

get_start() → float[source]
# EXPort:WAVeform:STARt
value: float = driver.export.waveform.get_start()

Sets the start value of the waveform section for export, if method RsRtx.export.waveform.scope() is set to Manual.

Returns:

start: -100E+24 to 100E+24

get_stop() → float[source]
# EXPort:WAVeform:STOP
value: float = driver.export.waveform.get_stop()

Sets the end value of the waveform section for export, if method RsRtx.export.waveform.scope() is set to Manual.

Returns:

stop: -100E+24 to 100E+24

get_timestamps() → bool[source]
# EXPort:WAVeform:TIMestamps
value: bool = driver.export.waveform.get_timestamps()

Exports the relative timestamps of all history waveforms to the waveform data file. The time is written at the beginning of each waveform record.

Returns:

use_timestamps: OFF | ON

save() → None[source]
# EXPort:WAVeform:SAVE
driver.export.waveform.save()

Saves the waveform(s) to the file specified with method RsRtx.export.waveform.name() . The file format is also set using the …NAME command.

save_and_wait(opc_timeout_ms: int = -1) → None[source]
# EXPort:WAVeform:SAVE
driver.export.waveform.save_and_wait()

Saves the waveform(s) to the file specified with method RsRtx.export.waveform.name() . The file format is also set using the …NAME command.

Same as save, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.

Parameters:

opc_timeout_ms – Maximum time to wait in milliseconds, valid only for this call.

set_cursor_set(cursor_set: CursorSet) → None[source]
# EXPort:WAVeform:CURSorset
driver.export.waveform.set_cursor_set(cursor_set = enums.CursorSet.CURSOR1)

Sets the cursor set to be used for limited data export if method RsRtx.export.waveform.scope() is set to CURSor.

Parameters:

cursor_set – CURSOR1 = CURSor1, CURSOR2 = CURSor2, CURSOR3 = CURSor3, CURSOR4 = CURSor4

set_display_off(fast_export: bool) → None[source]
# EXPort:WAVeform:DISPlayoff
driver.export.waveform.set_display_off(fast_export = False)

Enables or disables the display update during an Nx Single acquisition.

Parameters:

fast_export – ON: Disables the display update for maximum export speed. OFF: Enables the display update. The export is slower.

set_dlogging(data_logging: bool) → None[source]
# EXPort:WAVeform:DLOGging
driver.export.waveform.set_dlogging(data_logging = False)

The command enables the export of subsequent acquisitions of the selected waveforms. The waveforms are taken from a running Nx Single acquisition (data logging, history is disabled) , or from the history (multiple waveforms, history is enabled) . If the history is disabled (method RsRtx.channel.waveform.history.state.set() ) and data logging is enabled, a specified number of waveforms is transferred to file directly during RUN Nx SINGLE acquisition. Enabling data logging stops a running acquisition. Set the number of acquisitions to be acquired and stored with method RsRtx.acquire.count() and start export using method RsRtx.run.single() . If the history is enabled, the subsequent waveforms are taken from the history. Specify the range with method RsRtx.channel.waveform.history.start.set() and method RsRtx.channel.waveform.history.stop.set() . Then play the history with method RsRtx.channel.waveform.history.play.set() . The commands method RsRtx.export.waveform.save() , method RsRtx.channel.waveform.data.values.get() and method RsRtx.channel.waveform.data.header.get() are not available if data logging is enabled. The method RsRtx.runContinous.set() command disables data logging. If data logging is off, and the history is enabled, one waveform out of the history is written to file. Specify the waveform using method RsRtx.channel.waveform.history.current.set() and save it using method RsRtx.export.waveform.save() .

Parameters:

data_logging – OFF | ON

set_icdr(include_cdr_information: bool) → None[source]
# EXPort:WAVeform:ICDR
driver.export.waveform.set_icdr(include_cdr_information = False)

Includes the CDR information in the waveform file.

Parameters:

include_cdr_information – OFF | ON

set_incx_values(inc_hor_values: bool) → None[source]
# EXPort:WAVeform:INCXvalues
driver.export.waveform.set_incx_values(inc_hor_values = False)

Includes horizontal values in the retrieved data (time or frequency values, depending on the waveform) . X and Y-values are written alternately to the file. If disabled, only Y-values - mostly voltage values - are written. The X-values are always returned in 64 bit real format, regardless of the defined data format. The setting is not available for the export of raw data. The command affects the content of export files as well as data retrieved with:

  • method RsRtx.channel.waveform.data.values.get()

  • method RsRtx.calculate.math.data.values.get()

  • method RsRtx.refCurve.data.values.get()

  • method RsRtx.digital.data.values.get()

  • method RsRtx.bus.parallel.data.values.get()

  • method RsRtx.zvc.z.icurrent.data.values.get()

  • method RsRtx.zvc.z.voltage.data.values.get()

Parameters:

inc_hor_values – OFF | ON

set_meas(meas_gte: ArithmeticMeasGroup) → None[source]
# EXPort:WAVeform:MEAS
driver.export.waveform.set_meas(meas_gte = enums.ArithmeticMeasGroup.IMEAS)

Sets the gate to be used for limited data export if method RsRtx.export.waveform.scope() is set to GATE.

Parameters:

meas_gte – Measurement for which the gate is defined.

set_multi_channel(mlt_ch_xpt: bool) → None[source]
# EXPort:WAVeform:MULTichannel
driver.export.waveform.set_multi_channel(mlt_ch_xpt = False)

Enables or disables the multichannel export. If you enable the multichannel export, all active channels are included to the export data. You can change the export state using the method RsRtx.channel.exportState.set() command. If multichannel export is disabled, select the waveform to be exported using the method RsRtx.export.waveform.source() command. Note that method RsRtx.channel.waveform.data.values.get() returns the data of all channels that are selected for export, no matter of the channel suffix.

Parameters:

mlt_ch_xpt – OFF | ON

set_name(filename: str) → None[source]
# EXPort:WAVeform:NAME
driver.export.waveform.set_name(filename = 'abc')

Sets the file name, file format and path to save the waveform to. See also: ‘Waveform export files’

Parameters:

filename – String with path and file name with extension .xml, .bin, or .csv

set_raw(raw_values: bool) → None[source]
# EXPort:WAVeform:RAW
driver.export.waveform.set_raw(raw_values = False)

Enables the export of raw sample data, and sets the data format to integer 8 bit. In high definition acquisition mode, the data format is integer 16 bit. Fot INT16, you can set the byte order using the method RsRtx.formatPy.border() command. The raw format reduces the file size but changes also the precision of the values. Currently, the setting is not available for the export of digital channel data and data of R&S RT-ZVC channels. The raw export of interleaved X/Y values is not supported.

Parameters:

raw_values – OFF | ON

set_scope(scope: WaveformExportScope) → None[source]
# EXPort:WAVeform:SCOPe
driver.export.waveform.set_scope(scope = enums.WaveformExportScope.CURSor)

Defines the part of the waveform record that has to be stored.

Parameters:

scope –

WFM | ZOOM | CURSor | GATE | MANual

  • WFM: Complete waveform

  • ZOOM: Data included in the zoom area if a zoom is defined for the source waveform.

  • CURSor: Data between the cursor lines if a cursor measurement is defined for the source waveform.

  • GATE: data included in the measurement gate if a gated measurement is defined for the source waveform.

  • MANual: Saves the data between user-defined start and stop values to be set with EXPort:WAVeform:STARt and EXPort:WAVeform:STOP.

set_source(source: SignalSource) → None[source]
# EXPort:WAVeform:SOURce
driver.export.waveform.set_source(source = enums.SignalSource.AJ1)

Selects the waveform to be exported to file. The commands takes effect if method RsRtx.export.waveform.multi_channel() is OFF.

Parameters:

source – C1W1 | C1W2 | C1W3 | C2W1 | C2W2 | C2W3 | C3W1 | C3W2 | C3W3 | C4W1 | C4W2 | C4W3 | M1 | M2 | M3 | M4 | M5 | M6 | M7 | M8 | R1 | R2 | R3 | R4 | D0 | D1 | D2 | D3 | D4 | D5 | D6 | D7 | D8 | D9 | D10 | D11 | D12 | D13 | D14 | D15 | MSOB1 | MSOB2 | MSOB3 | MSOB4 | TRK1 | TRK2 | TRK3 | TRK4 | TRK5 | TRK6 | TRK7 | TRK8 | Z1V1 | Z1V2 | Z1V3 | Z1V4 | Z1I1 | Z1I2 | Z1I3 | Z1I4 | Z2V1 | Z2V2 | Z2V3 | Z2V4 | Z2I1 | Z2I2 | Z2I3 | Z2I4 | DIFF1 | DIFF2 | COMMON1 | COMMON2 | BATHtub1 | BMEas1 | SRESponse1 | SRHist1 | SDHist1 | TJHist1 | DJHist1 | DDJHist1 | PJHist1 | RJOHist1 | SRTRack1 | SDTRack1 | TJTRack1 | DJTRack1 | DDJTrack1 | PJTRack1 | RJOTrack1 | TJSPectrum1 | DDJSpectrum1 | PJSPectrum1 | RJOSpectrum1 | SEYE1 | BATHtub2 | BMEas2 | SRESponse2 | SRHist2 | SDHist2 | TJHist2 | DJHist2 | DDJHist2 | PJHist2 | RJOHist2 | SRTRack2 | SDTRack2 | TJTRack2 | DJTRack2 | DDJTrack2 | PJTRack2 | RJOTrack2 | TJSPectrum2 | DDJSpectrum2 | PJSPectrum2 | RJOSpectrum2 | SEYE2 | NBAThtub1 | NBMeas1 | TNHist1 | DNHist1 | DDNHist1 | PNHist1 | RNOHist1 | TNTRack1 | DNTRack1 | DDNTrack1 | PNTRack1 | RNOTrack1 | TNSPectrum1 | DDNSpectrum1 | PNSPectrum1 | RNOSpectrum1 | NBAThtub2 | NBMeas2 | TNHist2 | DNHist2 | DDNHist2 | PNHist2 | RNOHist2 | TNTRack2 | DNTRack2 | DDNTrack2 | PNTRack2 | RNOTrack2 | TNSPectrum2 | DDNSpectrum2 | PNSPectrum2 | RNOSpectrum2 | PJDHist1 | BUJHist1 | RJHist1 | PJDTrack1 | PJDSpectrum1 | PJDHist2 | BUJHist2 | RJHist2 | PJDTrack2 | PJDSpectrum2 | PNDHist1 | BUNHist1 | RNHist1 | PNDTrack1 | PNDSpectrum1 | PNDHist2 | BUNHist2 | RNHist2 | PNDTrack2 | PNDSpectrum2 | LANE1 | LANE2 | LANE3 | LANE4

set_start(start: float) → None[source]
# EXPort:WAVeform:STARt
driver.export.waveform.set_start(start = 1.0)

Sets the start value of the waveform section for export, if method RsRtx.export.waveform.scope() is set to Manual.

Parameters:

start – -100E+24 to 100E+24

set_stop(stop: float) → None[source]
# EXPort:WAVeform:STOP
driver.export.waveform.set_stop(stop = 1.0)

Sets the end value of the waveform section for export, if method RsRtx.export.waveform.scope() is set to Manual.

Parameters:

stop – -100E+24 to 100E+24

set_timestamps(use_timestamps: bool) → None[source]
# EXPort:WAVeform:TIMestamps
driver.export.waveform.set_timestamps(use_timestamps = False)

Exports the relative timestamps of all history waveforms to the waveform data file. The time is written at the beginning of each waveform record.

Parameters:

use_timestamps – OFF | ON

Cloning the Group

# Create a copy of the original group, that exists independently
waveform_copy = driver.export.waveform.clone()

Subgroups