mark ¶

The mark 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

- MARK {NEXT|PREVious}
- MARK:CREATE {CH<x>|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe}
- MARK:DELEte {CH<x>|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe}
- MARK:FREE?
- MARK:SAVEALL TOUSER
- MARK:SELected:END?
- MARK:SELected:FOCUS?
- MARK:SELected:MARKSINCOLumn?
- MARK:SELected:OWNer?
- MARK:SELected:SOURCe?
- MARK:SELected:STARt?
- MARK:SELected:STATE?
- MARK:SELected:ZOOm:POSition?
- MARK:TOTal?
- MARK:USERLIST <Enum>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>
- MARK:USERLIST?
- MARK?

Mark ¶

Bases: SCPICmdWrite, SCPICmdRead

The MARK command.

Description

Moves to the next or previous reference mark on the waveform. Returns the current mark position.

Usage

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

SCPI Syntax

- MARK {NEXT|PREVious}
- MARK?

Info

NEXT moves to the next reference mark on the right.
PREVious moves to the next reference mark on the left.

Properties

.create: The MARK:CREATE command.
.delete: The MARK:DELEte command.
.free: The MARK:FREE command.
.saveall: The MARK:SAVEALL command.
.selected: The MARK:SELected command tree.
.total: The MARK:TOTal command.
.userlist: The MARK:USERLIST command.

create `property` ¶

create: MarkCreate

Return the MARK:CREATE command.

Description

Creates a mark on a specified waveform or all waveforms in a column.

Usage

Using the .write(value) method will send the MARK:CREATE value command.

SCPI Syntax

- MARK:CREATE {CH<x>|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe}

Info

CH<x> creates the mark on a channel waveform, where is the channel number.
MATH creates the mark on the math waveform.
B<x> creates the mark on a bus waveform, where .
REF<x> creates the mark on a reference waveform, where is the reference waveform number.
DIGital creates the mark on a digital waveform. (An error will result if no digital channel is turned on.) (Requires installation of option 3-MSO.).
COLUMN creates marks on all waveforms in the current zoom pixel column.

delete `property` ¶

delete: MarkDelete

Return the MARK:DELEte command.

Description

This command deletes a mark on a particular waveform, all waveforms in a column, the selected mark, or all marks.

Usage

Using the .write(value) method will send the MARK:DELEte value command.

SCPI Syntax

- MARK:DELEte {CH<x>|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe}

Info

CH<x> deletes the mark on a channel waveform, where is the channel number.
MATH deletes the mark on the math waveform.
B<x> deletes the mark on a bus waveform, where .
REF<x> deletes the mark on a reference waveform, where is the reference waveform number.
DIGital deletes all marks on all digital channels. (Requires installation of option 3-MSO.).
COLUMN deletes marks on all waveforms in the current zoom pixel column.

free `property` ¶

free: MarkFree

Return the MARK:FREE command.

Description

Returns how many marks are available for use. There can be a total of 1,024 marks returned.

Usage

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

SCPI Syntax

- MARK:FREE?

saveall `property` ¶

saveall: MarkSaveall

Return the MARK:SAVEALL command.

Description

This command saves all current marks on waveforms in the time domain to the user search mark list in internal memory. (This is equivalent to pressing the ‘Save All Marks’ button in the Search button menu on the front panel.) In order to retrieve the information, use the query form of MARK:USERLIST.

Usage

Using the .write(value) method will send the MARK:SAVEALL value command.

SCPI Syntax

- MARK:SAVEALL TOUSER

selected `property` ¶

selected: MarkSelected

Return the MARK:SELected command tree.

Usage

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

Sub-properties

.end: The MARK:SELected:END command.
.focus: The MARK:SELected:FOCUS command.
.marksincolumn: The MARK:SELected:MARKSINCOLumn command.
.owner: The MARK:SELected:OWNer command.
.source: The MARK:SELected:SOURCe command.
.start: The MARK:SELected:STARt command.
.state: The MARK:SELected:STATE command.
.zoom: The MARK:SELected:ZOOm command tree.

