wfmoutpre

The wfmoutpre commands module.

These commands are used in the following models: DPO4K, DPO4KB, MDO3, MDO3K, MDO4K, MDO4KB, MDO4KC, MSO4K, MSO4KB

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries
- WFMOutpre:BIT_Nr <NR1>
- WFMOutpre:BIT_Nr?
- WFMOutpre:BN_Fmt {RI|RP|FP}
- WFMOutpre:BN_Fmt?
- WFMOutpre:BYT_Nr <NR1>
- WFMOutpre:BYT_Nr?
- WFMOutpre:BYT_Or {LSB|MSB}
- WFMOutpre:BYT_Or?
- WFMOutpre:CENTERFREQuency?
- WFMOutpre:DOMain?
- WFMOutpre:ENCdg {ASCii|BINary}
- WFMOutpre:ENCdg?
- WFMOutpre:NR_Pt?
- WFMOutpre:PT_Fmt?
- WFMOutpre:PT_ORder?
- WFMOutpre:PT_Off?
- WFMOutpre:REFLEvel?
- WFMOutpre:SPAN?
- WFMOutpre:WFId?
- WFMOutpre:WFMTYPe?
- WFMOutpre:XINcr?
- WFMOutpre:XUNit?
- WFMOutpre:XZEro?
- WFMOutpre:YMUlt?
- WFMOutpre:YOFf?
- WFMOutpre:YUNit?
- WFMOutpre:YZEro?
- WFMOutpre?

Wfmoutpre

Bases: SCPICmdRead

The WFMOutpre command.

Description
  • This query-only command queries the waveform formatting data for the waveform specified by the DATA:SOURCE command. The preamble components are considered to be of two types; formatting and interpretation. The formatting components are: ENCdg, BN_Fmt, BYT_Or, BYT_Nr, BIT_Nr. The interpretation components are derived from the DATa:SOUrce specified waveform.
Usage
  • Using the .query() method will send the WFMOutpre? query.
  • Using the .verify(value) method will send the WFMOutpre? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre?
Properties
  • .bit_nr: The WFMOutpre:BIT_Nr command.
  • .bn_fmt: The WFMOutpre:BN_Fmt command.
  • .byt_nr: The WFMOutpre:BYT_Nr command.
  • .byt_or: The WFMOutpre:BYT_Or command.
  • .centerfrequency: The WFMOutpre:CENTERFREQuency command.
  • .domain: The WFMOutpre:DOMain command.
  • .encdg: The WFMOutpre:ENCdg command.
  • .nr_pt: The WFMOutpre:NR_Pt command.
  • .pt_fmt: The WFMOutpre:PT_Fmt command.
  • .pt_order: The WFMOutpre:PT_ORder command.
  • .pt_off: The WFMOutpre:PT_Off command.
  • .reflevel: The WFMOutpre:REFLEvel command.
  • .span: The WFMOutpre:SPAN command.
  • .wfid: The WFMOutpre:WFId command.
  • .wfmtype: The WFMOutpre:WFMTYPe command.
  • .xincr: The WFMOutpre:XINcr command.
  • .xunit: The WFMOutpre:XUNit command.
  • .xzero: The WFMOutpre:XZEro command.
  • .ymult: The WFMOutpre:YMUlt command.
  • .yoff: The WFMOutpre:YOFf command.
  • .yunit: The WFMOutpre:YUNit command.
  • .yzero: The WFMOutpre:YZEro command.

bit_nr property

Return the WFMOutpre:BIT_Nr command.

Description
  • This command sets and queries the number of bits per waveform point that outgoing waveforms contain, as specified by the DATA:SOURCE command. Note that values will be constrained according to the underlying waveform data. This specification is only meaningful when WFMOUTPRE:ENCDG is set to BIN and WFMOUTPRE:BN_FMT is set to either RI or RP.
Usage
  • Using the .query() method will send the WFMOutpre:BIT_Nr? query.
  • Using the .verify(value) method will send the WFMOutpre:BIT_Nr? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:BIT_Nr value command.
