[python source code]

zoom

The zoom 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 
- ZOOm:MODe {ON|OFF|<NR1>}
- ZOOm:STATE {ON|OFF|<NR1>}
- ZOOm:ZOOM1:FACtor?
- ZOOm:ZOOM1:HORizontal:POSition <NR3>
- ZOOm:ZOOM1:HORizontal:POSition?
- ZOOm:ZOOM1:HORizontal:SCAle <NR3>
- ZOOm:ZOOM1:HORizontal:SCAle?
- ZOOm:ZOOM1:POSition <NR3>
- ZOOm:ZOOM1:POSition?
- ZOOm:ZOOM1:SCAle <NR3>
- ZOOm:ZOOM1:SCAle?
- ZOOm:ZOOM1:STATE {ON|OFF|<NR1>}
- ZOOm:ZOOM1:STATE?
- ZOOm:ZOOM1:TRIGPOS?
- ZOOm:ZOOM1?
- ZOOm?

Zoom

Bases: SCPICmdRead

The ZOOm command.

Description
  • Returns the current vertical and horizontal positioning and scaling of the display.
Usage
  • Using the .query() method will send the ZOOm? query.
  • Using the .verify(value) method will send the ZOOm? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ZOOm?
Properties
  • .zoom1: The ZOOm:ZOOM1 command.
  • .mode: The ZOOm:MODe command.
  • .state: The ZOOm:STATE command.

mode property 

mode: ZoomMode

Return the ZOOm:MODe command.

Description
  • Turns Zoom mode on or off. The Zoom query returns the current state of Zoom mode. This command is equivalent to pressing the zoom button located on the front panel.
Usage
  • Using the .write(value) method will send the ZOOm:MODe value command.
SCPI Syntax 
- ZOOm:MODe {ON|OFF|<NR1>}
Info
  • ON turns on Zoom mode.
  • OFF turns off Zoom mode.
  • <NR1> is an integer. 0 turns off Zoom mode; any other value turns on Zoom mode.

state property 

state: ZoomState

Return the ZOOm:STATE command.

Description
  • Turns Zoom mode on or off. The Zoom query returns the current state of Zoom mode. This command is equivalent to pressing the zoom button located on the front panel.
Usage
  • Using the .write(value) method will send the ZOOm:STATE value command.
SCPI Syntax 
- ZOOm:STATE {ON|OFF|<NR1>}
Info
  • ON turns on Zoom mode.
  • OFF turns off Zoom mode.
  • <NR1> is an integer. 0 turns off Zoom mode; any other value turns on Zoom mode.

zoom1 property 

zoom1: ZoomZoom1

Return the ZOOm:ZOOM1 command.

Description
  • Returns the current vertical and horizontal positioning and scaling of the display. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ZOOm:ZOOM1?
Sub-properties
  • .factor: The ZOOm:ZOOM1:FACtor command.
  • .horizontal: The ZOOm:ZOOM1:HORizontal command tree.
  • .position: The ZOOm:ZOOM1:POSition command.
  • .scale: The ZOOm:ZOOM1:SCAle command.
  • .state: The ZOOm:ZOOM1:STATE command.
  • .trigpos: The ZOOm:ZOOM1:TRIGPOS command.

ZoomMode

Bases: SCPICmdWrite

The ZOOm:MODe command.

Description
  • Turns Zoom mode on or off. The Zoom query returns the current state of Zoom mode. This command is equivalent to pressing the zoom button located on the front panel.
Usage
  • Using the .write(value) method will send the ZOOm:MODe value command.
SCPI Syntax 
- ZOOm:MODe {ON|OFF|<NR1>}
Info
  • ON turns on Zoom mode.
  • OFF turns off Zoom mode.
  • <NR1> is an integer. 0 turns off Zoom mode; any other value turns on Zoom mode.

ZoomState

Bases: SCPICmdWrite

The ZOOm:STATE command.

Description
  • Turns Zoom mode on or off. The Zoom query returns the current state of Zoom mode. This command is equivalent to pressing the zoom button located on the front panel.
Usage
  • Using the .write(value) method will send the ZOOm:STATE value command.
SCPI Syntax 
- ZOOm:STATE {ON|OFF|<NR1>}
Info
  • ON turns on Zoom mode.
  • OFF turns off Zoom mode.
  • <NR1> is an integer. 0 turns off Zoom mode; any other value turns on Zoom mode.

