[python source code]

visual

The visual commands module.

These commands are used in the following models: TekScopePC

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

Please report an issue if one is found.

Commands and Queries 
- VISual:AREA<x>:ASPEctratio {ON|OFF|<NR1>}
- VISual:AREA<x>:ASPEctratio?
- VISual:AREA<x>:FLIP:HORizontal
- VISual:AREA<x>:FLIP:VERTical
- VISual:AREA<x>:HEIGht <NR3>
- VISual:AREA<x>:HEIGht?
- VISual:AREA<x>:HITType {IN|OUT|DONTcare}
- VISual:AREA<x>:HITType?
- VISual:AREA<x>:RESET
- VISual:AREA<x>:ROTAtion <NR3>
- VISual:AREA<x>:ROTAtion?
- VISual:AREA<x>:SHAPE {TRIAngle|RECTangle|TRAPezoid|HEXAgon}
- VISual:AREA<x>:SHAPE?
- VISual:AREA<x>:SOUrce {CH<x>}
- VISual:AREA<x>:SOUrce?
- VISual:AREA<x>:VERTICES '<NR3>, <NR3>, <NR3>, <NR3>, <NR3>, <NR3> [,<NR3>, <NR3>, ...]'
- VISual:AREA<x>:VERTICES?
- VISual:AREA<x>:WIDTH <NR3>
- VISual:AREA<x>:WIDTH?
- VISual:AREA<x>:XPOSition <NR3>
- VISual:AREA<x>:XPOSition?
- VISual:AREA<x>:YPOSition <NR3>
- VISual:AREA<x>:YPOSition?
- VISual:DELETEALL
- VISual:ENAble {ON|OFF|<NR1>}
- VISual:ENAble?
- VISual:EQUation <Qstring>
- VISual:EQUation?
- VISual:SHOWAReas {ON|OFF|<NR1>}
- VISual:SHOWAReas?
- VISual:SHOWCRiteria {ON|OFF|<NR1>}
- VISual:SHOWCRiteria?
- VISual:SHOWEQuation {ON|OFF|<NR1>}
- VISual:SHOWEQuation?

Visual

Bases: SCPICmdRead

The VISual command tree.

Usage
  • Using the .query() method will send the VISual? query.
  • Using the .verify(value) method will send the VISual? query and raise an AssertionError if the returned value does not match value.
Properties
  • .area: The VISual:AREA<x> command tree.
  • .deleteall: The VISual:DELETEALL command.
  • .enable: The VISual:ENAble command.
  • .equation: The VISual:EQUation command.
  • .showareas: The VISual:SHOWAReas command.
  • .showcriteria: The VISual:SHOWCRiteria command.
  • .showequation: The VISual:SHOWEQuation command.

area property 

area: dict[int, VisualAreaItem]

Return the VISual:AREA<x> command tree.

Usage
  • Using the .query() method will send the VISual:AREA<x>? query.
  • Using the .verify(value) method will send the VISual:AREA<x>? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .aspectratio: The VISual:AREA<x>:ASPEctratio command.
  • .flip: The VISual:AREA<x>:FLIP command tree.
  • .height: The VISual:AREA<x>:HEIGht command.
  • .hittype: The VISual:AREA<x>:HITType command.
  • .reset: The VISual:AREA<x>:RESET command.
  • .rotation: The VISual:AREA<x>:ROTAtion command.
  • .shape: The VISual:AREA<x>:SHAPE command.
  • .source: The VISual:AREA<x>:SOUrce command.
  • .vertices: The VISual:AREA<x>:VERTICES command.
  • .width: The VISual:AREA<x>:WIDTH command.
  • .xposition: The VISual:AREA<x>:XPOSition command.
  • .yposition: The VISual:AREA<x>:YPOSition command.

deleteall property 

deleteall: VisualDeleteall

Return the VISual:DELETEALL command.

Description
  • Deletes all Visual Trigger areas.
Usage
  • Using the .write() method will send the VISual:DELETEALL command.
SCPI Syntax 
- VISual:DELETEALL

enable property 

enable: VisualEnable

Return the VISual:ENAble command.

