data ¶

The data commands module.

These commands are used in the following models: DPO7AX

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

Please report an issue if one is found.

Commands and Queries

- DATa {INIT|SNAp}
- DATa:ENCdg {ASCIi|RIBinary|RPBinary|FPBinary|SRIbinary|SRPbinary|SFPbinary}
- DATa:ENCdg?
- DATa:MODe {VECtor|PIXmap}
- DATa:MODe?
- DATa:RESample <NR1>
- DATa:RESample?
- DATa:SOUrce <wfm>[<,><wfm>]
- DATa:SOUrce:AVAILable?
- DATa:SOUrce?
- DATa:STARt <NR1>
- DATa:STARt?
- DATa:STOP <NR1>
- DATa:STOP?
- DATa:WIDth <NR1>
- DATa:WIDth?
- DATa?

Data ¶

Bases: SCPICmdWrite, SCPICmdRead

The DATa command.

Description

This command sets or queries the format and location of the waveform data that is transferred with the CURVe? command.

Usage

Using the .query() method will send the DATa? query.
Using the .verify(value) method will send the DATa? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa value command.

SCPI Syntax

- DATa {INIT|SNAp}
- DATa?

Info

INIT initializes the waveform data parameters to their factory defaults except for DATa:STOP, which isset to the current acquisition record length.
SNAp Sets DATa:STARt and DATa:STOP to match the current waveform cursor positions of WAVEVIEW1 CURSOR1 if these waveform cursors are currently on. If these waveform cursors are not on when the DATa SNAp command is sent, it is silently ignored and DATa:STARt and :STOP remain unchanged.

Properties

.encdg: The DATa:ENCdg command.
.mode: The DATa:MODe command.
.resample: The DATa:RESample command.
.source: The DATa:SOUrce command.
.start: The DATa:STARt command.
.stop: The DATa:STOP command.
.width: The DATa:WIDth command.

encdg `property` ¶

encdg: DataEncdg

Return the DATa:ENCdg command.

Description

This command sets or queries the format of outgoing waveform data. This command is equivalent to setting WFMOutpre:ENCdg, WFMOutpre:BN_Fmt, and WFMOutpre:BYT_Or. Setting the DATa:ENGdg value causes the corresponding WFMOutpre values to be updated and vice versa. Note: Values are constrained (for outbound data) to the format of the data specified by DATa:SOUrce.

Usage

Using the .query() method will send the DATa:ENCdg? query.
Using the .verify(value) method will send the DATa:ENCdg? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:ENCdg value command.

SCPI Syntax

- DATa:ENCdg {ASCIi|RIBinary|RPBinary|FPBinary|SRIbinary|SRPbinary|SFPbinary}
- DATa:ENCdg?

Info

ASCIi specifies the ASCII representation of signed INT, FLOAT. If ASCII is the value, then :BN_Fmt and :BYT_Or are ignored. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = ASC ;:BN_Fmt = N/A ; :BYT_Or = N/A ; :BYT_NR = 1,2,4.
RIBinary specifies signed integer data-point representation, with the most significant byte transferred first. When :BYT_Nr is 1, the range from 0 through 255. When :BYT_Nr is 2, the range is from 0 to 65,535. When :BYT_Nr is 4, then the waveform being queried would return Fast Acquisition Pixmap data (if fastacq is turned on and data mode is set to pixmap). The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ;:BN_Fmt = RI ; :BYT_Or = MSB ; :BYT_NR = 1,2.
RPBinary specifies the positive integer data-point representation, with the most significant byte transferred first. When :BYT_Nr is 1, the range from 0 through 255. When :BYT_Nr is 2, the range is from 0 to 65,535. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ; :BN_Fmt = RP ; :BYT_Or = MSB ; :BYT_NR = 1,2.
FPBinary specifies the floating point (width = 4) data. The range is from -3.4 ×1038 to 3.4 × 1038. The center of the screen is 0. The upper limit is the top of the screen and the lower limit is the bottom of the screen. The FPBinary argument is only applicable to math waveforms or ref waveforms saved from math waveforms. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ; :BN_Fmt = FP ; :BYT_Or = MSB ; :BYT_NR = 4.
SRIbinary is the same as RIBinary except that the byte order is swapped, meaning that the least significant byte is transferred first. This format is useful when transferring data to IBM compatible PCs. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ;:BN_Fmt = RI ; :BYT_Or = LSB ; :BYT_NR = 1,2.
SRPbinary is the same as RPBinary except that the byte order is swapped, meaning that the least significant byte is transferred first. This format is useful when transferring data to PCs. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ; :BN_Fmt = RP; :BYT_Or = LSB ; :BYT_NR = 1,2.
SFPbinary specifies floating point data in IBM PC format. The SFP binary argument only works on math waveforms or ref waveforms saved from math waveforms. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ; :BN_Fmt = FP ; :BYT_Or = LSB; :BYT_NR = 4.