ZoomZoom1

Bases: SCPICmdRead

The ZOOm:ZOOM1 command.

Description
  • Returns the current vertical and horizontal positioning and scaling of the display. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ZOOm:ZOOM1?
Properties
  • .factor: The ZOOm:ZOOM1:FACtor command.
  • .horizontal: The ZOOm:ZOOM1:HORizontal command tree.
  • .position: The ZOOm:ZOOM1:POSition command.
  • .scale: The ZOOm:ZOOM1:SCAle command.
  • .state: The ZOOm:ZOOM1:STATE command.
  • .trigpos: The ZOOm:ZOOM1:TRIGPOS command.

factor property 

factor: ZoomZoom1Factor

Return the ZOOm:ZOOM1:FACtor command.

Description
  • Returns the zoom factor of a particular zoom box. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:FACtor? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:FACtor? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ZOOm:ZOOM1:FACtor?

horizontal property 

horizontal: ZoomZoom1Horizontal

Return the ZOOm:ZOOM1:HORizontal command tree.

Usage
  • Using the .query() method will send the ZOOm:ZOOM1:HORizontal? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:HORizontal? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .position: The ZOOm:ZOOM1:HORizontal:POSition command.
  • .scale: The ZOOm:ZOOM1:HORizontal:SCAle command.

position property 

position: ZoomZoom1Position

Return the ZOOm:ZOOM1:POSition command.

Description
  • Sets the horizontal position of the zoom box, in terms of 0 to 100.0% of upper window. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:POSition? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:POSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:POSition value command.
SCPI Syntax 
- ZOOm:ZOOM1:POSition <NR3>
- ZOOm:ZOOM1:POSition?
Info
  • <NR3> is a floating point number that specifies the horizontal position as a percent of the upper window.

scale property 

scale: ZoomZoom1Scale

Return the ZOOm:ZOOM1:SCAle command.

Description
  • This command specifies the horizontal scale of the zoom box. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:SCAle? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:SCAle? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:SCAle value command.
SCPI Syntax 
- ZOOm:ZOOM1:SCAle <NR3>
- ZOOm:ZOOM1:SCAle?
Info
  • <NR3> is a floating point number that specifies the horizontal scale of the zoom box.

state property 

state: ZoomZoom1State

Return the ZOOm:ZOOM1:STATE command.

Description
  • This command turns the specified zoom on or off. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:STATE? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:STATE value command.
SCPI Syntax 
- ZOOm:ZOOM1:STATE {ON|OFF|<NR1>}
- ZOOm:ZOOM1:STATE?
Info
  • ON turns Zoom 1 on.
  • OFF turns Zoom 1 off.
  • <NR1> is an integer. 0 disables the specified zoom; any other value enables the specified zoom.

trigpos property 

trigpos: ZoomZoom1Trigpos

Return the ZOOm:ZOOM1:TRIGPOS command.

Description
  • This query returns the time at the center of the zoom box relative to the trigger position of the currently selected time domain waveform.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:TRIGPOS? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:TRIGPOS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ZOOm:ZOOM1:TRIGPOS?

ZoomZoom1Factor

Bases: SCPICmdRead

The ZOOm:ZOOM1:FACtor command.

Description
  • Returns the zoom factor of a particular zoom box. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:FACtor? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:FACtor? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ZOOm:ZOOM1:FACtor?

ZoomZoom1Horizontal

Bases: SCPICmdRead

The ZOOm:ZOOM1:HORizontal command tree.

Usage
  • Using the .query() method will send the ZOOm:ZOOM1:HORizontal? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:HORizontal? query and raise an AssertionError if the returned value does not match value.
Properties
  • .position: The ZOOm:ZOOM1:HORizontal:POSition command.
  • .scale: The ZOOm:ZOOM1:HORizontal:SCAle command.

position property 

position: ZoomZoom1HorizontalPosition

Return the ZOOm:ZOOM1:HORizontal:POSition command.

Description
  • This command specifies the horizontal position for the specified zoom, where x is the integer 1 representing the single zoom window. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:HORizontal:POSition? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:HORizontal:POSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:HORizontal:POSition value command.