Description
  • Sets or queries the status (on or off) of the Visual Trigger mode.
Usage
  • Using the .query() method will send the VISual:ENAble? query.
  • Using the .verify(value) method will send the VISual:ENAble? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:ENAble value command.
SCPI Syntax 
- VISual:ENAble {ON|OFF|<NR1>}
- VISual:ENAble?
Info
  • ON enables the Visual Trigger mode.
  • OFF disables the Visual Trigger mode.
  • <NR1> is an integer number. 0 turns off the Visual Trigger mode; any other value enables Visual Trigger mode.

equation property 

equation: VisualEquation

Return the VISual:EQUation command.

Description
  • Sets or queries the Visual Trigger area combination logic equation.
Usage
  • Using the .query() method will send the VISual:EQUation? query.
  • Using the .verify(value) method will send the VISual:EQUation? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:EQUation value command.
SCPI Syntax 
- VISual:EQUation <Qstring>
- VISual:EQUation?
Info
  • <Qstring> defines the Visual Trigger area combination logic equation. The equation is made up of area names (A) combined with logic operators AND, OR, or XOR (&, |, ^). It may also contain parentheses for grouping. The equation must be true to have a valid Visual Trigger event and display a waveform. Each area’s true state depends on the area’s condition setting (In, Out or Don’t Care).

showareas property 

showareas: VisualShowareas

Return the VISual:SHOWAReas command.

Description
  • Shows or hides all Visual Trigger areas.
Usage
  • Using the .query() method will send the VISual:SHOWAReas? query.
  • Using the .verify(value) method will send the VISual:SHOWAReas? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:SHOWAReas value command.
SCPI Syntax 
- VISual:SHOWAReas {ON|OFF|<NR1>}
- VISual:SHOWAReas?
Info
  • ON shows all Visual Trigger areas.
  • OFF hides all Visual Trigger areas.
  • <NR1> is an integer number. 0 hides all Visual Trigger areas; any other value shows all Visual Trigger areas.

showcriteria property 

showcriteria: VisualShowcriteria

Return the VISual:SHOWCRiteria command.

Description
  • Sets or queries display of the area names and hit criteria for all visual trigger areas.
Usage
  • Using the .query() method will send the VISual:SHOWCRiteria? query.
  • Using the .verify(value) method will send the VISual:SHOWCRiteria? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:SHOWCRiteria value command.
SCPI Syntax 
- VISual:SHOWCRiteria {ON|OFF|<NR1>}
- VISual:SHOWCRiteria?
Info
  • ON enables display of the area name and hit criteria labels (In, Out, Don’t care icons) of all Visual Trigger areas.
  • OFF hides the area name and hit criteria labels (In, Out, Don’t care icons) of all Visual Trigger areas.
  • <NR1> is an integer number. 0 hides the area name and hit criteria of all Visual Trigger areas; any other value enables displaying the area name and hit criteria of all Visual Trigger areas.

showequation property 

showequation: VisualShowequation

Return the VISual:SHOWEQuation command.

Description
  • Shows or hides the Visual Trigger area combination logic equation.
Usage
  • Using the .query() method will send the VISual:SHOWEQuation? query.
  • Using the .verify(value) method will send the VISual:SHOWEQuation? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:SHOWEQuation value command.
SCPI Syntax 
- VISual:SHOWEQuation {ON|OFF|<NR1>}
- VISual:SHOWEQuation?
Info
  • ON shows the Visual Trigger area combination logic equation.
  • OFF hides the Visual Trigger area combination logic equation.
  • <NR1> is an integer number. 0 hides the area combination logic equation; any other value displays the area combination logic equation.

VisualAreaItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The VISual:AREA<x> command tree.

Usage
  • Using the .query() method will send the VISual:AREA<x>? query.
  • Using the .verify(value) method will send the VISual:AREA<x>? query and raise an AssertionError if the returned value does not match value.