SCPI Syntax
- WFMOutpre:BIT_Nr <NR1>
- WFMOutpre:BIT_Nr?
Info
  • <NR1> number of bits per data point can be 8 or 16.

bn_fmt property

Return the WFMOutpre:BN_Fmt command.

Description
  • This command sets or queries the format of binary data for outgoing waveforms specified by the DATA:SOURCE command.
Usage
  • Using the .query() method will send the WFMOutpre:BN_Fmt? query.
  • Using the .verify(value) method will send the WFMOutpre:BN_Fmt? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:BN_Fmt value command.
SCPI Syntax
- WFMOutpre:BN_Fmt {RI|RP|FP}
- WFMOutpre:BN_Fmt?
Info
  • RI specifies signed integer data point representation.
  • RP specifies positive integer data point representation.
  • FP specifies floating point representation.

byt_nr property

Return the WFMOutpre:BYT_Nr command.

Description
  • This command sets or queries the binary field data width (bytes per point) for the waveform specified by the DATA:SOURCE command. Note that values will be constrained according to the underlying waveform data. This specification is only meaningful when WFMOUTPRE:ENCDG is set to BIN, and WFMOUTPRE:BN_FMT is set to either RI or RP.
Usage
  • Using the .query() method will send the WFMOutpre:BYT_Nr? query.
  • Using the .verify(value) method will send the WFMOutpre:BYT_Nr? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:BYT_Nr value command.
SCPI Syntax
- WFMOutpre:BYT_Nr <NR1>
- WFMOutpre:BYT_Nr?
Info
  • <NR1> is the number of bytes per data point and can be 1, 2 or 8. A value of 1 or 2 bytes per waveform point indicates channel data; 8 bytes per waveform point indicate pixel map (fast acquisition) data.

byt_or property

Return the WFMOutpre:BYT_Or command.

Description
  • This command sets or queries which byte of binary waveform data is transmitted first, during a waveform data transfer, when data points require more than one byte. This specification only has meaning when WFMOUTPRE:ENCDG is set to BIN.
Usage
  • Using the .query() method will send the WFMOutpre:BYT_Or? query.
  • Using the .verify(value) method will send the WFMOutpre:BYT_Or? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:BYT_Or value command.
SCPI Syntax
- WFMOutpre:BYT_Or {LSB|MSB}
- WFMOutpre:BYT_Or?
Info
  • LSB specifies that the least significant byte will be transmitted first.
  • MSB specifies that the most significant byte will be transmitted first.

centerfrequency property

centerfrequency: WfmoutpreCenterfrequency

Return the WFMOutpre:CENTERFREQuency command.

Description
  • This query returns the center frequency of the outgoing waveform. The center frequency is a precise frequency at the center of the display of the frequency domain graticule. In many applications, it is a carrier frequency.
Usage
  • Using the .query() method will send the WFMOutpre:CENTERFREQuency? query.
  • Using the .verify(value) method will send the WFMOutpre:CENTERFREQuency? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:CENTERFREQuency?

domain property

Return the WFMOutpre:DOMain command.

Description
  • This query returns the domain of the outgoing waveform, either TIMe or FREQuency. If the domain is TIMe, it indicates that the data is to be treated as integer information. If the domain is FREQuency, it indicates that the data is to be treated as floating point information.
Usage
  • Using the .query() method will send the WFMOutpre:DOMain? query.
  • Using the .verify(value) method will send the WFMOutpre:DOMain? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:DOMain?

encdg property

Return the WFMOutpre:ENCdg command.

Description
  • This command sets or queries the type of encoding for outgoing waveforms.
Usage
  • Using the .query() method will send the WFMOutpre:ENCdg? query.
  • Using the .verify(value) method will send the WFMOutpre:ENCdg? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:ENCdg value command.