total `property` ¶

total: MarkTotal

Return the MARK:TOTal command.

Description

Returns how many marks are currently in use. There can be a total of 1,024 marks returned.

Usage

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

SCPI Syntax

- MARK:TOTal?

userlist `property` ¶

userlist: MarkUserlist

Return the MARK:USERLIST command.

Description

The command creates a single user mark on a waveform in the time domain. The arguments consist of an enumeration specifying the source waveform, followed by 7 time mark parameters. You can create up to 1,024 marks. To save all the marks to memory, use the command MARK:SAVEALL TOUSER. The query form retrieves a list of all user marks, separated by a semicolon. To retrieve the list of all system generated marks, use the command SEARCH:SEARCHX:LIST A ‘Settings conflict’ error event is set for the command form if any of the following conditions are true: The source waveform is not turned on. The position of the mark is not on the waveform. The maximum number of marks would be exceeded.

Usage

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

SCPI Syntax

- MARK:USERLIST <Enum>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>
- MARK:USERLIST?

Info

CH<x> - analog channels 1-4.
B<x> - serial (if installed) or parallel bus 1-4.
MATH - math waveform.
REF<x> - reference waveforms 1-4.
D0 - D15 - digital channels 0 - 15 (Requires installation of option 3-MSO.).

MarkCreate ¶

Bases: SCPICmdWrite

The MARK:CREATE command.

Description

Creates a mark on a specified waveform or all waveforms in a column.

Usage

Using the .write(value) method will send the MARK:CREATE value command.

SCPI Syntax

- MARK:CREATE {CH<x>|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe}

Info

CH<x> creates the mark on a channel waveform, where is the channel number.
MATH creates the mark on the math waveform.
B<x> creates the mark on a bus waveform, where .
REF<x> creates the mark on a reference waveform, where is the reference waveform number.
DIGital creates the mark on a digital waveform. (An error will result if no digital channel is turned on.) (Requires installation of option 3-MSO.).
COLUMN creates marks on all waveforms in the current zoom pixel column.

MarkDelete ¶

Bases: SCPICmdWrite

The MARK:DELEte command.

Description

This command deletes a mark on a particular waveform, all waveforms in a column, the selected mark, or all marks.

Usage

Using the .write(value) method will send the MARK:DELEte value command.

SCPI Syntax

- MARK:DELEte {CH<x>|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe}

Info

CH<x> deletes the mark on a channel waveform, where is the channel number.
MATH deletes the mark on the math waveform.
B<x> deletes the mark on a bus waveform, where .
REF<x> deletes the mark on a reference waveform, where is the reference waveform number.
DIGital deletes all marks on all digital channels. (Requires installation of option 3-MSO.).
COLUMN deletes marks on all waveforms in the current zoom pixel column.

MarkFree ¶

Bases: SCPICmdRead

The MARK:FREE command.

Description

Returns how many marks are available for use. There can be a total of 1,024 marks returned.

Usage

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

SCPI Syntax

- MARK:FREE?

MarkSaveall ¶

Bases: SCPICmdWrite

The MARK:SAVEALL command.

Description

This command saves all current marks on waveforms in the time domain to the user search mark list in internal memory. (This is equivalent to pressing the ‘Save All Marks’ button in the Search button menu on the front panel.) In order to retrieve the information, use the query form of MARK:USERLIST.

Usage

Using the .write(value) method will send the MARK:SAVEALL value command.

SCPI Syntax

- MARK:SAVEALL TOUSER

MarkSelected ¶

Bases: SCPICmdRead

The MARK:SELected command tree.

Usage

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

Properties