Properties
  • .aspectratio: The VISual:AREA<x>:ASPEctratio command.
  • .flip: The VISual:AREA<x>:FLIP command tree.
  • .height: The VISual:AREA<x>:HEIGht command.
  • .hittype: The VISual:AREA<x>:HITType command.
  • .reset: The VISual:AREA<x>:RESET command.
  • .rotation: The VISual:AREA<x>:ROTAtion command.
  • .shape: The VISual:AREA<x>:SHAPE command.
  • .source: The VISual:AREA<x>:SOUrce command.
  • .vertices: The VISual:AREA<x>:VERTICES command.
  • .width: The VISual:AREA<x>:WIDTH command.
  • .xposition: The VISual:AREA<x>:XPOSition command.
  • .yposition: The VISual:AREA<x>:YPOSition command.

aspectratio property 

aspectratio: VisualAreaItemAspectratio

Return the VISual:AREA<x>:ASPEctratio command.

Description
  • Sets or queries whether the aspect ratio of the specified Visual Trigger area is locked.
Usage
  • Using the .query() method will send the VISual:AREA<x>:ASPEctratio? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:ASPEctratio? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:ASPEctratio value command.
SCPI Syntax 
- VISual:AREA<x>:ASPEctratio {ON|OFF|<NR1>}
- VISual:AREA<x>:ASPEctratio?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • ON locks the aspect ratio of the specified Visual Trigger area. The aspect ratio is kept constant when the height or width of the area changes.
  • OFF unlocks the aspect ratio of the specified Visual Trigger area.
  • <NR1> is an integer number. 1 locks the aspect ratio of the specified Visual Trigger area; any other value unlocks the aspect ratio of the specified Visual Trigger area.

flip property 

flip: VisualAreaItemFlip

Return the VISual:AREA<x>:FLIP command tree.

Usage
  • Using the .query() method will send the VISual:AREA<x>:FLIP? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:FLIP? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .horizontal: The VISual:AREA<x>:FLIP:HORizontal command.
  • .vertical: The VISual:AREA<x>:FLIP:VERTical command.

height property 

height: VisualAreaItemHeight

Return the VISual:AREA<x>:HEIGht command.

Description
  • Sets or queries the height of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:HEIGht? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:HEIGht? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:HEIGht value command.
SCPI Syntax 
- VISual:AREA<x>:HEIGht <NR3>
- VISual:AREA<x>:HEIGht?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the height of the Visual Trigger area in amplitude.

hittype property 

hittype: VisualAreaItemHittype

Return the VISual:AREA<x>:HITType command.

Description
  • Sets or queries the area hit logic true condition for the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:HITType? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:HITType? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:HITType value command.
SCPI Syntax 
- VISual:AREA<x>:HITType {IN|OUT|DONTcare}
- VISual:AREA<x>:HITType?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • IN specifies that the waveform must intrude anywhere into the specified area to be true.
  • OUT specifies that the waveform must not intrude anywhere into the specified area to be true.
  • DONTcare sets the area to a don’t care state, causing the area to be ignored. This is useful when you are developing a Visual Trigger condition and need to change the hit logic type of an area while keeping the area.

reset property 

reset: VisualAreaItemReset

Return the VISual:AREA<x>:RESET command.

Description
  • Sets the specified Visual Trigger area shape to a default-sized triangle.
Usage
  • Using the .write() method will send the VISual:AREA<x>:RESET command.
SCPI Syntax 
- VISual:AREA<x>:RESET
Info
  • Area<x> specifies the integer number of a Visual Trigger area.

rotation property 

rotation: VisualAreaItemRotation

Return the VISual:AREA<x>:ROTAtion command.

Description
  • Sets or queries the rotation angle of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:ROTAtion? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:ROTAtion? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:ROTAtion value command.
SCPI Syntax 
- VISual:AREA<x>:ROTAtion <NR3>
- VISual:AREA<x>:ROTAtion?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the rotation angle of the Visual Trigger area, in positive degrees from 0 to 360. Zero degrees is referenced from when the area was created.

shape property 

shape: VisualAreaItemShape

Return the VISual:AREA<x>:SHAPE command.

Description
  • Sets or queries the current shape of the area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:SHAPE? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SHAPE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SHAPE value command.