SCPI Syntax
- WFMOutpre:ENCdg {ASCii|BINary}
- WFMOutpre:ENCdg?
Info
  • ASCii specifies that the outgoing data is to be in ASCII format. Waveforms internally stored as integers will be sent as numbers, while those stored as floating point will be sent as numbers.
  • BINary specifies that outgoing data is to be in a binary format whose further specification is determined by WFMOUTPRE:BYT_NR, WFMOUTPRE:BIT_NR, WFMOUTPRE:BN_FMT and WFMOUTPRE:BYT_OR.

nr_pt property

Return the WFMOutpre:NR_Pt command.

Description
  • This query-only command returns the number of points for the DATA:SOURCE waveform that will be transmitted in response to a CURVE? query.
Usage
  • Using the .query() method will send the WFMOutpre:NR_Pt? query.
  • Using the .verify(value) method will send the WFMOutpre:NR_Pt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:NR_Pt?

pt_fmt property

Return the WFMOutpre:PT_Fmt command.

Description
  • This query-only command returns the point format for the waveform specified by the DATA:SOURCE command. The format specifies a set of equations describing how the scale factors in the preamble are used to give meaning to the CURVE data points. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:PT_Fmt? query.
  • Using the .verify(value) method will send the WFMOutpre:PT_Fmt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:PT_Fmt?

pt_off property

Return the WFMOutpre:PT_Off command.

Description
  • This query-only command returns the trigger point relative to DATA:START for the waveform specified by the DATA:SOURCE command.
Usage
  • Using the .query() method will send the WFMOutpre:PT_Off? query.
  • Using the .verify(value) method will send the WFMOutpre:PT_Off? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:PT_Off?

pt_order property

pt_order: WfmoutprePtOrder

Return the WFMOutpre:PT_ORder command.

Description
  • This query-only command specifies whether the source waveform is Fast Acquisition. A Fast Acquisition waveform is stored as a 500 (vertical) by 1000 (horizontal) point bitmap. Each point represents display intensity for that screen location. Only CURVe? query functions are allowed on Fast Acquisition waveforms. When the WFMOutpre:PT_ORder? query returns Row, this indicates that the source is a Fast Acquisition waveform (and that each of 1000 possible horizontal columns being transmitted contains 500 vertical points. Note: 500 might vary based on how many channels enabled from same FastAcq group.) and waveform points are transmitted in the following order: left to right; then top to bottom. When the WFMOutpre:PT_ORder? query returns Linear, this indicates that the source is not a Fast Acquisition waveform (and that each horizontal column being sent contains only one vertical point). Note that waveform points are transmitted in the following order: top to bottom, then left to right.
Usage
  • Using the .query() method will send the WFMOutpre:PT_ORder? query.
  • Using the .verify(value) method will send the WFMOutpre:PT_ORder? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:PT_ORder?

reflevel property

Return the WFMOutpre:REFLEvel command.

Description
  • This query returns the Reference Level of the outgoing waveform. It applies only to the four frequency domain waveforms (RF Normal, RF Average, RF Max Hold, and RF Min Hold). The units are in watts.
Usage
  • Using the .query() method will send the WFMOutpre:REFLEvel? query.
  • Using the .verify(value) method will send the WFMOutpre:REFLEvel? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:REFLEvel?

span property

Return the WFMOutpre:SPAN command.

Description
  • This query returns the frequency span of the outgoing waveform. The span is the range of frequencies you can observe around the center frequency.
Usage
  • Using the .query() method will send the WFMOutpre:SPAN? query.
  • Using the .verify(value) method will send the WFMOutpre:SPAN? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:SPAN?

wfid property

Return the WFMOutpre:WFId command.

Description
  • This query-only command returns a string describing several aspects of the acquisition parameters for the waveform specified by the DATA:SOURCE command. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:WFId? query.
  • Using the .verify(value) method will send the WFMOutpre:WFId? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:WFId?

wfmtype property

Return the WFMOutpre:WFMTYPe command.