mode `property` ¶

mode: DataMode

Return the DATa:MODe command.

Description

This command sets or queries the mode for waveform data sent to returned by CURVe?. When FastAcq mode is ON, and the value is PIXmap, it returns Fast Acquisition pixmap data or the vector data is returned. When the data mode is set as VECtor then you get the waveform sampled data. The Data width is reset to 1 or 2 instead of 4.

Usage

Using the .query() method will send the DATa:MODe? query.
Using the .verify(value) method will send the DATa:MODe? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:MODe value command.

SCPI Syntax

- DATa:MODe {VECtor|PIXmap}
- DATa:MODe?

Info

VECtor sets the mode for waveform data to vector.
PIXmap sets the mode for waveform data to pixmap.

resample `property` ¶

resample: DataResample

Return the DATa:RESample command.

Description

This command sets or queries the resampling of outgoing waveform data. This command is equivalent to setting WFMOutpre:RESample. Setting the DATa:RESample value causes the corresponding WFMOutpre value to be updated and vice versa.

Usage

Using the .query() method will send the DATa:RESample? query.
Using the .verify(value) method will send the DATa:RESample? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:RESample value command.

SCPI Syntax

- DATa:RESample <NR1>
- DATa:RESample?

Info

<NR1> is the resampling rate. The default value is 1, whichmeans every sampleis returned. A value of 2 returns every other sample, while a value of 3 returnsevery third sample, and so on.

source `property` ¶

source: DataSource

Return the DATa:SOUrce command.

Description

This command sets or queries the location of waveform data that is transferred from the instrument by the CURVe? Query.

Usage

Using the .query() method will send the DATa:SOUrce? query.
Using the .verify(value) method will send the DATa:SOUrce? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:SOUrce value command.

SCPI Syntax

- DATa:SOUrce <wfm>[<,><wfm>]
- DATa:SOUrce?

Info

<wfm> is the location of the waveform data that will be transferred from the instrument to the controller. It can consist of CH, MATH, REF,DIGITALALL. Note that digital data is transferred as 16-bit data, with the least-significant bit representing D0, and the most-significant bit representing D15.
<wfm> can consist of the following.
CH<x> selects the specified analog channel as the source.
MATH<x> selects the specified reference waveform as the source. The reference number is specified by x, which ranges from 1 through 4.
REF<x> selects the specified reference waveform as the source. The reference number is specified by x, which ranges from 1 through 8.
CH<x>_D<x> selects the specified digital channel.
CH<x>_DAll selects the specified channel group of digital channels.
DIGITALALL selects digital waveforms as the source. The Digital data istransferred as 16-bit data, with the least-significant bit representing D0, and the most-significant bit representing D15. The LSB always contains D0-D7 and MSB always contains D8-D15 data.
CH<x>_SV_NORMal , CH<x>_SV_AVErage, CH<x>_SV_MAX_Hold, CH<x>_SV_MIN_Hold selects the specified Spectrum View waveform.
CH<x>_MAG_VS_TIME , CH<x>_FREQ_VS_TIME, CH<x>_PHASE_VS_TIME selects the specified RF vs. Time waveform.
CH<x>_SV_BASEBAND_IQ selects the specified RF baseband IQ data.

Sub-properties

.available: The DATa:SOUrce:AVAILable command.

start `property` ¶

start: DataStart

Return the DATa:STARt command.

Description

This command sets or queries the starting data point for waveform transfer. This command allows for the transfer of partial waveforms to and from the instrument. Data will be transferred from to DATa:STOP or the record length, whichever is less. If is greater than the record length, the last data point in the record is transferred. DATa:STARt and DATa:STOP are order independent. When DATa:STOP is greater than DATa:STARt, the values will be swapped internally for the CURVE? query.