SCPI Syntax 
- ZOOm:ZOOM1:HORizontal:POSition <NR3>
- ZOOm:ZOOM1:HORizontal:POSition?
Info
  • <NR3> is a value from 0 to 100.00 and is the percent of the upper window that is to the left of screen center, when the zoom factor is 1× or greater.

scale property 

scale: ZoomZoom1HorizontalScale

Return the ZOOm:ZOOM1:HORizontal:SCAle command.

Description
  • This command specifies the zoom horizontal scale factor for the specified zoom, where x is the integer 1 representing the single zoom window. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:HORizontal:SCAle? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:HORizontal:SCAle? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:HORizontal:SCAle value command.
SCPI Syntax 
- ZOOm:ZOOM1:HORizontal:SCAle <NR3>
- ZOOm:ZOOM1:HORizontal:SCAle?
Info
  • <NR3> is the amount of expansion in the horizontal direction in 1-2 -5 increments.

ZoomZoom1HorizontalPosition

Bases: SCPICmdWrite, SCPICmdRead

The ZOOm:ZOOM1:HORizontal:POSition command.

Description
  • This command specifies the horizontal position for the specified zoom, where x is the integer 1 representing the single zoom window. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:HORizontal:POSition? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:HORizontal:POSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:HORizontal:POSition value command.
SCPI Syntax 
- ZOOm:ZOOM1:HORizontal:POSition <NR3>
- ZOOm:ZOOM1:HORizontal:POSition?
Info
  • <NR3> is a value from 0 to 100.00 and is the percent of the upper window that is to the left of screen center, when the zoom factor is 1× or greater.

ZoomZoom1HorizontalScale

Bases: SCPICmdWrite, SCPICmdRead

The ZOOm:ZOOM1:HORizontal:SCAle command.

Description
  • This command specifies the zoom horizontal scale factor for the specified zoom, where x is the integer 1 representing the single zoom window. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:HORizontal:SCAle? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:HORizontal:SCAle? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:HORizontal:SCAle value command.
SCPI Syntax 
- ZOOm:ZOOM1:HORizontal:SCAle <NR3>
- ZOOm:ZOOM1:HORizontal:SCAle?
Info
  • <NR3> is the amount of expansion in the horizontal direction in 1-2 -5 increments.

ZoomZoom1Position

Bases: SCPICmdWrite, SCPICmdRead

The ZOOm:ZOOM1:POSition command.

Description
  • Sets the horizontal position of the zoom box, in terms of 0 to 100.0% of upper window. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:POSition? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:POSition? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:POSition value command.
SCPI Syntax 
- ZOOm:ZOOM1:POSition <NR3>
- ZOOm:ZOOM1:POSition?
Info
  • <NR3> is a floating point number that specifies the horizontal position as a percent of the upper window.

ZoomZoom1Scale

Bases: SCPICmdWrite, SCPICmdRead

The ZOOm:ZOOM1:SCAle command.

Description
  • This command specifies the horizontal scale of the zoom box. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:SCAle? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:SCAle? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:SCAle value command.
SCPI Syntax 
- ZOOm:ZOOM1:SCAle <NR3>
- ZOOm:ZOOM1:SCAle?
Info
  • <NR3> is a floating point number that specifies the horizontal scale of the zoom box.

ZoomZoom1State

Bases: SCPICmdWrite, SCPICmdRead

The ZOOm:ZOOM1:STATE command.

Description
  • This command turns the specified zoom on or off. can only be 1.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:STATE? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ZOOm:ZOOM1:STATE value command.
SCPI Syntax 
- ZOOm:ZOOM1:STATE {ON|OFF|<NR1>}
- ZOOm:ZOOM1:STATE?
Info
  • ON turns Zoom 1 on.
  • OFF turns Zoom 1 off.
  • <NR1> is an integer. 0 disables the specified zoom; any other value enables the specified zoom.

ZoomZoom1Trigpos

Bases: SCPICmdRead

The ZOOm:ZOOM1:TRIGPOS command.

Description
  • This query returns the time at the center of the zoom box relative to the trigger position of the currently selected time domain waveform.
Usage
  • Using the .query() method will send the ZOOm:ZOOM1:TRIGPOS? query.
  • Using the .verify(value) method will send the ZOOm:ZOOM1:TRIGPOS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ZOOm:ZOOM1:TRIGPOS?