Description
  • This query returns the type of the outgoing waveform. The type of waveform that is being transferred in turn determines in which window it will display on the instrument screen: (the Waveform View window or Spectrum View window). Both the Analog and RF_TD arguments specify the time domain window; the RF_RD argument specifies the frequency domain window.
Usage
  • Using the .query() method will send the WFMOutpre:WFMTYPe? query.
  • Using the .verify(value) method will send the WFMOutpre:WFMTYPe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:WFMTYPe?

xincr property

Return the WFMOutpre:XINcr command.

Description
  • This query-only command returns the horizontal point spacing in units of WFMOutpre:XUNit for the waveform specified by the DATA:SOURCE command. This value corresponds to the sampling interval. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:XINcr? query.
  • Using the .verify(value) method will send the WFMOutpre:XINcr? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:XINcr?

xunit property

Return the WFMOutpre:XUNit command.

Description
  • This query-only command returns the horizontal units for the waveform specified by the DATA:SOURCE command. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:XUNit? query.
  • Using the .verify(value) method will send the WFMOutpre:XUNit? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:XUNit?

xzero property

Return the WFMOutpre:XZEro command.

Description
  • This query-only command returns the sub-sample time between the trigger sample (designated by PT_OFF) and the occurrence of the actual trigger for the waveform specified by the DATA:SOURCE command. This value is in units of WFMOutpre:XUNit. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:XZEro? query.
  • Using the .verify(value) method will send the WFMOutpre:XZEro? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:XZEro?

ymult property

Return the WFMOutpre:YMUlt command.

Description
  • This query-only command returns the vertical scale factor per digitizing level in units specified by WFMOutpre:YUNit for the waveform specified by the DATA:SOURCE command. For those formats in which WFMOUTPRE:BYT_NR is important (all non-floating point formats), WFMOutpre:YMUlt? must take the location of the binary point implied by BYT_NR into consideration. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:YMUlt? query.
  • Using the .verify(value) method will send the WFMOutpre:YMUlt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:YMUlt?

yoff property

Return the WFMOutpre:YOFf command.

Description
  • This query-only command returns the vertical offset of the source specified by DATA:SOURCE. For this instrument family, the value returned is always 0.0 as the offset is combined with the :YZEro value. An error is reported if the DATA:SOURCE waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:YOFf? query.
  • Using the .verify(value) method will send the WFMOutpre:YOFf? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:YOFf?

yunit property

Return the WFMOutpre:YUNit command.

Description
  • This query-only command returns the vertical units for the waveform specified by the DATA:SOURCE command. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:YUNit? query.
  • Using the .verify(value) method will send the WFMOutpre:YUNit? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:YUNit?

yzero property

Return the WFMOutpre:YZEro command.

Description
  • This query-only command returns the combined vertical position and offset for the source waveform specified by DATA:SOURCE. This represents a departure from previous instruments where the :YZEro value represented the vertical position in vertical units and the :YOFf value represented the vertical offset in digitizing levels. For this instrument family, the value of :YOFf is always 0.0. An error is reported if the DATA:SOURCE waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:YZEro? query.
  • Using the .verify(value) method will send the WFMOutpre:YZEro? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:YZEro?

WfmoutpreBitNr

Bases: SCPICmdWrite, SCPICmdRead

The WFMOutpre:BIT_Nr command.

Description
  • This command sets and queries the number of bits per waveform point that outgoing waveforms contain, as specified by the DATA:SOURCE command. Note that values will be constrained according to the underlying waveform data. This specification is only meaningful when WFMOUTPRE:ENCDG is set to BIN and WFMOUTPRE:BN_FMT is set to either RI or RP.
Usage
  • Using the .query() method will send the WFMOutpre:BIT_Nr? query.
  • Using the .verify(value) method will send the WFMOutpre:BIT_Nr? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:BIT_Nr value command.
SCPI Syntax
- WFMOutpre:BIT_Nr <NR1>
- WFMOutpre:BIT_Nr?
Info
  • <NR1> number of bits per data point can be 8 or 16.