SCPI Syntax 
- VISual:AREA<x>:SHAPE {TRIAngle|RECTangle|TRAPezoid|HEXAgon}
- VISual:AREA<x>:SHAPE?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • TRIAngle sets the specified area to a triangular shape (three vertices). If the area does not exist, the instrument creates a new triangular area with the specified area number.
  • RECTangle sets the specified area to a rectangular shape (four vertices, right angles at each corner). If the area does not exist, the instrument creates a new triangular area with the specified area number.
  • TRAPezoid sets the specified area to a trapezoidal shape (four vertices, two parallel sides). If the area does not exist, the instrument creates a new triangular area with the specified area number.
  • HEXAgon sets the specified area to a hexagonal shape (six vertices). If the area does not exist, the instrument creates a new hexagonal area with the specified area number.

source property 

source: VisualAreaItemSource

Return the VISual:AREA<x>:SOUrce command.

Description
  • Sets or queries the signal source for the specified Visual Trigger area. The source can only be an analog channel.
Usage
  • Using the .query() method will send the VISual:AREA<x>:SOUrce? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SOUrce? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SOUrce value command.
SCPI Syntax 
- VISual:AREA<x>:SOUrce {CH<x>}
- VISual:AREA<x>:SOUrce?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • CH1 through CH8 sets the source channel number for the specified area.

vertices property 

vertices: VisualAreaItemVertices

Return the VISual:AREA<x>:VERTICES command.

Description
  • Sets or queries the X and Y vertex coordinate values for all vertices of the specified Visual Trigger area. Vertex values must be set in pairs.
Usage
  • Using the .query() method will send the VISual:AREA<x>:VERTICES? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:VERTICES? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:VERTICES value command.
SCPI Syntax 
- VISual:AREA<x>:VERTICES '<NR3>, <NR3>, <NR3>, <NR3>, <NR3>, <NR3> [,<NR3>, <NR3>, ...]'
- VISual:AREA<x>:VERTICES?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3>, <NR3> specifies the X, Y coordinate pair of each vertex in an area. The first value is X (time) and the second value is Y (amplitude). There must be a minimum of three vertex pairs to create an area. If the specified area exists, the area is changed to the shape specified in the arguments. If the specified area does not exist, a new area is created and assigned the specified vertices.

width property 

width: VisualAreaItemWidth

Return the VISual:AREA<x>:WIDTH command.

Description
  • Sets or queries the width of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:WIDTH? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:WIDTH? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:WIDTH value command.
SCPI Syntax 
- VISual:AREA<x>:WIDTH <NR3>
- VISual:AREA<x>:WIDTH?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the width of the Visual Trigger area in seconds.

xposition property 

xposition: VisualAreaItemXposition

Return the VISual:AREA<x>:XPOSition command.

Description
  • Sets or queries the horizontal (X-axis) center position of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:XPOSition? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:XPOSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:XPOSition value command.
SCPI Syntax 
- VISual:AREA<x>:XPOSition <NR3>
- VISual:AREA<x>:XPOSition?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the horizontal position of the center of the Visual Trigger area, in seconds.

yposition property 

yposition: VisualAreaItemYposition

Return the VISual:AREA<x>:YPOSition command.

Description
  • Sets or queries the vertical (Y-axis) center position of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:YPOSition? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:YPOSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:YPOSition value command.
SCPI Syntax 
- VISual:AREA<x>:YPOSition <NR3>
- VISual:AREA<x>:YPOSition?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the vertical position of the center of the Visual Trigger area, in amplitude (volts, amps).

VisualAreaItemAspectratio

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:ASPEctratio command.

Description
  • Sets or queries whether the aspect ratio of the specified Visual Trigger area is locked.
Usage
  • Using the .query() method will send the VISual:AREA<x>:ASPEctratio? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:ASPEctratio? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:ASPEctratio value command.
SCPI Syntax 
- VISual:AREA<x>:ASPEctratio {ON|OFF|<NR1>}
- VISual:AREA<x>:ASPEctratio?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • ON locks the aspect ratio of the specified Visual Trigger area. The aspect ratio is kept constant when the height or width of the area changes.
  • OFF unlocks the aspect ratio of the specified Visual Trigger area.
  • <NR1> is an integer number. 1 locks the aspect ratio of the specified Visual Trigger area; any other value unlocks the aspect ratio of the specified Visual Trigger area.