Usage

Using the .query() method will send the DATa:STARt? query.
Using the .verify(value) method will send the DATa:STARt? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:STARt value command.

SCPI Syntax

- DATa:STARt <NR1>
- DATa:STARt?

Info

<NR1> is the first data point that will be transferred, which ranges from 1 to the record length.

stop `property` ¶

stop: DataStop

Return the DATa:STOP command.

Description

This command sets or queries the last data point that will be transferred when using the CURVe?? query. When using the CURVe? command, DATa:STOP is ignored. This command allows for the transfer of partial waveforms to the controller. If is greater than the record length, then data will be transferred up to the record length. If both DATa:STARt and DATa:STOP are greater than the record length, the last data point in the record is returned. DATa:STARt and DATa:STOP are order independent. When DATa:STOP is less than DATa:STARt, the values will be swapped internally for the CURVE? query. If you always want to transfer complete waveforms, set DATa:STARt to 1 and DATa:STOP to the maximum record length, or larger. Changes to the record length value are not automatically reflected in the DATa:STOP value. As record length is varied, the DATa:STOP value must be explicitly changed to ensure the entire record is transmitted. In other words, curve results will not automatically and correctly reflect increases in record length if the distance from DATa:STARt to DATa:STOP stays smaller than the increased record length.

Usage

Using the .query() method will send the DATa:STOP? query.
Using the .verify(value) method will send the DATa:STOP? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:STOP value command.

SCPI Syntax

- DATa:STOP <NR1>
- DATa:STOP?

Info

<NR1> is the last data point that will be transferred, which ranges from 1 to the record length.

width `property` ¶

width: DataWidth

Return the DATa:WIDth command.

Description

This command specifies the width, in bytes per point, for waveform data transferred from the instrument via the CURVe? query. (This command is synonymous with WFMOutpre:BYT_Nr.)

Usage

Using the .query() method will send the DATa:WIDth? query.
Using the .verify(value) method will send the DATa:WIDth? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:WIDth value command.

SCPI Syntax

- DATa:WIDth <NR1>
- DATa:WIDth?

Info

<NR1> is an integer that indicates the number of bytes per point for the outgoing waveform data when queried using the CURVe? command.

DataEncdg ¶

Bases: SCPICmdWrite, SCPICmdRead

The DATa:ENCdg command.

Description

This command sets or queries the format of outgoing waveform data. This command is equivalent to setting WFMOutpre:ENCdg, WFMOutpre:BN_Fmt, and WFMOutpre:BYT_Or. Setting the DATa:ENGdg value causes the corresponding WFMOutpre values to be updated and vice versa. Note: Values are constrained (for outbound data) to the format of the data specified by DATa:SOUrce.

Usage

Using the .query() method will send the DATa:ENCdg? query.
Using the .verify(value) method will send the DATa:ENCdg? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:ENCdg value command.

SCPI Syntax

- DATa:ENCdg {ASCIi|RIBinary|RPBinary|FPBinary|SRIbinary|SRPbinary|SFPbinary}
- DATa:ENCdg?

Info

ASCIi specifies the ASCII representation of signed INT, FLOAT. If ASCII is the value, then :BN_Fmt and :BYT_Or are ignored. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = ASC ;:BN_Fmt = N/A ; :BYT_Or = N/A ; :BYT_NR = 1,2,4.
RIBinary specifies signed integer data-point representation, with the most significant byte transferred first. When :BYT_Nr is 1, the range from 0 through 255. When :BYT_Nr is 2, the range is from 0 to 65,535. When :BYT_Nr is 4, then the waveform being queried would return Fast Acquisition Pixmap data (if fastacq is turned on and data mode is set to pixmap). The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ;:BN_Fmt = RI ; :BYT_Or = MSB ; :BYT_NR = 1,2.
RPBinary specifies the positive integer data-point representation, with the most significant byte transferred first. When :BYT_Nr is 1, the range from 0 through 255. When :BYT_Nr is 2, the range is from 0 to 65,535. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ; :BN_Fmt = RP ; :BYT_Or = MSB ; :BYT_NR = 1,2.
FPBinary specifies the floating point (width = 4) data. The range is from -3.4 ×1038 to 3.4 × 1038. The center of the screen is 0. The upper limit is the top of the screen and the lower limit is the bottom of the screen. The FPBinary argument is only applicable to math waveforms or ref waveforms saved from math waveforms. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ; :BN_Fmt = FP ; :BYT_Or = MSB ; :BYT_NR = 4.
SRIbinary is the same as RIBinary except that the byte order is swapped, meaning that the least significant byte is transferred first. This format is useful when transferring data to IBM compatible PCs. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ;:BN_Fmt = RI ; :BYT_Or = LSB ; :BYT_NR = 1,2.
SRPbinary is the same as RPBinary except that the byte order is swapped, meaning that the least significant byte is transferred first. This format is useful when transferring data to PCs. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ; :BN_Fmt = RP; :BYT_Or = LSB ; :BYT_NR = 1,2.
SFPbinary specifies floating point data in IBM PC format. The SFP binary argument only works on math waveforms or ref waveforms saved from math waveforms. The following are the DATa and WFMOutpre parameter settings (separated by semicolons): :ENCdg = BIN ; :BN_Fmt = FP ; :BYT_Or = LSB; :BYT_NR = 4.