WfmoutpreBnFmt

Bases: SCPICmdWrite, SCPICmdRead

The WFMOutpre:BN_Fmt command.

Description
  • This command sets or queries the format of binary data for outgoing waveforms specified by the DATA:SOURCE command.
Usage
  • Using the .query() method will send the WFMOutpre:BN_Fmt? query.
  • Using the .verify(value) method will send the WFMOutpre:BN_Fmt? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:BN_Fmt value command.
SCPI Syntax
- WFMOutpre:BN_Fmt {RI|RP|FP}
- WFMOutpre:BN_Fmt?
Info
  • RI specifies signed integer data point representation.
  • RP specifies positive integer data point representation.
  • FP specifies floating point representation.

WfmoutpreBytNr

Bases: SCPICmdWrite, SCPICmdRead

The WFMOutpre:BYT_Nr command.

Description
  • This command sets or queries the binary field data width (bytes per point) for the waveform specified by the DATA:SOURCE command. Note that values will be constrained according to the underlying waveform data. This specification is only meaningful when WFMOUTPRE:ENCDG is set to BIN, and WFMOUTPRE:BN_FMT is set to either RI or RP.
Usage
  • Using the .query() method will send the WFMOutpre:BYT_Nr? query.
  • Using the .verify(value) method will send the WFMOutpre:BYT_Nr? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:BYT_Nr value command.
SCPI Syntax
- WFMOutpre:BYT_Nr <NR1>
- WFMOutpre:BYT_Nr?
Info
  • <NR1> is the number of bytes per data point and can be 1, 2 or 8. A value of 1 or 2 bytes per waveform point indicates channel data; 8 bytes per waveform point indicate pixel map (fast acquisition) data.

WfmoutpreBytOr

Bases: SCPICmdWrite, SCPICmdRead

The WFMOutpre:BYT_Or command.

Description
  • This command sets or queries which byte of binary waveform data is transmitted first, during a waveform data transfer, when data points require more than one byte. This specification only has meaning when WFMOUTPRE:ENCDG is set to BIN.
Usage
  • Using the .query() method will send the WFMOutpre:BYT_Or? query.
  • Using the .verify(value) method will send the WFMOutpre:BYT_Or? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:BYT_Or value command.
SCPI Syntax
- WFMOutpre:BYT_Or {LSB|MSB}
- WFMOutpre:BYT_Or?
Info
  • LSB specifies that the least significant byte will be transmitted first.
  • MSB specifies that the most significant byte will be transmitted first.

WfmoutpreCenterfrequency

Bases: SCPICmdRead

The WFMOutpre:CENTERFREQuency command.

Description
  • This query returns the center frequency of the outgoing waveform. The center frequency is a precise frequency at the center of the display of the frequency domain graticule. In many applications, it is a carrier frequency.
Usage
  • Using the .query() method will send the WFMOutpre:CENTERFREQuency? query.
  • Using the .verify(value) method will send the WFMOutpre:CENTERFREQuency? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:CENTERFREQuency?

WfmoutpreDomain

Bases: SCPICmdRead

The WFMOutpre:DOMain command.

Description
  • This query returns the domain of the outgoing waveform, either TIMe or FREQuency. If the domain is TIMe, it indicates that the data is to be treated as integer information. If the domain is FREQuency, it indicates that the data is to be treated as floating point information.
Usage
  • Using the .query() method will send the WFMOutpre:DOMain? query.
  • Using the .verify(value) method will send the WFMOutpre:DOMain? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:DOMain?

WfmoutpreEncdg

Bases: SCPICmdWrite, SCPICmdRead

The WFMOutpre:ENCdg command.

Description
  • This command sets or queries the type of encoding for outgoing waveforms.
Usage
  • Using the .query() method will send the WFMOutpre:ENCdg? query.
  • Using the .verify(value) method will send the WFMOutpre:ENCdg? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the WFMOutpre:ENCdg value command.
