cursor ¶

The cursor commands module.

These commands are used in the following models: MDO3K, MDO4KB, MDO4KC, MSO4KB

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

Please report an issue if one is found.

Commands and Queries

- CURSor:DDT?
- CURSor:FUNCtion {SCREEN|WAVEform|OFF}
- CURSor:FUNCtion?
- CURSor:HBArs:DELTa?
- CURSor:HBArs:POSITION<x> <NR3>
- CURSor:HBArs:POSITION<x>?
- CURSor:HBArs:UNIts {BASE|PERcent}
- CURSor:HBArs:UNIts?
- CURSor:HBArs:USE {CURrent|HALFgrat}
- CURSor:HBArs?
- CURSor:MODe {TRACk|INDependent}
- CURSor:MODe?
- CURSor:SOUrce {CH<x>|REF<x>|MATH|BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
- CURSor:SOUrce?
- CURSor:VBArs:ALTERNATE<x>?
- CURSor:VBArs:DELTa?
- CURSor:VBArs:HPOS<x>?
- CURSor:VBArs:POSITION<x> <NR3>
- CURSor:VBArs:POSITION<x>?
- CURSor:VBArs:UNIts {SEConds|HERtz|DEGrees|PERcent}
- CURSor:VBArs:UNIts?
- CURSor:VBArs:USE {CURrent|HALFgrat|FIVEdivs}
- CURSor:VBArs:VDELTa?
- CURSor:VBArs?
- CURSor:XY:POLar:RADIUS:DELta?
- CURSor:XY:POLar:RADIUS:POSITION<x>?
- CURSor:XY:POLar:RADIUS:UNIts?
- CURSor:XY:POLar:THETA:DELta?
- CURSor:XY:POLar:THETA:POSITION<x>?
- CURSor:XY:POLar:THETA:UNIts?
- CURSor:XY:PRODUCT:DELta?
- CURSor:XY:PRODUCT:POSITION<x>?
- CURSor:XY:PRODUCT:UNIts?
- CURSor:XY:RATIO:DELta?
- CURSor:XY:RATIO:POSITION<x>?
- CURSor:XY:RATIO:UNIts?
- CURSor:XY:READOUT {RECTangular|POLARCord|PRODuct|RATio}
- CURSor:XY:READOUT?
- CURSor:XY:RECTangular:X:DELta?
- CURSor:XY:RECTangular:X:POSITION<x> <NR3>
- CURSor:XY:RECTangular:X:POSITION<x>?
- CURSor:XY:RECTangular:X:UNIts?
- CURSor:XY:RECTangular:Y:DELta?
- CURSor:XY:RECTangular:Y:POSITION<x> <NR3>
- CURSor:XY:RECTangular:Y:POSITION<x>?
- CURSor:XY:RECTangular:Y:UNIts?
- CURSor?

Cursor ¶

Bases: SCPICmdRead

The CURSor command.

Description

Returns all of the current cursor settings.

Usage

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

SCPI Syntax

- CURSor?

Properties

.ddt: The CURSor:DDT command.
.function: The CURSor:FUNCtion command.
.hbars: The CURSor:HBArs command.
.mode: The CURSor:MODe command.
.source: The CURSor:SOUrce command.
.vbars: The CURSor:VBArs command.
.xy: The CURSor:XY command tree.

ddt `property` ¶

ddt: CursorDdt

Return the CURSor:DDT command.

Description

Returns the cursor deltaY/deltaT (dY/dT) readout.

Usage

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

SCPI Syntax

- CURSor:DDT?

function `property` ¶

function: CursorFunction

Return the CURSor:FUNCtion command.

Description

This command selects the cursor mode. In Waveform mode, the cursors are attached to the selected waveform; in Screen mode, cursors are attached to the display area .

Usage

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

SCPI Syntax

- CURSor:FUNCtion {SCREEN|WAVEform|OFF}
- CURSor:FUNCtion?

Info

SCREEN specifies to display both horizontal and vertical bar cursors, which measure the selected waveform in horizontal and vertical units. Use these cursors to measure anywhere in the waveform display area.
WAVEform specifies to display the paired cursors in YT display format for measuring waveform amplitude and time. In XY and XYZ format, these cursors indicate the amplitude positions of an XY pair (Ch1 vs Ch2 voltage, where Ch1 is the X axis and Ch2 is the Y axis) relative to the trigger.
OFF removes the cursors from the display.

hbars `property` ¶

hbars: CursorHbars

Return the CURSor:HBArs command.

Description

Returns the current settings for the horizontal bar cursors.

Usage

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

SCPI Syntax

- CURSor:HBArs?

Sub-properties

.delta: The CURSor:HBArs:DELTa command.
.position: The CURSor:HBArs:POSITION<x> command.
.units: The CURSor:HBArs:UNIts command.
.use: The CURSor:HBArs:USE command.

mode `property` ¶

mode: CursorMode

Return the CURSor:MODe command.

Description

This command specifies whether the two cursors move linked together in unison or separately. This command is equivalent to setting Linked to On or Off in the Cursor menu.

Usage

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

SCPI Syntax

- CURSor:MODe {TRACk|INDependent}
- CURSor:MODe?

Info

TRACk ties the navigational functionality of the two cursors together. For cursor 1 adjustments, this ties the movement of the two cursors together; however, cursor 2 continues to move independently of cursor 1. This mode only applies when the DISPLAY:XY:WITHYT is set to OFF.
INDependent allows independent adjustment of the two cursors.

source `property` ¶

source: CursorSource

Return the CURSor:SOUrce command.

Description

This command specifies the cursor source waveform, which can be one of channels 1-4, reference waveforms 1-4, math waveform, bus 1-4 (1-3 for the MDO4000C and 1-2 for the MDO3000), digital channels 0-15 (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO or MDO4MSO installed), the RF time domain traces (MDO4000/B/C models), or AUTO. When the cursor source is set to AUTO, cursor readouts apply to the currently selected waveform.

Usage

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

SCPI Syntax

- CURSor:SOUrce {CH<x>|REF<x>|MATH|BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
- CURSor:SOUrce?

Info

CH<x> - specifies one of the analog waveforms as the cursor source. x has a minimum of 1 and a maximum of 4.
REF<x> - specifies one of the reference waveforms as the cursor source. x has a minimum of 1 and a maximum of 4.
MATH - specifies the cursor source as the math waveform.
BUS<x> - specifies the cursor source as one of the bus waveforms. x has a minimum of 1 and a maximum of 4.
D<x> - specifies the cursor source as one of the digital waveforms. (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO or MDO4MSO installed.) x has a minimum of 0 and a maximum of 15.
RF_AMPlitude - specifies the cursor source as one of the RF time domain traces (Amplitude vs. Time, Frequency vs. Time or Phase vs. Time). (MDO4000/B/C series models only.).
RF_FREQuency - specifies the cursor source as one of the RF time domain traces (Amplitude vs. Time, Frequency vs. Time or Phase vs. Time). (MDO4000/B/C series models only.).
RF_PHASe - specifies the cursor source as one of the RF time domain traces (Amplitude vs. Time, Frequency vs. Time or Phase vs. Time). (MDO4000/B/C series models only.).
AUTO - specifies the currently selected waveform. The selected waveform can be determined by querying SELECT:CONTROL.

vbars `property` ¶

vbars: CursorVbars

Return the CURSor:VBArs command.

Description

Returns the current settings for the vertical bar cursors.

Usage

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

SCPI Syntax

- CURSor:VBArs?

Sub-properties

.alternate: The CURSor:VBArs:ALTERNATE<x> command.
.delta: The CURSor:VBArs:DELTa command.
.hpos: The CURSor:VBArs:HPOS<x> command.
.position: The CURSor:VBArs:POSITION<x> command.
.units: The CURSor:VBArs:UNIts command.
.use: The CURSor:VBArs:USE command.
.vdelta: The CURSor:VBArs:VDELTa command.

xy `property` ¶

xy: CursorXy

Return the CURSor:XY command tree.

Usage

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

Sub-properties

.polar: The CURSor:XY:POLar command tree.
.product: The CURSor:XY:PRODUCT command tree.
.ratio: The CURSor:XY:RATIO command tree.
.readout: The CURSor:XY:READOUT command.
.rectangular: The CURSor:XY:RECTangular command tree.

CursorDdt ¶

Bases: SCPICmdRead

The CURSor:DDT command.

Description

Returns the cursor deltaY/deltaT (dY/dT) readout.

Usage

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

SCPI Syntax

- CURSor:DDT?

CursorFunction ¶

Bases: SCPICmdWrite, SCPICmdRead

The CURSor:FUNCtion command.

Description

This command selects the cursor mode. In Waveform mode, the cursors are attached to the selected waveform; in Screen mode, cursors are attached to the display area .

Usage

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

SCPI Syntax

- CURSor:FUNCtion {SCREEN|WAVEform|OFF}
- CURSor:FUNCtion?

Info

SCREEN specifies to display both horizontal and vertical bar cursors, which measure the selected waveform in horizontal and vertical units. Use these cursors to measure anywhere in the waveform display area.
WAVEform specifies to display the paired cursors in YT display format for measuring waveform amplitude and time. In XY and XYZ format, these cursors indicate the amplitude positions of an XY pair (Ch1 vs Ch2 voltage, where Ch1 is the X axis and Ch2 is the Y axis) relative to the trigger.
OFF removes the cursors from the display.

CursorHbars ¶

Bases: SCPICmdRead

The CURSor:HBArs command.

Description

Returns the current settings for the horizontal bar cursors.

Usage

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

SCPI Syntax

- CURSor:HBArs?

Properties

.delta: The CURSor:HBArs:DELTa command.
.position: The CURSor:HBArs:POSITION<x> command.
.units: The CURSor:HBArs:UNIts command.
.use: The CURSor:HBArs:USE command.

delta `property` ¶

delta: CursorHbarsDelta

Return the CURSor:HBArs:DELTa command.

Description

Returns the vertical difference between the two horizontal bar cursors.

Usage

Using the .query() method will send the CURSor:HBArs:DELTa? query.
Using the .verify(value) method will send the CURSor:HBArs:DELTa? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:HBArs:DELTa?

position `property` ¶

position: dict[int, CursorHbarsPositionItem]

Return the CURSor:HBArs:POSITION<x> command.

Description

This command specifies the horizontal bar cursor position relative to ground, which is expressed in vertical units (usually volts). The cursor is specified by x, which can be 1 or 2.

Usage

Using the .query() method will send the CURSor:HBArs:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:HBArs:POSITION<x>? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURSor:HBArs:POSITION<x> value command.

SCPI Syntax

- CURSor:HBArs:POSITION<x> <NR3>
- CURSor:HBArs:POSITION<x>?

Info

<NR3> is a floating point number that specifies the cursor position relative to ground.

units `property` ¶

units: CursorHbarsUnits

Return the CURSor:HBArs:UNIts command.

Description

This command specifies the units for the horizontal bar cursors.

Usage

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

SCPI Syntax

- CURSor:HBArs:UNIts {BASE|PERcent}
- CURSor:HBArs:UNIts?

Info

BASE selects the vertical units for the selected waveform.
PERcent selects ratio cursors.

use `property` ¶

use: CursorHbarsUse

Return the CURSor:HBArs:USE command.

Description

This command specifies the horizontal bar cursor measurement scale. This command is only applicable when the ratio cursors are turned on.

Usage

Using the .write(value) method will send the CURSor:HBArs:USE value command.

SCPI Syntax

- CURSor:HBArs:USE {CURrent|HALFgrat}

Info

CURrent sets the H Bar measurement scale so that 0% is the current position of the lowest H Bar cursor and 100% is the current position of the highest H Bar cursor.
HALFgrat sets H Bar measurement scale so that half the screen major divisions is 100%, where 0% is -2.5 divisions and 100% is +2.5 divisions from the center horizontal graticule.

CursorHbarsDelta ¶

Bases: SCPICmdRead

The CURSor:HBArs:DELTa command.

Description

Returns the vertical difference between the two horizontal bar cursors.

Usage

Using the .query() method will send the CURSor:HBArs:DELTa? query.
Using the .verify(value) method will send the CURSor:HBArs:DELTa? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:HBArs:DELTa?

CursorHbarsPositionItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead

The CURSor:HBArs:POSITION<x> command.

Description

This command specifies the horizontal bar cursor position relative to ground, which is expressed in vertical units (usually volts). The cursor is specified by x, which can be 1 or 2.

Usage

Using the .query() method will send the CURSor:HBArs:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:HBArs:POSITION<x>? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURSor:HBArs:POSITION<x> value command.

SCPI Syntax

- CURSor:HBArs:POSITION<x> <NR3>
- CURSor:HBArs:POSITION<x>?

Info

<NR3> is a floating point number that specifies the cursor position relative to ground.

CursorHbarsUnits ¶

Bases: SCPICmdWrite, SCPICmdRead

The CURSor:HBArs:UNIts command.

Description

This command specifies the units for the horizontal bar cursors.

Usage

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

SCPI Syntax

- CURSor:HBArs:UNIts {BASE|PERcent}
- CURSor:HBArs:UNIts?

Info

BASE selects the vertical units for the selected waveform.
PERcent selects ratio cursors.

CursorHbarsUse ¶

Bases: SCPICmdWrite

The CURSor:HBArs:USE command.

Description

This command specifies the horizontal bar cursor measurement scale. This command is only applicable when the ratio cursors are turned on.

Usage

Using the .write(value) method will send the CURSor:HBArs:USE value command.

SCPI Syntax

- CURSor:HBArs:USE {CURrent|HALFgrat}

Info

CURrent sets the H Bar measurement scale so that 0% is the current position of the lowest H Bar cursor and 100% is the current position of the highest H Bar cursor.
HALFgrat sets H Bar measurement scale so that half the screen major divisions is 100%, where 0% is -2.5 divisions and 100% is +2.5 divisions from the center horizontal graticule.

CursorMode ¶

Bases: SCPICmdWrite, SCPICmdRead

The CURSor:MODe command.

Description

This command specifies whether the two cursors move linked together in unison or separately. This command is equivalent to setting Linked to On or Off in the Cursor menu.

Usage

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

SCPI Syntax

- CURSor:MODe {TRACk|INDependent}
- CURSor:MODe?

Info

TRACk ties the navigational functionality of the two cursors together. For cursor 1 adjustments, this ties the movement of the two cursors together; however, cursor 2 continues to move independently of cursor 1. This mode only applies when the DISPLAY:XY:WITHYT is set to OFF.
INDependent allows independent adjustment of the two cursors.

CursorSource ¶

Bases: SCPICmdWrite, SCPICmdRead

The CURSor:SOUrce command.

Description

This command specifies the cursor source waveform, which can be one of channels 1-4, reference waveforms 1-4, math waveform, bus 1-4 (1-3 for the MDO4000C and 1-2 for the MDO3000), digital channels 0-15 (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO or MDO4MSO installed), the RF time domain traces (MDO4000/B/C models), or AUTO. When the cursor source is set to AUTO, cursor readouts apply to the currently selected waveform.

Usage

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

SCPI Syntax

- CURSor:SOUrce {CH<x>|REF<x>|MATH|BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
- CURSor:SOUrce?

Info

CH<x> - specifies one of the analog waveforms as the cursor source. x has a minimum of 1 and a maximum of 4.
REF<x> - specifies one of the reference waveforms as the cursor source. x has a minimum of 1 and a maximum of 4.
MATH - specifies the cursor source as the math waveform.
BUS<x> - specifies the cursor source as one of the bus waveforms. x has a minimum of 1 and a maximum of 4.
D<x> - specifies the cursor source as one of the digital waveforms. (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO or MDO4MSO installed.) x has a minimum of 0 and a maximum of 15.
RF_AMPlitude - specifies the cursor source as one of the RF time domain traces (Amplitude vs. Time, Frequency vs. Time or Phase vs. Time). (MDO4000/B/C series models only.).
RF_FREQuency - specifies the cursor source as one of the RF time domain traces (Amplitude vs. Time, Frequency vs. Time or Phase vs. Time). (MDO4000/B/C series models only.).
RF_PHASe - specifies the cursor source as one of the RF time domain traces (Amplitude vs. Time, Frequency vs. Time or Phase vs. Time). (MDO4000/B/C series models only.).
AUTO - specifies the currently selected waveform. The selected waveform can be determined by querying SELECT:CONTROL.

CursorVbars ¶

Bases: SCPICmdRead

The CURSor:VBArs command.

Description

Returns the current settings for the vertical bar cursors.

Usage

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

SCPI Syntax

- CURSor:VBArs?

Properties

.alternate: The CURSor:VBArs:ALTERNATE<x> command.
.delta: The CURSor:VBArs:DELTa command.
.hpos: The CURSor:VBArs:HPOS<x> command.
.position: The CURSor:VBArs:POSITION<x> command.
.units: The CURSor:VBArs:UNIts command.
.use: The CURSor:VBArs:USE command.
.vdelta: The CURSor:VBArs:VDELTa command.

alternate `property` ¶

alternate: dict[int, CursorVbarsAlternateItem]

Return the CURSor:VBArs:ALTERNATE<x> command.

Description

Returns the alternate readout for the waveform (Vbar) cursors specified by . This alternate readout is in effect when the selected waveform is a bus or digital channel.

Usage

Using the .query() method will send the CURSor:VBArs:ALTERNATE<x>? query.
Using the .verify(value) method will send the CURSor:VBArs:ALTERNATE<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:VBArs:ALTERNATE<x>?

Info

X = 1 specifies vertical bar cursor1.
X = 2 specifies vertical bar cursor2.

delta `property` ¶

delta: CursorVbarsDelta

Return the CURSor:VBArs:DELTa command.

Description

Returns the horizontal difference between the two vertical bar cursors. The units are specified by the CURSor:VBArs:UNIts command.

Usage

Using the .query() method will send the CURSor:VBArs:DELTa? query.
Using the .verify(value) method will send the CURSor:VBArs:DELTa? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:VBArs:DELTa?

hpos `property` ¶

hpos: dict[int, CursorVbarsHposItem]

Return the CURSor:VBArs:HPOS<x> command.

Description

Returns the vertical value of the specified vertical bar ticks for cursor .

Usage

Using the .query() method will send the CURSor:VBArs:HPOS<x>? query.
Using the .verify(value) method will send the CURSor:VBArs:HPOS<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:VBArs:HPOS<x>?

Info

<x> specifies the cursor. Valid values are 1 and 2.

position `property` ¶

position: dict[int, CursorVbarsPositionItem]

Return the CURSor:VBArs:POSITION<x> command.

Description

This command specifies the horizontal position for the specified vertical bar cursor. The cursor is specified by , which can be 1 or 2. Values are with respect to trigger position or the zero reference point for the designated waveform (if horizontal units are not set to time). Use the CURSOR:VBARS:UNITS command to specify units.

Usage

Using the .query() method will send the CURSor:VBArs:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:VBArs:POSITION<x>? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURSor:VBArs:POSITION<x> value command.

SCPI Syntax

- CURSor:VBArs:POSITION<x> <NR3>
- CURSor:VBArs:POSITION<x>?

Info

<NR3> is a floating point number that specifies the cursor position.

units `property` ¶

units: CursorVbarsUnits

Return the CURSor:VBArs:UNIts command.

Description

This command specifies the units for the vertical bar cursors.

Usage

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

SCPI Syntax

- CURSor:VBArs:UNIts {SEConds|HERtz|DEGrees|PERcent}
- CURSor:VBArs:UNIts?

Info

SEConds sets the units of the vertical bar cursors for the time domain (seconds).
HERtz sets the units of the vertical bar cursors for the frequency domain (hertz).
DEGrees sets the units to degrees for measuring phase.
PERcent sets the units to percent for use with ratio cursors.

use `property` ¶

use: CursorVbarsUse

Return the CURSor:VBArs:USE command.

Description

Sets the vertical bar cursor measurement scale.

Usage

Using the .write(value) method will send the CURSor:VBArs:USE value command.

SCPI Syntax

- CURSor:VBArs:USE {CURrent|HALFgrat|FIVEdivs}

Info

CURrent sets the V Bar measurement scale so that 0% is the current position of the left-most V Bar cursor and 100% is the current position of the right-most V Bar cursor.
HALFgrat resets the ratio range to the default positions on the screen, half of the number of horizontal divisions, from 25% to 75% of the screen.
FIVEdivs sets V Bar measurement scale so that 5 screen major divisions is 100%, where 0% is -2.5 divisions and 100% is +2.5 divisions from the center vertical graticule.

vdelta `property` ¶

vdelta: CursorVbarsVdelta

Return the CURSor:VBArs:VDELTa command.

Description

Returns the vertical difference between the two vertical bar cursor ticks.

Usage

Using the .query() method will send the CURSor:VBArs:VDELTa? query.
Using the .verify(value) method will send the CURSor:VBArs:VDELTa? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:VBArs:VDELTa?

CursorVbarsAlternateItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The CURSor:VBArs:ALTERNATE<x> command.

Description

Returns the alternate readout for the waveform (Vbar) cursors specified by . This alternate readout is in effect when the selected waveform is a bus or digital channel.

Usage

Using the .query() method will send the CURSor:VBArs:ALTERNATE<x>? query.
Using the .verify(value) method will send the CURSor:VBArs:ALTERNATE<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:VBArs:ALTERNATE<x>?

Info

X = 1 specifies vertical bar cursor1.
X = 2 specifies vertical bar cursor2.

CursorVbarsDelta ¶

Bases: SCPICmdRead

The CURSor:VBArs:DELTa command.

Description

Returns the horizontal difference between the two vertical bar cursors. The units are specified by the CURSor:VBArs:UNIts command.

Usage

Using the .query() method will send the CURSor:VBArs:DELTa? query.
Using the .verify(value) method will send the CURSor:VBArs:DELTa? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:VBArs:DELTa?

CursorVbarsHposItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The CURSor:VBArs:HPOS<x> command.

Description

Returns the vertical value of the specified vertical bar ticks for cursor .

Usage

Using the .query() method will send the CURSor:VBArs:HPOS<x>? query.
Using the .verify(value) method will send the CURSor:VBArs:HPOS<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:VBArs:HPOS<x>?

Info

<x> specifies the cursor. Valid values are 1 and 2.

CursorVbarsPositionItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead

The CURSor:VBArs:POSITION<x> command.

Description

This command specifies the horizontal position for the specified vertical bar cursor. The cursor is specified by , which can be 1 or 2. Values are with respect to trigger position or the zero reference point for the designated waveform (if horizontal units are not set to time). Use the CURSOR:VBARS:UNITS command to specify units.

Usage

Using the .query() method will send the CURSor:VBArs:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:VBArs:POSITION<x>? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURSor:VBArs:POSITION<x> value command.

SCPI Syntax

- CURSor:VBArs:POSITION<x> <NR3>
- CURSor:VBArs:POSITION<x>?

Info

<NR3> is a floating point number that specifies the cursor position.

CursorVbarsUnits ¶

Bases: SCPICmdWrite, SCPICmdRead

The CURSor:VBArs:UNIts command.

Description

This command specifies the units for the vertical bar cursors.

Usage

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

SCPI Syntax

- CURSor:VBArs:UNIts {SEConds|HERtz|DEGrees|PERcent}
- CURSor:VBArs:UNIts?

Info

SEConds sets the units of the vertical bar cursors for the time domain (seconds).
HERtz sets the units of the vertical bar cursors for the frequency domain (hertz).
DEGrees sets the units to degrees for measuring phase.
PERcent sets the units to percent for use with ratio cursors.

CursorVbarsUse ¶

Bases: SCPICmdWrite

The CURSor:VBArs:USE command.

Description

Sets the vertical bar cursor measurement scale.

Usage

Using the .write(value) method will send the CURSor:VBArs:USE value command.

SCPI Syntax

- CURSor:VBArs:USE {CURrent|HALFgrat|FIVEdivs}

Info

CURrent sets the V Bar measurement scale so that 0% is the current position of the left-most V Bar cursor and 100% is the current position of the right-most V Bar cursor.
HALFgrat resets the ratio range to the default positions on the screen, half of the number of horizontal divisions, from 25% to 75% of the screen.
FIVEdivs sets V Bar measurement scale so that 5 screen major divisions is 100%, where 0% is -2.5 divisions and 100% is +2.5 divisions from the center vertical graticule.

CursorVbarsVdelta ¶

Bases: SCPICmdRead

The CURSor:VBArs:VDELTa command.

Description

Returns the vertical difference between the two vertical bar cursor ticks.

Usage

Using the .query() method will send the CURSor:VBArs:VDELTa? query.
Using the .verify(value) method will send the CURSor:VBArs:VDELTa? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:VBArs:VDELTa?

CursorXy ¶

Bases: SCPICmdRead

The CURSor:XY command tree.

Usage

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

Properties

.polar: The CURSor:XY:POLar command tree.
.product: The CURSor:XY:PRODUCT command tree.
.ratio: The CURSor:XY:RATIO command tree.
.readout: The CURSor:XY:READOUT command.
.rectangular: The CURSor:XY:RECTangular command tree.

polar `property` ¶

polar: CursorXyPolar

Return the CURSor:XY:POLar command tree.

Usage

Using the .query() method will send the CURSor:XY:POLar? query.
Using the .verify(value) method will send the CURSor:XY:POLar? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.radius: The CURSor:XY:POLar:RADIUS command tree.
.theta: The CURSor:XY:POLar:THETA command tree.

product `property` ¶

product: CursorXyProduct

Return the CURSor:XY:PRODUCT command tree.

Usage

Using the .query() method will send the CURSor:XY:PRODUCT? query.
Using the .verify(value) method will send the CURSor:XY:PRODUCT? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.delta: The CURSor:XY:PRODUCT:DELta command.
.position: The CURSor:XY:PRODUCT:POSITION<x> command.
.units: The CURSor:XY:PRODUCT:UNIts command.

ratio `property` ¶

ratio: CursorXyRatio

Return the CURSor:XY:RATIO command tree.

Usage

Using the .query() method will send the CURSor:XY:RATIO? query.
Using the .verify(value) method will send the CURSor:XY:RATIO? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.delta: The CURSor:XY:RATIO:DELta command.
.position: The CURSor:XY:RATIO:POSITION<x> command.
.units: The CURSor:XY:RATIO:UNIts command.

readout `property` ¶

readout: CursorXyReadout

Return the CURSor:XY:READOUT command.

Description

This command specifies the XY cursor readout selection.

Usage

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

SCPI Syntax

- CURSor:XY:READOUT {RECTangular|POLARCord|PRODuct|RATio}
- CURSor:XY:READOUT?

Info

RECTangular specifies the XY readout as rectangular coordinates.
POLARCord specifies the XY readout as polar coordinates.
PRODuct specifies the XY readout in X*Y format.
RATio specifies the XY readout in X:Y format.

rectangular `property` ¶

rectangular: CursorXyRectangular

Return the CURSor:XY:RECTangular command tree.

Usage

Using the .query() method will send the CURSor:XY:RECTangular? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.x: The CURSor:XY:RECTangular:X command tree.
.y: The CURSor:XY:RECTangular:Y command tree.

CursorXyPolar ¶

Bases: SCPICmdRead

The CURSor:XY:POLar command tree.

Usage

Using the .query() method will send the CURSor:XY:POLar? query.
Using the .verify(value) method will send the CURSor:XY:POLar? query and raise an AssertionError if the returned value does not match value.

Properties

.radius: The CURSor:XY:POLar:RADIUS command tree.
.theta: The CURSor:XY:POLar:THETA command tree.

radius `property` ¶

radius: CursorXyPolarRadius

Return the CURSor:XY:POLar:RADIUS command tree.

Usage

Using the .query() method will send the CURSor:XY:POLar:RADIUS? query.
Using the .verify(value) method will send the CURSor:XY:POLar:RADIUS? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.delta: The CURSor:XY:POLar:RADIUS:DELta command.
.position: The CURSor:XY:POLar:RADIUS:POSITION<x> command.
.units: The CURSor:XY:POLar:RADIUS:UNIts command.

theta `property` ¶

theta: CursorXyPolarTheta

Return the CURSor:XY:POLar:THETA command tree.

Usage

Using the .query() method will send the CURSor:XY:POLar:THETA? query.
Using the .verify(value) method will send the CURSor:XY:POLar:THETA? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.delta: The CURSor:XY:POLar:THETA:DELta command.
.position: The CURSor:XY:POLar:THETA:POSITION<x> command.
.units: The CURSor:XY:POLar:THETA:UNIts command.

CursorXyPolarRadius ¶

Bases: SCPICmdRead

The CURSor:XY:POLar:RADIUS command tree.

Usage

Using the .query() method will send the CURSor:XY:POLar:RADIUS? query.
Using the .verify(value) method will send the CURSor:XY:POLar:RADIUS? query and raise an AssertionError if the returned value does not match value.

Properties

.delta: The CURSor:XY:POLar:RADIUS:DELta command.
.position: The CURSor:XY:POLar:RADIUS:POSITION<x> command.
.units: The CURSor:XY:POLar:RADIUS:UNIts command.

delta `property` ¶

delta: CursorXyPolarRadiusDelta

Return the CURSor:XY:POLar:RADIUS:DELta command.

Description

Returns the difference between the cursors X radius and the cursor Y radius (ΔY¸ ΔX). The ratio is calculated as (cursor 2 Y - cursor 1 Y) ÷ (cursor 2 X - cursor 1 X).

Usage

Using the .query() method will send the CURSor:XY:POLar:RADIUS:DELta? query.
Using the .verify(value) method will send the CURSor:XY:POLar:RADIUS:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:RADIUS:DELta?

position `property` ¶

position: dict[int, CursorXyPolarRadiusPositionItem]

Return the CURSor:XY:POLar:RADIUS:POSITION<x> command.

Description

Returns the polar radius for the specified cursor, where x can be either 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:POLar:RADIUS:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:POLar:RADIUS:POSITION<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:RADIUS:POSITION<x>?

units `property` ¶

units: CursorXyPolarRadiusUnits

Return the CURSor:XY:POLar:RADIUS:UNIts command.

Description

Returns the polar radius units.

Usage

Using the .query() method will send the CURSor:XY:POLar:RADIUS:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:POLar:RADIUS:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:RADIUS:UNIts?

CursorXyPolarRadiusDelta ¶

Bases: SCPICmdRead

The CURSor:XY:POLar:RADIUS:DELta command.

Description

Returns the difference between the cursors X radius and the cursor Y radius (ΔY¸ ΔX). The ratio is calculated as (cursor 2 Y - cursor 1 Y) ÷ (cursor 2 X - cursor 1 X).

Usage

Using the .query() method will send the CURSor:XY:POLar:RADIUS:DELta? query.
Using the .verify(value) method will send the CURSor:XY:POLar:RADIUS:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:RADIUS:DELta?

CursorXyPolarRadiusPositionItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The CURSor:XY:POLar:RADIUS:POSITION<x> command.

Description

Returns the polar radius for the specified cursor, where x can be either 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:POLar:RADIUS:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:POLar:RADIUS:POSITION<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:RADIUS:POSITION<x>?

CursorXyPolarRadiusUnits ¶

Bases: SCPICmdRead

The CURSor:XY:POLar:RADIUS:UNIts command.

Description

Returns the polar radius units.

Usage

Using the .query() method will send the CURSor:XY:POLar:RADIUS:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:POLar:RADIUS:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:RADIUS:UNIts?

CursorXyPolarTheta ¶

Bases: SCPICmdRead

The CURSor:XY:POLar:THETA command tree.

Usage

Using the .query() method will send the CURSor:XY:POLar:THETA? query.
Using the .verify(value) method will send the CURSor:XY:POLar:THETA? query and raise an AssertionError if the returned value does not match value.

Properties

.delta: The CURSor:XY:POLar:THETA:DELta command.
.position: The CURSor:XY:POLar:THETA:POSITION<x> command.
.units: The CURSor:XY:POLar:THETA:UNIts command.

delta `property` ¶

delta: CursorXyPolarThetaDelta

Return the CURSor:XY:POLar:THETA:DELta command.

Description

Returns the XY cursor polar angle delta.

Usage

Using the .query() method will send the CURSor:XY:POLar:THETA:DELta? query.
Using the .verify(value) method will send the CURSor:XY:POLar:THETA:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:THETA:DELta?

position `property` ¶

position: dict[int, CursorXyPolarThetaPositionItem]

Return the CURSor:XY:POLar:THETA:POSITION<x> command.

Description

Returns the cursor X or cursor Y polar coordinate, where x is either 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:POLar:THETA:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:POLar:THETA:POSITION<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:THETA:POSITION<x>?

units `property` ¶

units: CursorXyPolarThetaUnits

Return the CURSor:XY:POLar:THETA:UNIts command.

Description

Returns the cursor coordinate units.

Usage

Using the .query() method will send the CURSor:XY:POLar:THETA:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:POLar:THETA:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:THETA:UNIts?

CursorXyPolarThetaDelta ¶

Bases: SCPICmdRead

The CURSor:XY:POLar:THETA:DELta command.

Description

Returns the XY cursor polar angle delta.

Usage

Using the .query() method will send the CURSor:XY:POLar:THETA:DELta? query.
Using the .verify(value) method will send the CURSor:XY:POLar:THETA:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:THETA:DELta?

CursorXyPolarThetaPositionItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The CURSor:XY:POLar:THETA:POSITION<x> command.

Description

Returns the cursor X or cursor Y polar coordinate, where x is either 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:POLar:THETA:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:POLar:THETA:POSITION<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:THETA:POSITION<x>?

CursorXyPolarThetaUnits ¶

Bases: SCPICmdRead

The CURSor:XY:POLar:THETA:UNIts command.

Description

Returns the cursor coordinate units.

Usage

Using the .query() method will send the CURSor:XY:POLar:THETA:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:POLar:THETA:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:POLar:THETA:UNIts?

CursorXyProduct ¶

Bases: SCPICmdRead

The CURSor:XY:PRODUCT command tree.

Usage

Using the .query() method will send the CURSor:XY:PRODUCT? query.
Using the .verify(value) method will send the CURSor:XY:PRODUCT? query and raise an AssertionError if the returned value does not match value.

Properties

.delta: The CURSor:XY:PRODUCT:DELta command.
.position: The CURSor:XY:PRODUCT:POSITION<x> command.
.units: The CURSor:XY:PRODUCT:UNIts command.

delta `property` ¶

delta: CursorXyProductDelta

Return the CURSor:XY:PRODUCT:DELta command.

Description

Returns the difference between the cursors X position and cursor Y position. The ΔX × ΔY value is calculated as (X2 - X1) × (Y2 - Y1).

Usage

Using the .query() method will send the CURSor:XY:PRODUCT:DELta? query.
Using the .verify(value) method will send the CURSor:XY:PRODUCT:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:PRODUCT:DELta?

position `property` ¶

position: dict[int, CursorXyProductPositionItem]

Return the CURSor:XY:PRODUCT:POSITION<x> command.

Description

Returns the position of the X or Y cursor used to calculate the X × Y cursor measurement, Position 1 = (X1 × Y1); Position 2 = (X2 × Y2). The cursor is specified by x, which can be 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:PRODUCT:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:PRODUCT:POSITION<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:PRODUCT:POSITION<x>?

units `property` ¶

units: CursorXyProductUnits

Return the CURSor:XY:PRODUCT:UNIts command.

Description

Returns the XY cursor product units.

Usage

Using the .query() method will send the CURSor:XY:PRODUCT:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:PRODUCT:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:PRODUCT:UNIts?

CursorXyProductDelta ¶

Bases: SCPICmdRead

The CURSor:XY:PRODUCT:DELta command.

Description

Returns the difference between the cursors X position and cursor Y position. The ΔX × ΔY value is calculated as (X2 - X1) × (Y2 - Y1).

Usage

Using the .query() method will send the CURSor:XY:PRODUCT:DELta? query.
Using the .verify(value) method will send the CURSor:XY:PRODUCT:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:PRODUCT:DELta?

CursorXyProductPositionItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The CURSor:XY:PRODUCT:POSITION<x> command.

Description

Returns the position of the X or Y cursor used to calculate the X × Y cursor measurement, Position 1 = (X1 × Y1); Position 2 = (X2 × Y2). The cursor is specified by x, which can be 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:PRODUCT:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:PRODUCT:POSITION<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:PRODUCT:POSITION<x>?

CursorXyProductUnits ¶

Bases: SCPICmdRead

The CURSor:XY:PRODUCT:UNIts command.

Description

Returns the XY cursor product units.

Usage

Using the .query() method will send the CURSor:XY:PRODUCT:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:PRODUCT:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:PRODUCT:UNIts?

CursorXyRatio ¶

Bases: SCPICmdRead

The CURSor:XY:RATIO command tree.

Usage

Using the .query() method will send the CURSor:XY:RATIO? query.
Using the .verify(value) method will send the CURSor:XY:RATIO? query and raise an AssertionError if the returned value does not match value.

Properties

.delta: The CURSor:XY:RATIO:DELta command.
.position: The CURSor:XY:RATIO:POSITION<x> command.
.units: The CURSor:XY:RATIO:UNIts command.

delta `property` ¶

delta: CursorXyRatioDelta

Return the CURSor:XY:RATIO:DELta command.

Description

Returns the ratio of the difference between the cursors X position and cursor Y position (ΔY¸ ΔX). The ratio is calculated as (Y2 - Y1) / (X2 - X1).

Usage

Using the .query() method will send the CURSor:XY:RATIO:DELta? query.
Using the .verify(value) method will send the CURSor:XY:RATIO:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RATIO:DELta?

position `property` ¶

position: dict[int, CursorXyRatioPositionItem]

Return the CURSor:XY:RATIO:POSITION<x> command.

Description

Returns the X (horizontal) or Y (vertical) position for the specified cursor, which can be 1 (X) or 2 (Y). The ratio is calculated as Position 1 = (Y1/X1); Position 2 = (Y2/X2).

Usage

Using the .query() method will send the CURSor:XY:RATIO:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:RATIO:POSITION<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RATIO:POSITION<x>?

units `property` ¶

units: CursorXyRatioUnits

Return the CURSor:XY:RATIO:UNIts command.

Description

Returns the cursor X and cursor Y units for the ratio measurement.

Usage

Using the .query() method will send the CURSor:XY:RATIO:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:RATIO:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RATIO:UNIts?

CursorXyRatioDelta ¶

Bases: SCPICmdRead

The CURSor:XY:RATIO:DELta command.

Description

Returns the ratio of the difference between the cursors X position and cursor Y position (ΔY¸ ΔX). The ratio is calculated as (Y2 - Y1) / (X2 - X1).

Usage

Using the .query() method will send the CURSor:XY:RATIO:DELta? query.
Using the .verify(value) method will send the CURSor:XY:RATIO:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RATIO:DELta?

CursorXyRatioPositionItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The CURSor:XY:RATIO:POSITION<x> command.

Description

Returns the X (horizontal) or Y (vertical) position for the specified cursor, which can be 1 (X) or 2 (Y). The ratio is calculated as Position 1 = (Y1/X1); Position 2 = (Y2/X2).

Usage

Using the .query() method will send the CURSor:XY:RATIO:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:RATIO:POSITION<x>? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RATIO:POSITION<x>?

CursorXyRatioUnits ¶

Bases: SCPICmdRead

The CURSor:XY:RATIO:UNIts command.

Description

Returns the cursor X and cursor Y units for the ratio measurement.

Usage

Using the .query() method will send the CURSor:XY:RATIO:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:RATIO:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RATIO:UNIts?

CursorXyReadout ¶

Bases: SCPICmdWrite, SCPICmdRead

The CURSor:XY:READOUT command.

Description

This command specifies the XY cursor readout selection.

Usage

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

SCPI Syntax

- CURSor:XY:READOUT {RECTangular|POLARCord|PRODuct|RATio}
- CURSor:XY:READOUT?

Info

RECTangular specifies the XY readout as rectangular coordinates.
POLARCord specifies the XY readout as polar coordinates.
PRODuct specifies the XY readout in X*Y format.
RATio specifies the XY readout in X:Y format.

CursorXyRectangular ¶

Bases: SCPICmdRead

The CURSor:XY:RECTangular command tree.

Usage

Using the .query() method will send the CURSor:XY:RECTangular? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular? query and raise an AssertionError if the returned value does not match value.

Properties

.x: The CURSor:XY:RECTangular:X command tree.
.y: The CURSor:XY:RECTangular:Y command tree.

x `property` ¶

x: CursorXyRectangularX

Return the CURSor:XY:RECTangular:X command tree.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:X? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:X? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.delta: The CURSor:XY:RECTangular:X:DELta command.
.position: The CURSor:XY:RECTangular:X:POSITION<x> command.
.units: The CURSor:XY:RECTangular:X:UNIts command.

y `property` ¶

y: CursorXyRectangularY

Return the CURSor:XY:RECTangular:Y command tree.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:Y? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:Y? query and raise an AssertionError if the returned value does not match value.

Sub-properties

.delta: The CURSor:XY:RECTangular:Y:DELta command.
.position: The CURSor:XY:RECTangular:Y:POSITION<x> command.
.units: The CURSor:XY:RECTangular:Y:UNIts command.

CursorXyRectangularX ¶

Bases: SCPICmdRead

The CURSor:XY:RECTangular:X command tree.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:X? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:X? query and raise an AssertionError if the returned value does not match value.

Properties

.delta: The CURSor:XY:RECTangular:X:DELta command.
.position: The CURSor:XY:RECTangular:X:POSITION<x> command.
.units: The CURSor:XY:RECTangular:X:UNIts command.

delta `property` ¶

delta: CursorXyRectangularXDelta

Return the CURSor:XY:RECTangular:X:DELta command.

Description

Returns the cursor X delta value in rectangular coordinates.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:X:DELta? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:X:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RECTangular:X:DELta?

position `property` ¶

position: dict[int, CursorXyRectangularXPositionItem]

Return the CURSor:XY:RECTangular:X:POSITION<x> command.

Description

This command specifies the X rectangular coordinate for cursor 1 or cursor 2. The cursor is specified by x and can be either 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:X:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:X:POSITION<x>? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURSor:XY:RECTangular:X:POSITION<x> value command.

SCPI Syntax

- CURSor:XY:RECTangular:X:POSITION<x> <NR3>
- CURSor:XY:RECTangular:X:POSITION<x>?

Info

<NR3> is a floating point number that specifies the coordinate in volts.

units `property` ¶

units: CursorXyRectangularXUnits

Return the CURSor:XY:RECTangular:X:UNIts command.

Description

Returns the cursor X rectangular units.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:X:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:X:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RECTangular:X:UNIts?

CursorXyRectangularXDelta ¶

Bases: SCPICmdRead

The CURSor:XY:RECTangular:X:DELta command.

Description

Returns the cursor X delta value in rectangular coordinates.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:X:DELta? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:X:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RECTangular:X:DELta?

CursorXyRectangularXPositionItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead

The CURSor:XY:RECTangular:X:POSITION<x> command.

Description

This command specifies the X rectangular coordinate for cursor 1 or cursor 2. The cursor is specified by x and can be either 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:X:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:X:POSITION<x>? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURSor:XY:RECTangular:X:POSITION<x> value command.

SCPI Syntax

- CURSor:XY:RECTangular:X:POSITION<x> <NR3>
- CURSor:XY:RECTangular:X:POSITION<x>?

Info

<NR3> is a floating point number that specifies the coordinate in volts.

CursorXyRectangularXUnits ¶

Bases: SCPICmdRead

The CURSor:XY:RECTangular:X:UNIts command.

Description

Returns the cursor X rectangular units.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:X:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:X:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RECTangular:X:UNIts?

CursorXyRectangularY ¶

Bases: SCPICmdRead

The CURSor:XY:RECTangular:Y command tree.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:Y? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:Y? query and raise an AssertionError if the returned value does not match value.

Properties

.delta: The CURSor:XY:RECTangular:Y:DELta command.
.position: The CURSor:XY:RECTangular:Y:POSITION<x> command.
.units: The CURSor:XY:RECTangular:Y:UNIts command.

delta `property` ¶

delta: CursorXyRectangularYDelta

Return the CURSor:XY:RECTangular:Y:DELta command.

Description

Returns The cursor Y delta value in rectangular coordinates.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:Y:DELta? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:Y:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RECTangular:Y:DELta?

position `property` ¶

position: dict[int, CursorXyRectangularYPositionItem]

Return the CURSor:XY:RECTangular:Y:POSITION<x> command.

Description

This command specifies the Y rectangular coordinate for cursor 1 or cursor 2. The cursor is specified by x and can be either 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:Y:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:Y:POSITION<x>? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURSor:XY:RECTangular:Y:POSITION<x> value command.

SCPI Syntax

- CURSor:XY:RECTangular:Y:POSITION<x> <NR3>
- CURSor:XY:RECTangular:Y:POSITION<x>?

Info

<NR3> is a floating point number that specifies the coordinate in volts.

units `property` ¶

units: CursorXyRectangularYUnits

Return the CURSor:XY:RECTangular:Y:UNIts command.

Description

Returns the cursor Y rectangular units.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:Y:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:Y:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RECTangular:Y:UNIts?

CursorXyRectangularYDelta ¶

Bases: SCPICmdRead

The CURSor:XY:RECTangular:Y:DELta command.

Description

Returns The cursor Y delta value in rectangular coordinates.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:Y:DELta? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:Y:DELta? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RECTangular:Y:DELta?

CursorXyRectangularYPositionItem ¶

Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead

The CURSor:XY:RECTangular:Y:POSITION<x> command.

Description

This command specifies the Y rectangular coordinate for cursor 1 or cursor 2. The cursor is specified by x and can be either 1 or 2.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:Y:POSITION<x>? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:Y:POSITION<x>? query and raise an AssertionError if the returned value does not match value.
Using the .write(value) method will send the CURSor:XY:RECTangular:Y:POSITION<x> value command.

SCPI Syntax

- CURSor:XY:RECTangular:Y:POSITION<x> <NR3>
- CURSor:XY:RECTangular:Y:POSITION<x>?

Info

<NR3> is a floating point number that specifies the coordinate in volts.

CursorXyRectangularYUnits ¶

Bases: SCPICmdRead

The CURSor:XY:RECTangular:Y:UNIts command.

Description

Returns the cursor Y rectangular units.

Usage

Using the .query() method will send the CURSor:XY:RECTangular:Y:UNIts? query.
Using the .verify(value) method will send the CURSor:XY:RECTangular:Y:UNIts? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- CURSor:XY:RECTangular:Y:UNIts?

cursor ¶

Cursor ¶

ddt property ¶

function property ¶

hbars property ¶

mode property ¶

source property ¶

vbars property ¶

xy property ¶

CursorDdt ¶

CursorFunction ¶

CursorHbars ¶

delta property ¶

position property ¶

units property ¶

use property ¶

CursorHbarsDelta ¶

CursorHbarsPositionItem ¶

CursorHbarsUnits ¶

CursorHbarsUse ¶

CursorMode ¶

CursorSource ¶

CursorVbars ¶

alternate property ¶

delta property ¶

hpos property ¶

position property ¶

units property ¶

use property ¶

vdelta property ¶

CursorVbarsAlternateItem ¶

CursorVbarsDelta ¶

CursorVbarsHposItem ¶

CursorVbarsPositionItem ¶

CursorVbarsUnits ¶

CursorVbarsUse ¶

CursorVbarsVdelta ¶

CursorXy ¶

polar property ¶

product property ¶

ratio property ¶

readout property ¶

rectangular property ¶

CursorXyPolar ¶

radius property ¶

theta property ¶

CursorXyPolarRadius ¶

delta property ¶

position property ¶

units property ¶

CursorXyPolarRadiusDelta ¶

CursorXyPolarRadiusPositionItem ¶

CursorXyPolarRadiusUnits ¶

CursorXyPolarTheta ¶

delta property ¶

position property ¶

units property ¶

CursorXyPolarThetaDelta ¶

CursorXyPolarThetaPositionItem ¶

CursorXyPolarThetaUnits ¶

CursorXyProduct ¶

delta property ¶

position property ¶

units property ¶

CursorXyProductDelta ¶

CursorXyProductPositionItem ¶

CursorXyProductUnits ¶

CursorXyRatio ¶

delta property ¶

position property ¶

units property ¶

CursorXyRatioDelta ¶

CursorXyRatioPositionItem ¶

CursorXyRatioUnits ¶

CursorXyReadout ¶

CursorXyRectangular ¶

x property ¶

y property ¶

CursorXyRectangularX ¶

delta property ¶

ddt `property` ¶

function `property` ¶

hbars `property` ¶

mode `property` ¶

source `property` ¶

vbars `property` ¶

xy `property` ¶

delta `property` ¶

position `property` ¶

units `property` ¶

use `property` ¶

alternate `property` ¶

delta `property` ¶

hpos `property` ¶

position `property` ¶

units `property` ¶

use `property` ¶

vdelta `property` ¶

polar `property` ¶

product `property` ¶

ratio `property` ¶

readout `property` ¶

rectangular `property` ¶

radius `property` ¶

theta `property` ¶

delta `property` ¶

position `property` ¶

units `property` ¶

delta `property` ¶

position `property` ¶

units `property` ¶

delta `property` ¶

position `property` ¶

units `property` ¶

delta `property` ¶

position `property` ¶

units `property` ¶

x `property` ¶

y `property` ¶

delta `property` ¶

position `property` ¶

units `property` ¶

delta `property` ¶

position `property` ¶

units `property` ¶