DataMode ¶

Bases: SCPICmdWrite, SCPICmdRead

The DATa:MODe command.

Description

This command sets or queries the mode for waveform data sent to returned by CURVe?. When FastAcq mode is ON, and the value is PIXmap, it returns Fast Acquisition pixmap data or the vector data is returned. When the data mode is set as VECtor then you get the waveform sampled data. The Data width is reset to 1 or 2 instead of 4.

Usage

Using the .query() method will send the DATa:MODe? query.
Using the .verify(value) method will send the DATa:MODe? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:MODe value command.

SCPI Syntax

- DATa:MODe {VECtor|PIXmap}
- DATa:MODe?

Info

VECtor sets the mode for waveform data to vector.
PIXmap sets the mode for waveform data to pixmap.

DataResample ¶

Bases: SCPICmdWrite, SCPICmdRead

The DATa:RESample command.

Description

This command sets or queries the resampling of outgoing waveform data. This command is equivalent to setting WFMOutpre:RESample. Setting the DATa:RESample value causes the corresponding WFMOutpre value to be updated and vice versa.

Usage

Using the .query() method will send the DATa:RESample? query.
Using the .verify(value) method will send the DATa:RESample? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:RESample value command.

SCPI Syntax

- DATa:RESample <NR1>
- DATa:RESample?

Info

<NR1> is the resampling rate. The default value is 1, whichmeans every sampleis returned. A value of 2 returns every other sample, while a value of 3 returnsevery third sample, and so on.

DataSource ¶

Bases: SCPICmdWrite, SCPICmdRead

The DATa:SOUrce command.

Description

This command sets or queries the location of waveform data that is transferred from the instrument by the CURVe? Query.

Usage

Using the .query() method will send the DATa:SOUrce? query.
Using the .verify(value) method will send the DATa:SOUrce? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:SOUrce value command.

SCPI Syntax

- DATa:SOUrce <wfm>[<,><wfm>]
- DATa:SOUrce?

Info

<wfm> is the location of the waveform data that will be transferred from the instrument to the controller. It can consist of CH, MATH, REF,DIGITALALL. Note that digital data is transferred as 16-bit data, with the least-significant bit representing D0, and the most-significant bit representing D15.
<wfm> can consist of the following.
CH<x> selects the specified analog channel as the source.
MATH<x> selects the specified reference waveform as the source. The reference number is specified by x, which ranges from 1 through 4.
REF<x> selects the specified reference waveform as the source. The reference number is specified by x, which ranges from 1 through 8.
CH<x>_D<x> selects the specified digital channel.
CH<x>_DAll selects the specified channel group of digital channels.
DIGITALALL selects digital waveforms as the source. The Digital data istransferred as 16-bit data, with the least-significant bit representing D0, and the most-significant bit representing D15. The LSB always contains D0-D7 and MSB always contains D8-D15 data.
CH<x>_SV_NORMal , CH<x>_SV_AVErage, CH<x>_SV_MAX_Hold, CH<x>_SV_MIN_Hold selects the specified Spectrum View waveform.
CH<x>_MAG_VS_TIME , CH<x>_FREQ_VS_TIME, CH<x>_PHASE_VS_TIME selects the specified RF vs. Time waveform.
CH<x>_SV_BASEBAND_IQ selects the specified RF baseband IQ data.