SCPI Syntax
- WFMOutpre:ENCdg {ASCii|BINary}
- WFMOutpre:ENCdg?
Info
  • ASCii specifies that the outgoing data is to be in ASCII format. Waveforms internally stored as integers will be sent as numbers, while those stored as floating point will be sent as numbers.
  • BINary specifies that outgoing data is to be in a binary format whose further specification is determined by WFMOUTPRE:BYT_NR, WFMOUTPRE:BIT_NR, WFMOUTPRE:BN_FMT and WFMOUTPRE:BYT_OR.

WfmoutpreNrPt

Bases: SCPICmdRead

The WFMOutpre:NR_Pt command.

Description
  • This query-only command returns the number of points for the DATA:SOURCE waveform that will be transmitted in response to a CURVE? query.
Usage
  • Using the .query() method will send the WFMOutpre:NR_Pt? query.
  • Using the .verify(value) method will send the WFMOutpre:NR_Pt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:NR_Pt?

WfmoutprePtFmt

Bases: SCPICmdRead

The WFMOutpre:PT_Fmt command.

Description
  • This query-only command returns the point format for the waveform specified by the DATA:SOURCE command. The format specifies a set of equations describing how the scale factors in the preamble are used to give meaning to the CURVE data points. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:PT_Fmt? query.
  • Using the .verify(value) method will send the WFMOutpre:PT_Fmt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:PT_Fmt?

WfmoutprePtOff

Bases: SCPICmdRead

The WFMOutpre:PT_Off command.

Description
  • This query-only command returns the trigger point relative to DATA:START for the waveform specified by the DATA:SOURCE command.
Usage
  • Using the .query() method will send the WFMOutpre:PT_Off? query.
  • Using the .verify(value) method will send the WFMOutpre:PT_Off? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:PT_Off?

WfmoutprePtOrder

Bases: SCPICmdRead

The WFMOutpre:PT_ORder command.

Description
  • This query-only command specifies whether the source waveform is Fast Acquisition. A Fast Acquisition waveform is stored as a 500 (vertical) by 1000 (horizontal) point bitmap. Each point represents display intensity for that screen location. Only CURVe? query functions are allowed on Fast Acquisition waveforms. When the WFMOutpre:PT_ORder? query returns Row, this indicates that the source is a Fast Acquisition waveform (and that each of 1000 possible horizontal columns being transmitted contains 500 vertical points. Note: 500 might vary based on how many channels enabled from same FastAcq group.) and waveform points are transmitted in the following order: left to right; then top to bottom. When the WFMOutpre:PT_ORder? query returns Linear, this indicates that the source is not a Fast Acquisition waveform (and that each horizontal column being sent contains only one vertical point). Note that waveform points are transmitted in the following order: top to bottom, then left to right.
Usage
  • Using the .query() method will send the WFMOutpre:PT_ORder? query.
  • Using the .verify(value) method will send the WFMOutpre:PT_ORder? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:PT_ORder?

WfmoutpreReflevel

Bases: SCPICmdRead

The WFMOutpre:REFLEvel command.

Description
  • This query returns the Reference Level of the outgoing waveform. It applies only to the four frequency domain waveforms (RF Normal, RF Average, RF Max Hold, and RF Min Hold). The units are in watts.
Usage
  • Using the .query() method will send the WFMOutpre:REFLEvel? query.
  • Using the .verify(value) method will send the WFMOutpre:REFLEvel? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:REFLEvel?

WfmoutpreSpan

Bases: SCPICmdRead

The WFMOutpre:SPAN command.

Description
  • This query returns the frequency span of the outgoing waveform. The span is the range of frequencies you can observe around the center frequency.
Usage
  • Using the .query() method will send the WFMOutpre:SPAN? query.
  • Using the .verify(value) method will send the WFMOutpre:SPAN? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:SPAN?

WfmoutpreWfid

Bases: SCPICmdRead

The WFMOutpre:WFId command.