VisualAreaItemFlip

Bases: SCPICmdRead

The VISual:AREA<x>:FLIP command tree.

Usage
  • Using the .query() method will send the VISual:AREA<x>:FLIP? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:FLIP? query and raise an AssertionError if the returned value does not match value.
Properties
  • .horizontal: The VISual:AREA<x>:FLIP:HORizontal command.
  • .vertical: The VISual:AREA<x>:FLIP:VERTical command.

horizontal property 

horizontal: VisualAreaItemFlipHorizontal

Return the VISual:AREA<x>:FLIP:HORizontal command.

Description
  • Flips the specified Visual Trigger area horizontally around its center point.
Usage
  • Using the .write() method will send the VISual:AREA<x>:FLIP:HORizontal command.
SCPI Syntax 
- VISual:AREA<x>:FLIP:HORizontal
Info
  • Area<x> specifies the integer number of a Visual Trigger area.

vertical property 

vertical: VisualAreaItemFlipVertical

Return the VISual:AREA<x>:FLIP:VERTical command.

Description
  • Flips the specified Visual Trigger area vertically around its center point.
Usage
  • Using the .write() method will send the VISual:AREA<x>:FLIP:VERTical command.
SCPI Syntax 
- VISual:AREA<x>:FLIP:VERTical
Info
  • Area<x> specifies the integer number of a Visual Trigger area.

VisualAreaItemFlipHorizontal

Bases: SCPICmdWriteNoArguments

The VISual:AREA<x>:FLIP:HORizontal command.

Description
  • Flips the specified Visual Trigger area horizontally around its center point.
Usage
  • Using the .write() method will send the VISual:AREA<x>:FLIP:HORizontal command.
SCPI Syntax 
- VISual:AREA<x>:FLIP:HORizontal
Info
  • Area<x> specifies the integer number of a Visual Trigger area.

VisualAreaItemFlipVertical

Bases: SCPICmdWriteNoArguments

The VISual:AREA<x>:FLIP:VERTical command.

Description
  • Flips the specified Visual Trigger area vertically around its center point.
Usage
  • Using the .write() method will send the VISual:AREA<x>:FLIP:VERTical command.
SCPI Syntax 
- VISual:AREA<x>:FLIP:VERTical
Info
  • Area<x> specifies the integer number of a Visual Trigger area.

VisualAreaItemHeight

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:HEIGht command.

Description
  • Sets or queries the height of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:HEIGht? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:HEIGht? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:HEIGht value command.
SCPI Syntax 
- VISual:AREA<x>:HEIGht <NR3>
- VISual:AREA<x>:HEIGht?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the height of the Visual Trigger area in amplitude.

VisualAreaItemHittype

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:HITType command.

Description
  • Sets or queries the area hit logic true condition for the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:HITType? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:HITType? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:HITType value command.
SCPI Syntax 
- VISual:AREA<x>:HITType {IN|OUT|DONTcare}
- VISual:AREA<x>:HITType?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • IN specifies that the waveform must intrude anywhere into the specified area to be true.
  • OUT specifies that the waveform must not intrude anywhere into the specified area to be true.
  • DONTcare sets the area to a don’t care state, causing the area to be ignored. This is useful when you are developing a Visual Trigger condition and need to change the hit logic type of an area while keeping the area.

VisualAreaItemReset

Bases: SCPICmdWriteNoArguments

The VISual:AREA<x>:RESET command.

Description
  • Sets the specified Visual Trigger area shape to a default-sized triangle.
Usage
  • Using the .write() method will send the VISual:AREA<x>:RESET command.
SCPI Syntax 
- VISual:AREA<x>:RESET
Info
  • Area<x> specifies the integer number of a Visual Trigger area.

VisualAreaItemRotation

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:ROTAtion command.

Description
  • Sets or queries the rotation angle of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:ROTAtion? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:ROTAtion? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:ROTAtion value command.