.end: The MARK:SELected:END command.
.focus: The MARK:SELected:FOCUS command.
.marksincolumn: The MARK:SELected:MARKSINCOLumn command.
.owner: The MARK:SELected:OWNer command.
.source: The MARK:SELected:SOURCe command.
.start: The MARK:SELected:STARt command.
.state: The MARK:SELected:STATE command.
.zoom: The MARK:SELected:ZOOm command tree.

end `property` ¶

end: MarkSelectedEnd

Return the MARK:SELected:END command.

Description

Returns the end of the selected mark, 0 to 100% of the waveform.

Usage

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

SCPI Syntax

- MARK:SELected:END?

focus `property` ¶

focus: MarkSelectedFocus

Return the MARK:SELected:FOCUS command.

Description

Returns the focus of the selected mark, 0 to 100% of the waveform.

Usage

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

SCPI Syntax

- MARK:SELected:FOCUS?

marksincolumn `property` ¶

marksincolumn: MarkSelectedMarksincolumn

Return the MARK:SELected:MARKSINCOLumn command.

Description

Returns the number of marks in the current zoom pixel column.

Usage

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

SCPI Syntax

- MARK:SELected:MARKSINCOLumn?

owner `property` ¶

owner: MarkSelectedOwner

Return the MARK:SELected:OWNer command.

Description

Returns the owner of the selected mark.

Usage

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

SCPI Syntax

- MARK:SELected:OWNer?

source `property` ¶

source: MarkSelectedSource

Return the MARK:SELected:SOURCe command.

Description

Returns the source waveform for the selected mark.

Usage

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

SCPI Syntax

- MARK:SELected:SOURCe?

start `property` ¶

start: MarkSelectedStart

Return the MARK:SELected:STARt command.

Description

Returns the starting point of the selected mark, 0 to 100% of the waveform.

Usage

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

SCPI Syntax

- MARK:SELected:STARt?

state `property` ¶

state: MarkSelectedState

Return the MARK:SELected:STATE command.

Description

Returns the on or off state of the selected mark. The selected mark is at or near the center of the screen. If you press the front-panel Set/Clear button, this mark will disappear.

Usage

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

SCPI Syntax

- MARK:SELected:STATE?

zoom `property` ¶

zoom: MarkSelectedZoom

Return the MARK:SELected:ZOOm command tree.

Usage

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

Sub-properties

.position: The MARK:SELected:ZOOm:POSition command.

MarkSelectedEnd ¶

Bases: SCPICmdRead

The MARK:SELected:END command.

Description

Returns the end of the selected mark, 0 to 100% of the waveform.

Usage

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

SCPI Syntax

- MARK:SELected:END?

MarkSelectedFocus ¶

Bases: SCPICmdRead

The MARK:SELected:FOCUS command.

Description

Returns the focus of the selected mark, 0 to 100% of the waveform.

Usage

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

SCPI Syntax

- MARK:SELected:FOCUS?

MarkSelectedMarksincolumn ¶

Bases: SCPICmdRead

The MARK:SELected:MARKSINCOLumn command.

Description

Returns the number of marks in the current zoom pixel column.

Usage

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

SCPI Syntax

- MARK:SELected:MARKSINCOLumn?

MarkSelectedOwner ¶

Bases: SCPICmdRead

The MARK:SELected:OWNer command.

Description

Returns the owner of the selected mark.

Usage

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

SCPI Syntax

- MARK:SELected:OWNer?

MarkSelectedSource ¶

Bases: SCPICmdRead

The MARK:SELected:SOURCe command.

Description

Returns the source waveform for the selected mark.

Usage

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

SCPI Syntax

- MARK:SELected:SOURCe?

MarkSelectedStart ¶

Bases: SCPICmdRead

The MARK:SELected:STARt command.

Description

Returns the starting point of the selected mark, 0 to 100% of the waveform.

Usage

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

SCPI Syntax

- MARK:SELected:STARt?

MarkSelectedState ¶

Bases: SCPICmdRead