Description
  • This query-only command returns a string describing several aspects of the acquisition parameters for the waveform specified by the DATA:SOURCE command. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:WFId? query.
  • Using the .verify(value) method will send the WFMOutpre:WFId? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:WFId?

WfmoutpreWfmtype

Bases: SCPICmdRead

The WFMOutpre:WFMTYPe command.

Description
  • This query returns the type of the outgoing waveform. The type of waveform that is being transferred in turn determines in which window it will display on the instrument screen: (the Waveform View window or Spectrum View window). Both the Analog and RF_TD arguments specify the time domain window; the RF_RD argument specifies the frequency domain window.
Usage
  • Using the .query() method will send the WFMOutpre:WFMTYPe? query.
  • Using the .verify(value) method will send the WFMOutpre:WFMTYPe? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:WFMTYPe?

WfmoutpreXincr

Bases: SCPICmdRead

The WFMOutpre:XINcr command.

Description
  • This query-only command returns the horizontal point spacing in units of WFMOutpre:XUNit for the waveform specified by the DATA:SOURCE command. This value corresponds to the sampling interval. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:XINcr? query.
  • Using the .verify(value) method will send the WFMOutpre:XINcr? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:XINcr?

WfmoutpreXunit

Bases: SCPICmdRead

The WFMOutpre:XUNit command.

Description
  • This query-only command returns the horizontal units for the waveform specified by the DATA:SOURCE command. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:XUNit? query.
  • Using the .verify(value) method will send the WFMOutpre:XUNit? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:XUNit?

WfmoutpreXzero

Bases: SCPICmdRead

The WFMOutpre:XZEro command.

Description
  • This query-only command returns the sub-sample time between the trigger sample (designated by PT_OFF) and the occurrence of the actual trigger for the waveform specified by the DATA:SOURCE command. This value is in units of WFMOutpre:XUNit. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:XZEro? query.
  • Using the .verify(value) method will send the WFMOutpre:XZEro? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:XZEro?

WfmoutpreYmult

Bases: SCPICmdRead

The WFMOutpre:YMUlt command.

Description
  • This query-only command returns the vertical scale factor per digitizing level in units specified by WFMOutpre:YUNit for the waveform specified by the DATA:SOURCE command. For those formats in which WFMOUTPRE:BYT_NR is important (all non-floating point formats), WFMOutpre:YMUlt? must take the location of the binary point implied by BYT_NR into consideration. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:YMUlt? query.
  • Using the .verify(value) method will send the WFMOutpre:YMUlt? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:YMUlt?

WfmoutpreYoff

Bases: SCPICmdRead

The WFMOutpre:YOFf command.

Description
  • This query-only command returns the vertical offset of the source specified by DATA:SOURCE. For this instrument family, the value returned is always 0.0 as the offset is combined with the :YZEro value. An error is reported if the DATA:SOURCE waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:YOFf? query.
  • Using the .verify(value) method will send the WFMOutpre:YOFf? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:YOFf?

WfmoutpreYunit

Bases: SCPICmdRead

The WFMOutpre:YUNit command.

Description
  • This query-only command returns the vertical units for the waveform specified by the DATA:SOURCE command. An error is reported if the DATa:SOUrce waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:YUNit? query.
  • Using the .verify(value) method will send the WFMOutpre:YUNit? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:YUNit?

WfmoutpreYzero

Bases: SCPICmdRead

The WFMOutpre:YZEro command.

Description
  • This query-only command returns the combined vertical position and offset for the source waveform specified by DATA:SOURCE. This represents a departure from previous instruments where the :YZEro value represented the vertical position in vertical units and the :YOFf value represented the vertical offset in digitizing levels. For this instrument family, the value of :YOFf is always 0.0. An error is reported if the DATA:SOURCE waveform does not exist.
Usage
  • Using the .query() method will send the WFMOutpre:YZEro? query.
  • Using the .verify(value) method will send the WFMOutpre:YZEro? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax
- WFMOutpre:YZEro?