SCPI Syntax 
- VISual:AREA<x>:ROTAtion <NR3>
- VISual:AREA<x>:ROTAtion?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the rotation angle of the Visual Trigger area, in positive degrees from 0 to 360. Zero degrees is referenced from when the area was created.

VisualAreaItemShape

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:SHAPE command.

Description
  • Sets or queries the current shape of the area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:SHAPE? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SHAPE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SHAPE value command.
SCPI Syntax 
- VISual:AREA<x>:SHAPE {TRIAngle|RECTangle|TRAPezoid|HEXAgon}
- VISual:AREA<x>:SHAPE?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • TRIAngle sets the specified area to a triangular shape (three vertices). If the area does not exist, the instrument creates a new triangular area with the specified area number.
  • RECTangle sets the specified area to a rectangular shape (four vertices, right angles at each corner). If the area does not exist, the instrument creates a new triangular area with the specified area number.
  • TRAPezoid sets the specified area to a trapezoidal shape (four vertices, two parallel sides). If the area does not exist, the instrument creates a new triangular area with the specified area number.
  • HEXAgon sets the specified area to a hexagonal shape (six vertices). If the area does not exist, the instrument creates a new hexagonal area with the specified area number.

VisualAreaItemSource

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:SOUrce command.

Description
  • Sets or queries the signal source for the specified Visual Trigger area. The source can only be an analog channel.
Usage
  • Using the .query() method will send the VISual:AREA<x>:SOUrce? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:SOUrce? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:SOUrce value command.
SCPI Syntax 
- VISual:AREA<x>:SOUrce {CH<x>}
- VISual:AREA<x>:SOUrce?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • CH1 through CH8 sets the source channel number for the specified area.

VisualAreaItemVertices

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:VERTICES command.

Description
  • Sets or queries the X and Y vertex coordinate values for all vertices of the specified Visual Trigger area. Vertex values must be set in pairs.
Usage
  • Using the .query() method will send the VISual:AREA<x>:VERTICES? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:VERTICES? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:VERTICES value command.
SCPI Syntax 
- VISual:AREA<x>:VERTICES '<NR3>, <NR3>, <NR3>, <NR3>, <NR3>, <NR3> [,<NR3>, <NR3>, ...]'
- VISual:AREA<x>:VERTICES?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3>, <NR3> specifies the X, Y coordinate pair of each vertex in an area. The first value is X (time) and the second value is Y (amplitude). There must be a minimum of three vertex pairs to create an area. If the specified area exists, the area is changed to the shape specified in the arguments. If the specified area does not exist, a new area is created and assigned the specified vertices.

VisualAreaItemWidth

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:WIDTH command.

Description
  • Sets or queries the width of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:WIDTH? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:WIDTH? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:WIDTH value command.
SCPI Syntax 
- VISual:AREA<x>:WIDTH <NR3>
- VISual:AREA<x>:WIDTH?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the width of the Visual Trigger area in seconds.

VisualAreaItemXposition

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:XPOSition command.

Description
  • Sets or queries the horizontal (X-axis) center position of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:XPOSition? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:XPOSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:XPOSition value command.
SCPI Syntax 
- VISual:AREA<x>:XPOSition <NR3>
- VISual:AREA<x>:XPOSition?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the horizontal position of the center of the Visual Trigger area, in seconds.

VisualAreaItemYposition

Bases: SCPICmdWrite, SCPICmdRead

The VISual:AREA<x>:YPOSition command.

Description
  • Sets or queries the vertical (Y-axis) center position of the specified Visual Trigger area.
Usage
  • Using the .query() method will send the VISual:AREA<x>:YPOSition? query.
  • Using the .verify(value) method will send the VISual:AREA<x>:YPOSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:AREA<x>:YPOSition value command.
SCPI Syntax 
- VISual:AREA<x>:YPOSition <NR3>
- VISual:AREA<x>:YPOSition?
Info
  • Area<x> specifies the integer number of a Visual Trigger area.
  • <NR3> specifies the vertical position of the center of the Visual Trigger area, in amplitude (volts, amps).

VisualDeleteall