The MARK:SELected:STATE command.

Description

Returns the on or off state of the selected mark. The selected mark is at or near the center of the screen. If you press the front-panel Set/Clear button, this mark will disappear.

Usage

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

SCPI Syntax

- MARK:SELected:STATE?

MarkSelectedZoom ¶

Bases: SCPICmdRead

The MARK:SELected:ZOOm command tree.

Usage

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

Properties

.position: The MARK:SELected:ZOOm:POSition command.

position `property` ¶

position: MarkSelectedZoomPosition

Return the MARK:SELected:ZOOm:POSition command.

Description

Returns the position of the selected mark, 0 to 100% of the zoom overview window.

Usage

Using the .query() method will send the MARK:SELected:ZOOm:POSition? query.
Using the .verify(value) method will send the MARK:SELected:ZOOm:POSition? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- MARK:SELected:ZOOm:POSition?

MarkSelectedZoomPosition ¶

Bases: SCPICmdRead

The MARK:SELected:ZOOm:POSition command.

Description

Returns the position of the selected mark, 0 to 100% of the zoom overview window.

Usage

Using the .query() method will send the MARK:SELected:ZOOm:POSition? query.
Using the .verify(value) method will send the MARK:SELected:ZOOm:POSition? query and raise an AssertionError if the returned value does not match value.

SCPI Syntax

- MARK:SELected:ZOOm:POSition?

MarkTotal ¶

Bases: SCPICmdRead

The MARK:TOTal command.

Description

Returns how many marks are currently in use. There can be a total of 1,024 marks returned.

Usage

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

SCPI Syntax

- MARK:TOTal?

MarkUserlist ¶

Bases: SCPICmdWrite, SCPICmdRead

The MARK:USERLIST command.

Description

The command creates a single user mark on a waveform in the time domain. The arguments consist of an enumeration specifying the source waveform, followed by 7 time mark parameters. You can create up to 1,024 marks. To save all the marks to memory, use the command MARK:SAVEALL TOUSER. The query form retrieves a list of all user marks, separated by a semicolon. To retrieve the list of all system generated marks, use the command SEARCH:SEARCHX:LIST A ‘Settings conflict’ error event is set for the command form if any of the following conditions are true: The source waveform is not turned on. The position of the mark is not on the waveform. The maximum number of marks would be exceeded.

Usage

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

SCPI Syntax

- MARK:USERLIST <Enum>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>,<NR3>
- MARK:USERLIST?

Info

CH<x> - analog channels 1-4.
B<x> - serial (if installed) or parallel bus 1-4.
MATH - math waveform.
REF<x> - reference waveforms 1-4.
D0 - D15 - digital channels 0 - 15 (Requires installation of option 3-MSO.).

mark ¶

Mark ¶

create property ¶

delete property ¶

free property ¶

saveall property ¶

selected property ¶

total property ¶

userlist property ¶

MarkCreate ¶

MarkDelete ¶

MarkFree ¶

MarkSaveall ¶

MarkSelected ¶

end property ¶

focus property ¶

marksincolumn property ¶

owner property ¶

source property ¶

start property ¶

state property ¶

zoom property ¶

MarkSelectedEnd ¶

MarkSelectedFocus ¶

MarkSelectedMarksincolumn ¶

MarkSelectedOwner ¶

MarkSelectedSource ¶

MarkSelectedStart ¶

MarkSelectedState ¶

MarkSelectedZoom ¶

position property ¶

MarkSelectedZoomPosition ¶

MarkTotal ¶

MarkUserlist ¶

create `property` ¶

delete `property` ¶

free `property` ¶

saveall `property` ¶

selected `property` ¶

total `property` ¶

userlist `property` ¶

end `property` ¶

focus `property` ¶

marksincolumn `property` ¶

owner `property` ¶

source `property` ¶

start `property` ¶

state `property` ¶

zoom `property` ¶

position `property` ¶