Properties

.available: The DATa:SOUrce:AVAILable command.

available `property` ¶

available: DataSourceAvailable

Return the DATa:SOUrce:AVAILable command.

Description

This query returns a list of enumerations representing the source waveforms that are currently available for :CURVe? queries. This means that the waveforms have been acquired. If there are none, NONE is returned.

Usage

Using the .query() method will send the DATa:SOUrce:AVAILable? query.
Using the .verify(value) method will send the DATa:SOUrce:AVAILable? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DATa:SOUrce:AVAILable?

DataSourceAvailable ¶

Bases: SCPICmdRead

The DATa:SOUrce:AVAILable command.

Description

This query returns a list of enumerations representing the source waveforms that are currently available for :CURVe? queries. This means that the waveforms have been acquired. If there are none, NONE is returned.

Usage

Using the .query() method will send the DATa:SOUrce:AVAILable? query.
Using the .verify(value) method will send the DATa:SOUrce:AVAILable? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- DATa:SOUrce:AVAILable?

DataStart ¶

Bases: SCPICmdWrite, SCPICmdRead

The DATa:STARt command.

Description

This command sets or queries the starting data point for waveform transfer. This command allows for the transfer of partial waveforms to and from the instrument. Data will be transferred from to DATa:STOP or the record length, whichever is less. If is greater than the record length, the last data point in the record is transferred. DATa:STARt and DATa:STOP are order independent. When DATa:STOP is greater than DATa:STARt, the values will be swapped internally for the CURVE? query.

Usage

Using the .query() method will send the DATa:STARt? query.
Using the .verify(value) method will send the DATa:STARt? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:STARt value command.

SCPI Syntax

- DATa:STARt <NR1>
- DATa:STARt?

Info

<NR1> is the first data point that will be transferred, which ranges from 1 to the record length.

DataStop ¶

Bases: SCPICmdWrite, SCPICmdRead

The DATa:STOP command.

Description

This command sets or queries the last data point that will be transferred when using the CURVe?? query. When using the CURVe? command, DATa:STOP is ignored. This command allows for the transfer of partial waveforms to the controller. If is greater than the record length, then data will be transferred up to the record length. If both DATa:STARt and DATa:STOP are greater than the record length, the last data point in the record is returned. DATa:STARt and DATa:STOP are order independent. When DATa:STOP is less than DATa:STARt, the values will be swapped internally for the CURVE? query. If you always want to transfer complete waveforms, set DATa:STARt to 1 and DATa:STOP to the maximum record length, or larger. Changes to the record length value are not automatically reflected in the DATa:STOP value. As record length is varied, the DATa:STOP value must be explicitly changed to ensure the entire record is transmitted. In other words, curve results will not automatically and correctly reflect increases in record length if the distance from DATa:STARt to DATa:STOP stays smaller than the increased record length.

Usage

Using the .query() method will send the DATa:STOP? query.
Using the .verify(value) method will send the DATa:STOP? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:STOP value command.

SCPI Syntax

- DATa:STOP <NR1>
- DATa:STOP?

Info

<NR1> is the last data point that will be transferred, which ranges from 1 to the record length.

DataWidth ¶

Bases: SCPICmdWrite, SCPICmdRead

The DATa:WIDth command.

Description

This command specifies the width, in bytes per point, for waveform data transferred from the instrument via the CURVe? query. (This command is synonymous with WFMOutpre:BYT_Nr.)

Usage

Using the .query() method will send the DATa:WIDth? query.
Using the .verify(value) method will send the DATa:WIDth? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the DATa:WIDth value command.

SCPI Syntax

- DATa:WIDth <NR1>
- DATa:WIDth?

Info

<NR1> is an integer that indicates the number of bytes per point for the outgoing waveform data when queried using the CURVe? command.

data ¶

Data ¶

encdg property ¶

mode property ¶

resample property ¶

source property ¶

start property ¶

stop property ¶

width property ¶

DataEncdg ¶

DataMode ¶

DataResample ¶

DataSource ¶

available property ¶

DataSourceAvailable ¶

DataStart ¶

DataStop ¶

DataWidth ¶

encdg `property` ¶

mode `property` ¶

resample `property` ¶

source `property` ¶

start `property` ¶

stop `property` ¶

width `property` ¶

available `property` ¶