Bases: SCPICmdWriteNoArguments

The VISual:DELETEALL command.

Description
  • Deletes all Visual Trigger areas.
Usage
  • Using the .write() method will send the VISual:DELETEALL command.
SCPI Syntax 
- VISual:DELETEALL

VisualEnable

Bases: SCPICmdWrite, SCPICmdRead

The VISual:ENAble command.

Description
  • Sets or queries the status (on or off) of the Visual Trigger mode.
Usage
  • Using the .query() method will send the VISual:ENAble? query.
  • Using the .verify(value) method will send the VISual:ENAble? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:ENAble value command.
SCPI Syntax 
- VISual:ENAble {ON|OFF|<NR1>}
- VISual:ENAble?
Info
  • ON enables the Visual Trigger mode.
  • OFF disables the Visual Trigger mode.
  • <NR1> is an integer number. 0 turns off the Visual Trigger mode; any other value enables Visual Trigger mode.

VisualEquation

Bases: SCPICmdWrite, SCPICmdRead

The VISual:EQUation command.

Description
  • Sets or queries the Visual Trigger area combination logic equation.
Usage
  • Using the .query() method will send the VISual:EQUation? query.
  • Using the .verify(value) method will send the VISual:EQUation? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:EQUation value command.
SCPI Syntax 
- VISual:EQUation <Qstring>
- VISual:EQUation?
Info
  • <Qstring> defines the Visual Trigger area combination logic equation. The equation is made up of area names (A) combined with logic operators AND, OR, or XOR (&, |, ^). It may also contain parentheses for grouping. The equation must be true to have a valid Visual Trigger event and display a waveform. Each area’s true state depends on the area’s condition setting (In, Out or Don’t Care).

VisualShowareas

Bases: SCPICmdWrite, SCPICmdRead

The VISual:SHOWAReas command.

Description
  • Shows or hides all Visual Trigger areas.
Usage
  • Using the .query() method will send the VISual:SHOWAReas? query.
  • Using the .verify(value) method will send the VISual:SHOWAReas? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:SHOWAReas value command.
SCPI Syntax 
- VISual:SHOWAReas {ON|OFF|<NR1>}
- VISual:SHOWAReas?
Info
  • ON shows all Visual Trigger areas.
  • OFF hides all Visual Trigger areas.
  • <NR1> is an integer number. 0 hides all Visual Trigger areas; any other value shows all Visual Trigger areas.

VisualShowcriteria

Bases: SCPICmdWrite, SCPICmdRead

The VISual:SHOWCRiteria command.

Description
  • Sets or queries display of the area names and hit criteria for all visual trigger areas.
Usage
  • Using the .query() method will send the VISual:SHOWCRiteria? query.
  • Using the .verify(value) method will send the VISual:SHOWCRiteria? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:SHOWCRiteria value command.
SCPI Syntax 
- VISual:SHOWCRiteria {ON|OFF|<NR1>}
- VISual:SHOWCRiteria?
Info
  • ON enables display of the area name and hit criteria labels (In, Out, Don’t care icons) of all Visual Trigger areas.
  • OFF hides the area name and hit criteria labels (In, Out, Don’t care icons) of all Visual Trigger areas.
  • <NR1> is an integer number. 0 hides the area name and hit criteria of all Visual Trigger areas; any other value enables displaying the area name and hit criteria of all Visual Trigger areas.

VisualShowequation

Bases: SCPICmdWrite, SCPICmdRead

The VISual:SHOWEQuation command.

Description
  • Shows or hides the Visual Trigger area combination logic equation.
Usage
  • Using the .query() method will send the VISual:SHOWEQuation? query.
  • Using the .verify(value) method will send the VISual:SHOWEQuation? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the VISual:SHOWEQuation value command.
SCPI Syntax 
- VISual:SHOWEQuation {ON|OFF|<NR1>}
- VISual:SHOWEQuation?
Info
  • ON shows the Visual Trigger area combination logic equation.
  • OFF hides the Visual Trigger area combination logic equation.
  • <NR1> is an integer number. 0 hides the area combination logic equation; any other value displays the area combination logic equation.